Docs: add section on builtin macros
[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.87"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2016
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 .cindex "header lines" "From:"
2631 .cindex "header lines" "Sender:"
2632 For a trusted user, there is never any check on the contents of the &'From:'&
2633 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2634 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2635
2636 Trusted users may also specify a host name, host address, interface address,
2637 protocol name, ident value, and authentication data when submitting a message
2638 locally. Thus, they are able to insert messages into Exim's queue locally that
2639 have the characteristics of messages received from a remote host. Untrusted
2640 users may in some circumstances use &%-f%&, but can never set the other values
2641 that are available to trusted users.
2642 .next
2643 .cindex "user" "admin definition of"
2644 .cindex "admin user" "definition of"
2645 The admin users are root, the Exim user, and any user that is a member of the
2646 Exim group or of any group listed in the &%admin_groups%& configuration option.
2647 The current group does not have to be one of these groups.
2648
2649 Admin users are permitted to list the queue, and to carry out certain
2650 operations on messages, for example, to force delivery failures. It is also
2651 necessary to be an admin user in order to see the full information provided by
2652 the Exim monitor, and full debugging output.
2653
2654 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2655 Exim to attempt delivery of messages on its queue is restricted to admin users.
2656 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2657 option false (that is, specifying &%no_prod_requires_admin%&).
2658
2659 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2660 is restricted to admin users unless &%queue_list_requires_admin%& is set
2661 false.
2662 .endlist
2663
2664
2665 &*Warning*&: If you configure your system so that admin users are able to
2666 edit Exim's configuration file, you are giving those users an easy way of
2667 getting root. There is further discussion of this issue at the start of chapter
2668 &<<CHAPconf>>&.
2669
2670
2671
2672
2673 .section "Command line options" "SECID39"
2674 Exim's command line options are described in alphabetical order below. If none
2675 of the options that specifies a specific action (such as starting the daemon or
2676 a queue runner, or testing an address, or receiving a message in a specific
2677 format, or listing the queue) are present, and there is at least one argument
2678 on the command line, &%-bm%& (accept a local message on the standard input,
2679 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2680 outputs a brief message about itself and exits.
2681
2682 . ////////////////////////////////////////////////////////////////////////////
2683 . Insert a stylized XML comment here, to identify the start of the command line
2684 . options. This is for the benefit of the Perl script that automatically
2685 . creates a man page for the options.
2686 . ////////////////////////////////////////////////////////////////////////////
2687
2688 .literal xml
2689 <!-- === Start of command line options === -->
2690 .literal off
2691
2692
2693 .vlist
2694 .vitem &%--%&
2695 .oindex "--"
2696 .cindex "options" "command line; terminating"
2697 This is a pseudo-option whose only purpose is to terminate the options and
2698 therefore to cause subsequent command line items to be treated as arguments
2699 rather than options, even if they begin with hyphens.
2700
2701 .vitem &%--help%&
2702 .oindex "&%--help%&"
2703 This option causes Exim to output a few sentences stating what it is.
2704 The same output is generated if the Exim binary is called with no options and
2705 no arguments.
2706
2707 .vitem &%--version%&
2708 .oindex "&%--version%&"
2709 This option is an alias for &%-bV%& and causes version information to be
2710 displayed.
2711
2712 .vitem &%-Ac%& &&&
2713        &%-Am%&
2714 .oindex "&%-Ac%&"
2715 .oindex "&%-Am%&"
2716 These options are used by Sendmail for selecting configuration files and are
2717 ignored by Exim.
2718
2719 .vitem &%-B%&<&'type'&>
2720 .oindex "&%-B%&"
2721 .cindex "8-bit characters"
2722 .cindex "Sendmail compatibility" "8-bit characters"
2723 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2724 clean; it ignores this option.
2725
2726 .vitem &%-bd%&
2727 .oindex "&%-bd%&"
2728 .cindex "daemon"
2729 .cindex "SMTP" "listener"
2730 .cindex "queue runner"
2731 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2732 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2733 that the daemon should also initiate periodic queue runs.
2734
2735 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2736 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2737 disconnect from the controlling terminal. When running this way, it can be
2738 stopped by pressing ctrl-C.
2739
2740 By default, Exim listens for incoming connections to the standard SMTP port on
2741 all the host's running interfaces. However, it is possible to listen on other
2742 ports, on multiple ports, and only on specific interfaces. Chapter
2743 &<<CHAPinterfaces>>& contains a description of the options that control this.
2744
2745 When a listening daemon
2746 .cindex "daemon" "process id (pid)"
2747 .cindex "pid (process id)" "of daemon"
2748 is started without the use of &%-oX%& (that is, without overriding the normal
2749 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2750 in Exim's spool directory. This location can be overridden by setting
2751 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2752 running as root.
2753
2754 When &%-oX%& is used on the command line to start a listening daemon, the
2755 process id is not written to the normal pid file path. However, &%-oP%& can be
2756 used to specify a path on the command line if a pid file is required.
2757
2758 The SIGHUP signal
2759 .cindex "SIGHUP"
2760 .cindex "daemon" "restarting"
2761 can be used to cause the daemon to re-execute itself. This should be done
2762 whenever Exim's configuration file, or any file that is incorporated into it by
2763 means of the &%.include%& facility, is changed, and also whenever a new version
2764 of Exim is installed. It is not necessary to do this when other files that are
2765 referenced from the configuration (for example, alias files) are changed,
2766 because these are reread each time they are used.
2767
2768 .vitem &%-bdf%&
2769 .oindex "&%-bdf%&"
2770 This option has the same effect as &%-bd%& except that it never disconnects
2771 from the controlling terminal, even when no debugging is specified.
2772
2773 .vitem &%-be%&
2774 .oindex "&%-be%&"
2775 .cindex "testing" "string expansion"
2776 .cindex "expansion" "testing"
2777 Run Exim in expansion testing mode. Exim discards its root privilege, to
2778 prevent ordinary users from using this mode to read otherwise inaccessible
2779 files. If no arguments are given, Exim runs interactively, prompting for lines
2780 of data. Otherwise, it processes each argument in turn.
2781
2782 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2783 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2784 used without command line arguments. If successful, it uses the &[readline()]&
2785 function, which provides extensive line-editing facilities, for reading the
2786 test data. A line history is supported.
2787
2788 Long expansion expressions can be split over several lines by using backslash
2789 continuations. As in Exim's run time configuration, white space at the start of
2790 continuation lines is ignored. Each argument or data line is passed through the
2791 string expansion mechanism, and the result is output. Variable values from the
2792 configuration file (for example, &$qualify_domain$&) are available, but no
2793 message-specific values (such as &$message_exim_id$&) are set, because no message
2794 is being processed (but see &%-bem%& and &%-Mset%&).
2795
2796 &*Note*&: If you use this mechanism to test lookups, and you change the data
2797 files or databases you are using, you must exit and restart Exim before trying
2798 the same lookup again. Otherwise, because each Exim process caches the results
2799 of lookups, you will just get the same result as before.
2800
2801 .vitem &%-bem%&&~<&'filename'&>
2802 .oindex "&%-bem%&"
2803 .cindex "testing" "string expansion"
2804 .cindex "expansion" "testing"
2805 This option operates like &%-be%& except that it must be followed by the name
2806 of a file. For example:
2807 .code
2808 exim -bem /tmp/testmessage
2809 .endd
2810 The file is read as a message (as if receiving a locally-submitted non-SMTP
2811 message) before any of the test expansions are done. Thus, message-specific
2812 variables such as &$message_size$& and &$header_from:$& are available. However,
2813 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2814 recipients are read from the headers in the normal way, and are shown in the
2815 &$recipients$& variable. Note that recipients cannot be given on the command
2816 line, because further arguments are taken as strings to expand (just like
2817 &%-be%&).
2818
2819 .vitem &%-bF%&&~<&'filename'&>
2820 .oindex "&%-bF%&"
2821 .cindex "system filter" "testing"
2822 .cindex "testing" "system filter"
2823 This option is the same as &%-bf%& except that it assumes that the filter being
2824 tested is a system filter. The additional commands that are available only in
2825 system filters are recognized.
2826
2827 .vitem &%-bf%&&~<&'filename'&>
2828 .oindex "&%-bf%&"
2829 .cindex "filter" "testing"
2830 .cindex "testing" "filter file"
2831 .cindex "forward file" "testing"
2832 .cindex "testing" "forward file"
2833 .cindex "Sieve filter" "testing"
2834 This option runs Exim in user filter testing mode; the file is the filter file
2835 to be tested, and a test message must be supplied on the standard input. If
2836 there are no message-dependent tests in the filter, an empty file can be
2837 supplied.
2838
2839 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2840 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2841 filter and a user filter in the same run. For example:
2842 .code
2843 exim -bF /system/filter -bf /user/filter </test/message
2844 .endd
2845 This is helpful when the system filter adds header lines or sets filter
2846 variables that are used by the user filter.
2847
2848 If the test filter file does not begin with one of the special lines
2849 .code
2850 # Exim filter
2851 # Sieve filter
2852 .endd
2853 it is taken to be a normal &_.forward_& file, and is tested for validity under
2854 that interpretation. See sections &<<SECTitenonfilred>>& to
2855 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2856 redirection lists.
2857
2858 The result of an Exim command that uses &%-bf%&, provided no errors are
2859 detected, is a list of the actions that Exim would try to take if presented
2860 with the message for real. More details of filter testing are given in the
2861 separate document entitled &'Exim's interfaces to mail filtering'&.
2862
2863 When testing a filter file,
2864 .cindex "&""From""& line"
2865 .cindex "envelope sender"
2866 .oindex "&%-f%&" "for filter testing"
2867 the envelope sender can be set by the &%-f%& option,
2868 or by a &"From&~"& line at the start of the test message. Various parameters
2869 that would normally be taken from the envelope recipient address of the message
2870 can be set by means of additional command line options (see the next four
2871 options).
2872
2873 .vitem &%-bfd%&&~<&'domain'&>
2874 .oindex "&%-bfd%&"
2875 .vindex "&$qualify_domain$&"
2876 This sets the domain of the recipient address when a filter file is being
2877 tested by means of the &%-bf%& option. The default is the value of
2878 &$qualify_domain$&.
2879
2880 .vitem &%-bfl%&&~<&'local&~part'&>
2881 .oindex "&%-bfl%&"
2882 This sets the local part of the recipient address when a filter file is being
2883 tested by means of the &%-bf%& option. The default is the username of the
2884 process that calls Exim. A local part should be specified with any prefix or
2885 suffix stripped, because that is how it appears to the filter when a message is
2886 actually being delivered.
2887
2888 .vitem &%-bfp%&&~<&'prefix'&>
2889 .oindex "&%-bfp%&"
2890 This sets the prefix of the local part of the recipient address when a filter
2891 file is being tested by means of the &%-bf%& option. The default is an empty
2892 prefix.
2893
2894 .vitem &%-bfs%&&~<&'suffix'&>
2895 .oindex "&%-bfs%&"
2896 This sets the suffix of the local part of the recipient address when a filter
2897 file is being tested by means of the &%-bf%& option. The default is an empty
2898 suffix.
2899
2900 .vitem &%-bh%&&~<&'IP&~address'&>
2901 .oindex "&%-bh%&"
2902 .cindex "testing" "incoming SMTP"
2903 .cindex "SMTP" "testing incoming"
2904 .cindex "testing" "relay control"
2905 .cindex "relaying" "testing configuration"
2906 .cindex "policy control" "testing"
2907 .cindex "debugging" "&%-bh%& option"
2908 This option runs a fake SMTP session as if from the given IP address, using the
2909 standard input and output. The IP address may include a port number at the end,
2910 after a full stop. For example:
2911 .code
2912 exim -bh 10.9.8.7.1234
2913 exim -bh fe80::a00:20ff:fe86:a061.5678
2914 .endd
2915 When an IPv6 address is given, it is converted into canonical form. In the case
2916 of the second example above, the value of &$sender_host_address$& after
2917 conversion to the canonical form is
2918 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2919
2920 Comments as to what is going on are written to the standard error file. These
2921 include lines beginning with &"LOG"& for anything that would have been logged.
2922 This facility is provided for testing configuration options for incoming
2923 messages, to make sure they implement the required policy. For example, you can
2924 test your relay controls using &%-bh%&.
2925
2926 &*Warning 1*&:
2927 .cindex "RFC 1413"
2928 You can test features of the configuration that rely on ident (RFC 1413)
2929 information by using the &%-oMt%& option. However, Exim cannot actually perform
2930 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2931 connection.
2932
2933 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2934 are also skipped when testing using &%-bh%&. If you want these callouts to
2935 occur, use &%-bhc%& instead.
2936
2937 Messages supplied during the testing session are discarded, and nothing is
2938 written to any of the real log files. There may be pauses when DNS (and other)
2939 lookups are taking place, and of course these may time out. The &%-oMi%& option
2940 can be used to specify a specific IP interface and port if this is important,
2941 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2942 session were authenticated.
2943
2944 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2945 output just states whether a given recipient address from a given host is
2946 acceptable or not. See section &<<SECTcheckaccess>>&.
2947
2948 Features such as authentication and encryption, where the client input is not
2949 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2950 specialized SMTP test program such as
2951 &url(http://jetmore.org/john/code/#swaks,swaks).
2952
2953 .vitem &%-bhc%&&~<&'IP&~address'&>
2954 .oindex "&%-bhc%&"
2955 This option operates in the same way as &%-bh%&, except that address
2956 verification callouts are performed if required. This includes consulting and
2957 updating the callout cache database.
2958
2959 .vitem &%-bi%&
2960 .oindex "&%-bi%&"
2961 .cindex "alias file" "building"
2962 .cindex "building alias file"
2963 .cindex "Sendmail compatibility" "&%-bi%& option"
2964 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2965 Exim does not have the concept of a single alias file, and so it cannot mimic
2966 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2967 tend to appear in various scripts such as NIS make files, so the option must be
2968 recognized.
2969
2970 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2971 configuration option is run, under the uid and gid of the caller of Exim. If
2972 the &%-oA%& option is used, its value is passed to the command as an argument.
2973 The command set by &%bi_command%& may not contain arguments. The command can
2974 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2975 if this is required. If the &%bi_command%& option is not set, calling Exim with
2976 &%-bi%& is a no-op.
2977
2978 . // Keep :help first, then the rest in alphabetical order
2979 .vitem &%-bI:help%&
2980 .oindex "&%-bI:help%&"
2981 .cindex "querying exim information"
2982 We shall provide various options starting &`-bI:`& for querying Exim for
2983 information.  The output of many of these will be intended for machine
2984 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2985 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2986 options shall cause Exim to exit after producing the requested output.
2987
2988 .vitem &%-bI:dscp%&
2989 .oindex "&%-bI:dscp%&"
2990 .cindex "DSCP" "values"
2991 This option causes Exim to emit an alphabetically sorted list of all
2992 recognised DSCP names.
2993
2994 .vitem &%-bI:sieve%&
2995 .oindex "&%-bI:sieve%&"
2996 .cindex "Sieve filter" "capabilities"
2997 This option causes Exim to emit an alphabetically sorted list of all supported
2998 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2999 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3000 &`SIEVE`& capability response line.  As the precise list may depend upon
3001 compile-time build options, which this option will adapt to, this is the only
3002 way to guarantee a correct response.
3003
3004 .vitem &%-bm%&
3005 .oindex "&%-bm%&"
3006 .cindex "local message reception"
3007 This option runs an Exim receiving process that accepts an incoming,
3008 locally-generated message on the standard input. The recipients are given as the
3009 command arguments (except when &%-t%& is also present &-- see below). Each
3010 argument can be a comma-separated list of RFC 2822 addresses. This is the
3011 default option for selecting the overall action of an Exim call; it is assumed
3012 if no other conflicting option is present.
3013
3014 If any addresses in the message are unqualified (have no domain), they are
3015 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3016 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3017 suppressing this for special cases.
3018
3019 Policy checks on the contents of local messages can be enforced by means of
3020 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3021
3022 .cindex "return code" "for &%-bm%&"
3023 The return code is zero if the message is successfully accepted. Otherwise, the
3024 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3025
3026 The format
3027 .cindex "message" "format"
3028 .cindex "format" "message"
3029 .cindex "&""From""& line"
3030 .cindex "UUCP" "&""From""& line"
3031 .cindex "Sendmail compatibility" "&""From""& line"
3032 of the message must be as defined in RFC 2822, except that, for
3033 compatibility with Sendmail and Smail, a line in one of the forms
3034 .code
3035 From sender Fri Jan  5 12:55 GMT 1997
3036 From sender Fri, 5 Jan 97 12:55:01
3037 .endd
3038 (with the weekday optional, and possibly with additional text after the date)
3039 is permitted to appear at the start of the message. There appears to be no
3040 authoritative specification of the format of this line. Exim recognizes it by
3041 matching against the regular expression defined by the &%uucp_from_pattern%&
3042 option, which can be changed if necessary.
3043
3044 .oindex "&%-f%&" "overriding &""From""& line"
3045 The specified sender is treated as if it were given as the argument to the
3046 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3047 preference to the address taken from the message. The caller of Exim must be a
3048 trusted user for the sender of a message to be set in this way.
3049
3050 .vitem &%-bmalware%&&~<&'filename'&>
3051 .oindex "&%-bmalware%&"
3052 .cindex "testing", "malware"
3053 .cindex "malware scan test"
3054 This debugging option causes Exim to scan the given file or directory
3055 (depending on the used scanner interface),
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%config%& is given as an argument, the config is
3114 output, as it was parsed, any include file resolved, any comment removed.
3115
3116 If &%config_file%& is given as an argument, the name of the run time
3117 configuration file is output. (&%configure_file%& works too, for
3118 backward compatibility.)
3119 If a list of configuration files was supplied, the value that is output here
3120 is the name of the file that was actually used.
3121
3122 .cindex "options" "hiding name of"
3123 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3124 name will not be output.
3125
3126 .cindex "daemon" "process id (pid)"
3127 .cindex "pid (process id)" "of daemon"
3128 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3129 directories where log files and daemon pid files are written are output,
3130 respectively. If these values are unset, log files are written in a
3131 sub-directory of the spool directory called &%log%&, and the pid file is
3132 written directly into the spool directory.
3133
3134 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3135 .code
3136 exim -bP +local_domains
3137 .endd
3138 it searches for a matching named list of any type (domain, host, address, or
3139 local part) and outputs what it finds.
3140
3141 .cindex "options" "router &-- extracting"
3142 .cindex "options" "transport &-- extracting"
3143 .cindex "options" "authenticator &-- extracting"
3144 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3145 followed by the name of an appropriate driver instance, the option settings for
3146 that driver are output. For example:
3147 .code
3148 exim -bP transport local_delivery
3149 .endd
3150 The generic driver options are output first, followed by the driver's private
3151 options. A list of the names of drivers of a particular type can be obtained by
3152 using one of the words &%router_list%&, &%transport_list%&, or
3153 &%authenticator_list%&, and a complete list of all drivers with their option
3154 settings can be obtained by using &%routers%&, &%transports%&, or
3155 &%authenticators%&.
3156
3157 .cindex "environment"
3158 If &%environment%& is given as an argument, the set of environment
3159 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3160 variables.
3161
3162 .cindex "options" "macro &-- extracting"
3163 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3164 are available, similarly to the drivers.  Because macros are sometimes used
3165 for storing passwords, this option is restricted.
3166 The output format is one item per line.
3167
3168 .vitem &%-bp%&
3169 .oindex "&%-bp%&"
3170 .cindex "queue" "listing messages on"
3171 .cindex "listing" "messages on the queue"
3172 This option requests a listing of the contents of the mail queue on the
3173 standard output. If the &%-bp%& option is followed by a list of message ids,
3174 just those messages are listed. By default, this option can be used only by an
3175 admin user. However, the &%queue_list_requires_admin%& option can be set false
3176 to allow any user to see the queue.
3177
3178 Each message on the queue is displayed as in the following example:
3179 .code
3180 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3181           red.king@looking-glass.fict.example
3182           <other addresses>
3183 .endd
3184 .cindex "message" "size in queue listing"
3185 .cindex "size" "of message"
3186 The first line contains the length of time the message has been on the queue
3187 (in this case 25 minutes), the size of the message (2.9K), the unique local
3188 identifier for the message, and the message sender, as contained in the
3189 envelope. For bounce messages, the sender address is empty, and appears as
3190 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3191 the default sender address, the user's login name is shown in parentheses
3192 before the sender address.
3193
3194 .cindex "frozen messages" "in queue listing"
3195 If the message is frozen (attempts to deliver it are suspended) then the text
3196 &"*** frozen ***"& is displayed at the end of this line.
3197
3198 The recipients of the message (taken from the envelope, not the headers) are
3199 displayed on subsequent lines. Those addresses to which the message has already
3200 been delivered are marked with the letter D. If an original address gets
3201 expanded into several addresses via an alias or forward file, the original is
3202 displayed with a D only when deliveries for all of its child addresses are
3203 complete.
3204
3205
3206 .vitem &%-bpa%&
3207 .oindex "&%-bpa%&"
3208 This option operates like &%-bp%&, but in addition it shows delivered addresses
3209 that were generated from the original top level address(es) in each message by
3210 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3211 of just &"D"&.
3212
3213
3214 .vitem &%-bpc%&
3215 .oindex "&%-bpc%&"
3216 .cindex "queue" "count of messages on"
3217 This option counts the number of messages on the queue, and writes the total
3218 to the standard output. It is restricted to admin users, unless
3219 &%queue_list_requires_admin%& is set false.
3220
3221
3222 .vitem &%-bpr%&
3223 .oindex "&%-bpr%&"
3224 This option operates like &%-bp%&, but the output is not sorted into
3225 chronological order of message arrival. This can speed it up when there are
3226 lots of messages on the queue, and is particularly useful if the output is
3227 going to be post-processed in a way that doesn't need the sorting.
3228
3229 .vitem &%-bpra%&
3230 .oindex "&%-bpra%&"
3231 This option is a combination of &%-bpr%& and &%-bpa%&.
3232
3233 .vitem &%-bpru%&
3234 .oindex "&%-bpru%&"
3235 This option is a combination of &%-bpr%& and &%-bpu%&.
3236
3237
3238 .vitem &%-bpu%&
3239 .oindex "&%-bpu%&"
3240 This option operates like &%-bp%& but shows only undelivered top-level
3241 addresses for each message displayed. Addresses generated by aliasing or
3242 forwarding are not shown, unless the message was deferred after processing by a
3243 router with the &%one_time%& option set.
3244
3245
3246 .vitem &%-brt%&
3247 .oindex "&%-brt%&"
3248 .cindex "testing" "retry configuration"
3249 .cindex "retry" "configuration testing"
3250 This option is for testing retry rules, and it must be followed by up to three
3251 arguments. It causes Exim to look for a retry rule that matches the values
3252 and to write it to the standard output. For example:
3253 .code
3254 exim -brt bach.comp.mus.example
3255 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3256 .endd
3257 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3258 argument, which is required, can be a complete address in the form
3259 &'local_part@domain'&, or it can be just a domain name. If the second argument
3260 contains a dot, it is interpreted as an optional second domain name; if no
3261 retry rule is found for the first argument, the second is tried. This ties in
3262 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3263 rule is found that matches the host, one that matches the mail domain is
3264 sought. Finally, an argument that is the name of a specific delivery error, as
3265 used in setting up retry rules, can be given. For example:
3266 .code
3267 exim -brt haydn.comp.mus.example quota_3d
3268 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3269 .endd
3270
3271 .vitem &%-brw%&
3272 .oindex "&%-brw%&"
3273 .cindex "testing" "rewriting"
3274 .cindex "rewriting" "testing"
3275 This option is for testing address rewriting rules, and it must be followed by
3276 a single argument, consisting of either a local part without a domain, or a
3277 complete address with a fully qualified domain. Exim outputs how this address
3278 would be rewritten for each possible place it might appear. See chapter
3279 &<<CHAPrewrite>>& for further details.
3280
3281 .vitem &%-bS%&
3282 .oindex "&%-bS%&"
3283 .cindex "SMTP" "batched incoming"
3284 .cindex "batched SMTP input"
3285 This option is used for batched SMTP input, which is an alternative interface
3286 for non-interactive local message submission. A number of messages can be
3287 submitted in a single run. However, despite its name, this is not really SMTP
3288 input. Exim reads each message's envelope from SMTP commands on the standard
3289 input, but generates no responses. If the caller is trusted, or
3290 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3291 believed; otherwise the sender is always the caller of Exim.
3292
3293 The message itself is read from the standard input, in SMTP format (leading
3294 dots doubled), terminated by a line containing just a single dot. An error is
3295 provoked if the terminating dot is missing. A further message may then follow.
3296
3297 As for other local message submissions, the contents of incoming batch SMTP
3298 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3299 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3300 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3301
3302 Some other SMTP commands are recognized in the input. HELO and EHLO act
3303 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3304 QUIT quits, ignoring the rest of the standard input.
3305
3306 .cindex "return code" "for &%-bS%&"
3307 If any error is encountered, reports are written to the standard output and
3308 error streams, and Exim gives up immediately. The return code is 0 if no error
3309 was detected; it is 1 if one or more messages were accepted before the error
3310 was detected; otherwise it is 2.
3311
3312 More details of input using batched SMTP are given in section
3313 &<<SECTincomingbatchedSMTP>>&.
3314
3315 .vitem &%-bs%&
3316 .oindex "&%-bs%&"
3317 .cindex "SMTP" "local input"
3318 .cindex "local SMTP input"
3319 This option causes Exim to accept one or more messages by reading SMTP commands
3320 on the standard input, and producing SMTP replies on the standard output. SMTP
3321 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3322 Some user agents use this interface as a way of passing locally-generated
3323 messages to the MTA.
3324
3325 In
3326 .cindex "sender" "source of"
3327 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3328 set, the senders of messages are taken from the SMTP MAIL commands.
3329 Otherwise the content of these commands is ignored and the sender is set up as
3330 the calling user. Unqualified addresses are automatically qualified using
3331 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3332 &%-bnq%& option is used.
3333
3334 .cindex "inetd"
3335 The
3336 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3337 using a listening daemon. Exim can distinguish the two cases by checking
3338 whether the standard input is a TCP/IP socket. When Exim is called from
3339 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3340 above concerning senders and qualification do not apply. In this situation,
3341 Exim behaves in exactly the same way as it does when receiving a message via
3342 the listening daemon.
3343
3344 .vitem &%-bt%&
3345 .oindex "&%-bt%&"
3346 .cindex "testing" "addresses"
3347 .cindex "address" "testing"
3348 This option runs Exim in address testing mode, in which each argument is taken
3349 as a recipient address to be tested for deliverability. The results are
3350 written to the standard output. If a test fails, and the caller is not an admin
3351 user, no details of the failure are output, because these might contain
3352 sensitive information such as usernames and passwords for database lookups.
3353
3354 If no arguments are given, Exim runs in an interactive manner, prompting with a
3355 right angle bracket for addresses to be tested.
3356
3357 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3358 &[readline()]& function, because it is running as &'root'& and there are
3359 security issues.
3360
3361 Each address is handled as if it were the recipient address of a message
3362 (compare the &%-bv%& option). It is passed to the routers and the result is
3363 written to the standard output. However, any router that has
3364 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3365 genuine routing tests if your first router passes everything to a scanner
3366 program.
3367
3368 .cindex "return code" "for &%-bt%&"
3369 The return code is 2 if any address failed outright; it is 1 if no address
3370 failed outright but at least one could not be resolved for some reason. Return
3371 code 0 is given only when all addresses succeed.
3372
3373 .cindex "duplicate addresses"
3374 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3375 addresses after routing is complete, so that only one delivery takes place.
3376 This does not happen when testing with &%-bt%&; the full results of routing are
3377 always shown.
3378
3379 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3380 routers in the configuration makes any tests on the sender address of a
3381 message,
3382 .oindex "&%-f%&" "for address testing"
3383 you can use the &%-f%& option to set an appropriate sender when running
3384 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3385 default qualifying domain. However, if you have set up (for example) routers
3386 whose behaviour depends on the contents of an incoming message, you cannot test
3387 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3388 doing such tests.
3389
3390 .vitem &%-bV%&
3391 .oindex "&%-bV%&"
3392 .cindex "version number of Exim"
3393 This option causes Exim to write the current version number, compilation
3394 number, and compilation date of the &'exim'& binary to the standard output.
3395 It also lists the DBM library that is being used, the optional modules (such as
3396 specific lookup types), the drivers that are included in the binary, and the
3397 name of the run time configuration file that is in use.
3398
3399 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3400 configuration file. However, this is a static check only. It cannot check
3401 values that are to be expanded. For example, although a misspelt ACL verb is
3402 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3403 alone to discover (for example) all the typos in the configuration; some
3404 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3405 dynamic testing facilities.
3406
3407 .vitem &%-bv%&
3408 .oindex "&%-bv%&"
3409 .cindex "verifying address" "using &%-bv%&"
3410 .cindex "address" "verification"
3411 This option runs Exim in address verification mode, in which each argument is
3412 taken as a recipient address to be verified by the routers. (This does
3413 not involve any verification callouts). During normal operation, verification
3414 happens mostly as a consequence processing a &%verify%& condition in an ACL
3415 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3416 including callouts, see the &%-bh%& and &%-bhc%& options.
3417
3418 If verification fails, and the caller is not an admin user, no details of the
3419 failure are output, because these might contain sensitive information such as
3420 usernames and passwords for database lookups.
3421
3422 If no arguments are given, Exim runs in an interactive manner, prompting with a
3423 right angle bracket for addresses to be verified.
3424
3425 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3426 &[readline()]& function, because it is running as &'exim'& and there are
3427 security issues.
3428
3429 Verification differs from address testing (the &%-bt%& option) in that routers
3430 that have &%no_verify%& set are skipped, and if the address is accepted by a
3431 router that has &%fail_verify%& set, verification fails. The address is
3432 verified as a recipient if &%-bv%& is used; to test verification for a sender
3433 address, &%-bvs%& should be used.
3434
3435 If the &%-v%& option is not set, the output consists of a single line for each
3436 address, stating whether it was verified or not, and giving a reason in the
3437 latter case. Without &%-v%&, generating more than one address by redirection
3438 causes verification to end successfully, without considering the generated
3439 addresses. However, if just one address is generated, processing continues,
3440 and the generated address must verify successfully for the overall verification
3441 to succeed.
3442
3443 When &%-v%& is set, more details are given of how the address has been handled,
3444 and in the case of address redirection, all the generated addresses are also
3445 considered. Verification may succeed for some and fail for others.
3446
3447 The
3448 .cindex "return code" "for &%-bv%&"
3449 return code is 2 if any address failed outright; it is 1 if no address
3450 failed outright but at least one could not be resolved for some reason. Return
3451 code 0 is given only when all addresses succeed.
3452
3453 If any of the routers in the configuration makes any tests on the sender
3454 address of a message, you should use the &%-f%& option to set an appropriate
3455 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3456 calling user at the default qualifying domain.
3457
3458 .vitem &%-bvs%&
3459 .oindex "&%-bvs%&"
3460 This option acts like &%-bv%&, but verifies the address as a sender rather
3461 than a recipient address. This affects any rewriting and qualification that
3462 might happen.
3463
3464 .vitem &%-bw%&
3465 .oindex "&%-bw%&"
3466 .cindex "daemon"
3467 .cindex "inetd"
3468 .cindex "inetd" "wait mode"
3469 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3470 similarly to the &%-bd%& option.  All port specifications on the command-line
3471 and in the configuration file are ignored.  Queue-running may not be specified.
3472
3473 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3474 listening for connections.  This permits the system to start up and have
3475 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3476 each port only when the first connection is received.
3477
3478 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3479 which the daemon will exit, which should cause inetd to listen once more.
3480
3481 .vitem &%-C%&&~<&'filelist'&>
3482 .oindex "&%-C%&"
3483 .cindex "configuration file" "alternate"
3484 .cindex "CONFIGURE_FILE"
3485 .cindex "alternate configuration file"
3486 This option causes Exim to find the run time configuration file from the given
3487 list instead of from the list specified by the CONFIGURE_FILE
3488 compile-time setting. Usually, the list will consist of just a single file
3489 name, but it can be a colon-separated list of names. In this case, the first
3490 file that exists is used. Failure to open an existing file stops Exim from
3491 proceeding any further along the list, and an error is generated.
3492
3493 When this option is used by a caller other than root, and the list is different
3494 from the compiled-in list, Exim gives up its root privilege immediately, and
3495 runs with the real and effective uid and gid set to those of the caller.
3496 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3497 file contains a list of full pathnames, one per line, for configuration files
3498 which are trusted. Root privilege is retained for any configuration file so
3499 listed, as long as the caller is the Exim user (or the user specified in the
3500 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3501 not writeable by inappropriate users or groups.
3502
3503 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3504 configuration using &%-C%& right through message reception and delivery,
3505 even if the caller is root. The reception works, but by that time, Exim is
3506 running as the Exim user, so when it re-executes to regain privilege for the
3507 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3508 test reception and delivery using two separate commands (one to put a message
3509 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3510
3511 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3512 prefix string with which any file named in a &%-C%& command line option
3513 must start. In addition, the file name must not contain the sequence &`/../`&.
3514 However, if the value of the &%-C%& option is identical to the value of
3515 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3516 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3517 unset, any file name can be used with &%-C%&.
3518
3519 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3520 to a directory to which only root has access. This prevents someone who has
3521 broken into the Exim account from running a privileged Exim with an arbitrary
3522 configuration file.
3523
3524 The &%-C%& facility is useful for ensuring that configuration files are
3525 syntactically correct, but cannot be used for test deliveries, unless the
3526 caller is privileged, or unless it is an exotic configuration that does not
3527 require privilege. No check is made on the owner or group of the files
3528 specified by this option.
3529
3530
3531 .vitem &%-D%&<&'macro'&>=<&'value'&>
3532 .oindex "&%-D%&"
3533 .cindex "macro" "setting on command line"
3534 This option can be used to override macro definitions in the configuration file
3535 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3536 unprivileged caller, it causes Exim to give up its root privilege.
3537 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3538 completely disabled, and its use causes an immediate error exit.
3539
3540 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3541 colon-separated list of macros which are considered safe and, if &%-D%& only
3542 supplies macros from this list, and the values are acceptable, then Exim will
3543 not give up root privilege if the caller is root, the Exim run-time user, or
3544 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3545 to be removed in the future.  Acceptable values for the macros satisfy the
3546 regexp: &`^[A-Za-z0-9_/.-]*$`&
3547
3548 The entire option (including equals sign if present) must all be within one
3549 command line item. &%-D%& can be used to set the value of a macro to the empty
3550 string, in which case the equals sign is optional. These two commands are
3551 synonymous:
3552 .code
3553 exim -DABC  ...
3554 exim -DABC= ...
3555 .endd
3556 To include spaces in a macro definition item, quotes must be used. If you use
3557 quotes, spaces are permitted around the macro name and the equals sign. For
3558 example:
3559 .code
3560 exim '-D ABC = something' ...
3561 .endd
3562 &%-D%& may be repeated up to 10 times on a command line.
3563 Only macro names up to 22 letters long can be set.
3564
3565
3566 .vitem &%-d%&<&'debug&~options'&>
3567 .oindex "&%-d%&"
3568 .cindex "debugging" "list of selectors"
3569 .cindex "debugging" "&%-d%& option"
3570 This option causes debugging information to be written to the standard
3571 error stream. It is restricted to admin users because debugging output may show
3572 database queries that contain password information. Also, the details of users'
3573 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3574 writes an error message to the standard error stream and exits with a non-zero
3575 return code.
3576
3577 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3578 standard debugging data is output. This can be reduced, or increased to include
3579 some more rarely needed information, by directly following &%-d%& with a string
3580 made up of names preceded by plus or minus characters. These add or remove sets
3581 of debugging data, respectively. For example, &%-d+filter%& adds filter
3582 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3583 no spaces are allowed in the debug setting. The available debugging categories
3584 are:
3585 .display
3586 &`acl            `& ACL interpretation
3587 &`auth           `& authenticators
3588 &`deliver        `& general delivery logic
3589 &`dns            `& DNS lookups (see also resolver)
3590 &`dnsbl          `& DNS black list (aka RBL) code
3591 &`exec           `& arguments for &[execv()]& calls
3592 &`expand         `& detailed debugging for string expansions
3593 &`filter         `& filter handling
3594 &`hints_lookup   `& hints data lookups
3595 &`host_lookup    `& all types of name-to-IP address handling
3596 &`ident          `& ident lookup
3597 &`interface      `& lists of local interfaces
3598 &`lists          `& matching things in lists
3599 &`load           `& system load checks
3600 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3601                     &<<CHAPlocalscan>>&)
3602 &`lookup         `& general lookup code and all lookups
3603 &`memory         `& memory handling
3604 &`pid            `& add pid to debug output lines
3605 &`process_info   `& setting info for the process log
3606 &`queue_run      `& queue runs
3607 &`receive        `& general message reception logic
3608 &`resolver       `& turn on the DNS resolver's debugging output
3609 &`retry          `& retry handling
3610 &`rewrite        `& address rewriting
3611 &`route          `& address routing
3612 &`timestamp      `& add timestamp to debug output lines
3613 &`tls            `& TLS logic
3614 &`transport      `& transports
3615 &`uid            `& changes of uid/gid and looking up uid/gid
3616 &`verify         `& address verification logic
3617 &`all            `& almost all of the above (see below), and also &%-v%&
3618 .endd
3619 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3620 for &`-all`&. The reason for this is that &`+all`& is something that people
3621 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3622 is included, an awful lot of output that is very rarely of interest is
3623 generated, so it now has to be explicitly requested. However, &`-all`& does
3624 turn everything off.
3625
3626 .cindex "resolver, debugging output"
3627 .cindex "DNS resolver, debugging output"
3628 The &`resolver`& option produces output only if the DNS resolver was compiled
3629 with DEBUG enabled. This is not the case in some operating systems. Also,
3630 unfortunately, debugging output from the DNS resolver is written to stdout
3631 rather than stderr.
3632
3633 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3634 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3635 However, the &`pid`& selector is forced when debugging is turned on for a
3636 daemon, which then passes it on to any re-executed Exims. Exim also
3637 automatically adds the pid to debug lines when several remote deliveries are
3638 run in parallel.
3639
3640 The &`timestamp`& selector causes the current time to be inserted at the start
3641 of all debug output lines. This can be useful when trying to track down delays
3642 in processing.
3643
3644 If the &%debug_print%& option is set in any driver, it produces output whenever
3645 any debugging is selected, or if &%-v%& is used.
3646
3647 .vitem &%-dd%&<&'debug&~options'&>
3648 .oindex "&%-dd%&"
3649 This option behaves exactly like &%-d%& except when used on a command that
3650 starts a daemon process. In that case, debugging is turned off for the
3651 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3652 behaviour of the daemon without creating as much output as full debugging does.
3653
3654 .vitem &%-dropcr%&
3655 .oindex "&%-dropcr%&"
3656 This is an obsolete option that is now a no-op. It used to affect the way Exim
3657 handled CR and LF characters in incoming messages. What happens now is
3658 described in section &<<SECTlineendings>>&.
3659
3660 .vitem &%-E%&
3661 .oindex "&%-E%&"
3662 .cindex "bounce message" "generating"
3663 This option specifies that an incoming message is a locally-generated delivery
3664 failure report. It is used internally by Exim when handling delivery failures
3665 and is not intended for external use. Its only effect is to stop Exim
3666 generating certain messages to the postmaster, as otherwise message cascades
3667 could occur in some situations. As part of the same option, a message id may
3668 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3669 new message contains the id, following &"R="&, as a cross-reference.
3670
3671 .vitem &%-e%&&'x'&
3672 .oindex "&%-e%&&'x'&"
3673 There are a number of Sendmail options starting with &%-oe%& which seem to be
3674 called by various programs without the leading &%o%& in the option. For
3675 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3676 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3677
3678 .vitem &%-F%&&~<&'string'&>
3679 .oindex "&%-F%&"
3680 .cindex "sender" "name"
3681 .cindex "name" "of sender"
3682 This option sets the sender's full name for use when a locally-generated
3683 message is being accepted. In the absence of this option, the user's &'gecos'&
3684 entry from the password data is used. As users are generally permitted to alter
3685 their &'gecos'& entries, no security considerations are involved. White space
3686 between &%-F%& and the <&'string'&> is optional.
3687
3688 .vitem &%-f%&&~<&'address'&>
3689 .oindex "&%-f%&"
3690 .cindex "sender" "address"
3691 .cindex "address" "sender"
3692 .cindex "trusted users"
3693 .cindex "envelope sender"
3694 .cindex "user" "trusted"
3695 This option sets the address of the envelope sender of a locally-generated
3696 message (also known as the return path). The option can normally be used only
3697 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3698 users to use it.
3699
3700 Processes running as root or the Exim user are always trusted. Other
3701 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3702 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3703 of a local message is set to the caller's login name at the default qualify
3704 domain.
3705
3706 There is one exception to the restriction on the use of &%-f%&: an empty sender
3707 can be specified by any user, trusted or not, to create a message that can
3708 never provoke a bounce. An empty sender can be specified either as an empty
3709 string, or as a pair of angle brackets with nothing between them, as in these
3710 examples of shell commands:
3711 .code
3712 exim -f '<>' user@domain
3713 exim -f "" user@domain
3714 .endd
3715 In addition, the use of &%-f%& is not restricted when testing a filter file
3716 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3717 &%-bv%& options.
3718
3719 Allowing untrusted users to change the sender address does not of itself make
3720 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3721 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3722 though this can be overridden by setting &%no_local_from_check%&.
3723
3724 White
3725 .cindex "&""From""& line"
3726 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3727 given as two arguments or one combined argument). The sender of a
3728 locally-generated message can also be set (when permitted) by an initial
3729 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3730 if &%-f%& is also present, it overrides &"From&~"&.
3731
3732 .vitem &%-G%&
3733 .oindex "&%-G%&"
3734 .cindex "submission fixups, suppressing (command-line)"
3735 This option is equivalent to an ACL applying:
3736 .code
3737 control = suppress_local_fixups
3738 .endd
3739 for every message received.  Note that Sendmail will complain about such
3740 bad formatting, where Exim silently just does not fix it up.  This may change
3741 in future.
3742
3743 As this affects audit information, the caller must be a trusted user to use
3744 this option.
3745
3746 .vitem &%-h%&&~<&'number'&>
3747 .oindex "&%-h%&"
3748 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3749 This option is accepted for compatibility with Sendmail, but has no effect. (In
3750 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3751 headers.)
3752
3753 .vitem &%-i%&
3754 .oindex "&%-i%&"
3755 .cindex "Solaris" "&'mail'& command"
3756 .cindex "dot" "in incoming non-SMTP message"
3757 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3758 line by itself should not terminate an incoming, non-SMTP message. I can find
3759 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3760 command in Solaris 2.4 uses it. See also &%-ti%&.
3761
3762 .vitem &%-L%&&~<&'tag'&>
3763 .oindex "&%-L%&"
3764 .cindex "syslog" "process name; set with flag"
3765 This option is equivalent to setting &%syslog_processname%& in the config
3766 file and setting &%log_file_path%& to &`syslog`&.
3767 Its use is restricted to administrators.  The configuration file has to be
3768 read and parsed, to determine access rights, before this is set and takes
3769 effect, so early configuration file errors will not honour this flag.
3770
3771 The tag should not be longer than 32 characters.
3772
3773 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3774 .oindex "&%-M%&"
3775 .cindex "forcing delivery"
3776 .cindex "delivery" "forcing attempt"
3777 .cindex "frozen messages" "forcing delivery"
3778 This option requests Exim to run a delivery attempt on each message in turn. If
3779 any of the messages are frozen, they are automatically thawed before the
3780 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3781 and &%hold_domains%& are ignored.
3782
3783 Retry
3784 .cindex "hints database" "overriding retry hints"
3785 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3786 the normal retry time has not yet been reached. This option requires the caller
3787 to be an admin user. However, there is an option called &%prod_requires_admin%&
3788 which can be set false to relax this restriction (and also the same requirement
3789 for the &%-q%&, &%-R%&, and &%-S%& options).
3790
3791 The deliveries happen synchronously, that is, the original Exim process does
3792 not terminate until all the delivery attempts have finished. No output is
3793 produced unless there is a serious error. If you want to see what is happening,
3794 use the &%-v%& option as well, or inspect Exim's main log.
3795
3796 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3797 .oindex "&%-Mar%&"
3798 .cindex "message" "adding recipients"
3799 .cindex "recipient" "adding"
3800 This option requests Exim to add the addresses to the list of recipients of the
3801 message (&"ar"& for &"add recipients"&). The first argument must be a message
3802 id, and the remaining ones must be email addresses. However, if the message is
3803 active (in the middle of a delivery attempt), it is not altered. This option
3804 can be used only by an admin user.
3805
3806 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3807         &~<&'message&~id'&>"
3808 .oindex "&%-MC%&"
3809 .cindex "SMTP" "passed connection"
3810 .cindex "SMTP" "multiple deliveries"
3811 .cindex "multiple SMTP deliveries"
3812 This option is not intended for use by external callers. It is used internally
3813 by Exim to invoke another instance of itself to deliver a waiting message using
3814 an existing SMTP connection, which is passed as the standard input. Details are
3815 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3816 must be root or the Exim user in order to use it.
3817
3818 .vitem &%-MCA%&
3819 .oindex "&%-MCA%&"
3820 This option is not intended for use by external callers. It is used internally
3821 by Exim in conjunction with the &%-MC%& option. It signifies that the
3822 connection to the remote host has been authenticated.
3823
3824 .vitem &%-MCD%&
3825 .oindex "&%-MCD%&"
3826 This option is not intended for use by external callers. It is used internally
3827 by Exim in conjunction with the &%-MC%& option. It signifies that the
3828 remote host supports the ESMTP &_DSN_& extension.
3829
3830 .new
3831 .vitem &%-MCG%&
3832 .oindex "&%-MCG%&"
3833 This option is not intended for use by external callers. It is used internally
3834 by Exim in conjunction with the &%-MC%& option. It signifies that an
3835 alternate queue is used, named by the following option.
3836 .wen
3837
3838 .vitem &%-MCP%&
3839 .oindex "&%-MCP%&"
3840 This option is not intended for use by external callers. It is used internally
3841 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3842 which Exim is connected supports pipelining.
3843
3844 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3845 .oindex "&%-MCQ%&"
3846 This option is not intended for use by external callers. It is used internally
3847 by Exim in conjunction with the &%-MC%& option when the original delivery was
3848 started by a queue runner. It passes on the process id of the queue runner,
3849 together with the file descriptor number of an open pipe. Closure of the pipe
3850 signals the final completion of the sequence of processes that are passing
3851 messages through the same SMTP connection.
3852
3853 .vitem &%-MCS%&
3854 .oindex "&%-MCS%&"
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3857 SMTP SIZE option should be used on messages delivered down the existing
3858 connection.
3859
3860 .vitem &%-MCT%&
3861 .oindex "&%-MCT%&"
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3864 host to which Exim is connected supports TLS encryption.
3865
3866 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3867 .oindex "&%-Mc%&"
3868 .cindex "hints database" "not overridden by &%-Mc%&"
3869 .cindex "delivery" "manually started &-- not forced"
3870 This option requests Exim to run a delivery attempt on each message in turn,
3871 but unlike the &%-M%& option, it does check for retry hints, and respects any
3872 that are found. This option is not very useful to external callers. It is
3873 provided mainly for internal use by Exim when it needs to re-invoke itself in
3874 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3875 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3876 respects retry times and other options such as &%hold_domains%& that are
3877 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3878 If you want to run a specific delivery as if in a queue run, you should use
3879 &%-q%& with a message id argument. A distinction between queue run deliveries
3880 and other deliveries is made in one or two places.
3881
3882 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3883 .oindex "&%-Mes%&"
3884 .cindex "message" "changing sender"
3885 .cindex "sender" "changing"
3886 This option requests Exim to change the sender address in the message to the
3887 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3888 &"edit sender"&). There must be exactly two arguments. The first argument must
3889 be a message id, and the second one an email address. However, if the message
3890 is active (in the middle of a delivery attempt), its status is not altered.
3891 This option can be used only by an admin user.
3892
3893 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3894 .oindex "&%-Mf%&"
3895 .cindex "freezing messages"
3896 .cindex "message" "manually freezing"
3897 This option requests Exim to mark each listed message as &"frozen"&. This
3898 prevents any delivery attempts taking place until the message is &"thawed"&,
3899 either manually or as a result of the &%auto_thaw%& configuration option.
3900 However, if any of the messages are active (in the middle of a delivery
3901 attempt), their status is not altered. This option can be used only by an admin
3902 user.
3903
3904 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3905 .oindex "&%-Mg%&"
3906 .cindex "giving up on messages"
3907 .cindex "message" "abandoning delivery attempts"
3908 .cindex "delivery" "abandoning further attempts"
3909 This option requests Exim to give up trying to deliver the listed messages,
3910 including any that are frozen. However, if any of the messages are active,
3911 their status is not altered. For non-bounce messages, a delivery error message
3912 is sent to the sender, containing the text &"cancelled by administrator"&.
3913 Bounce messages are just discarded. This option can be used only by an admin
3914 user.
3915
3916 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mmad%&"
3918 .cindex "delivery" "cancelling all"
3919 This option requests Exim to mark all the recipient addresses in the messages
3920 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3921 message is active (in the middle of a delivery attempt), its status is not
3922 altered. This option can be used only by an admin user.
3923
3924 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3925 .oindex "&%-Mmd%&"
3926 .cindex "delivery" "cancelling by address"
3927 .cindex "recipient" "removing"
3928 .cindex "removing recipients"
3929 This option requests Exim to mark the given addresses as already delivered
3930 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3931 the remaining ones must be email addresses. These are matched to recipient
3932 addresses in the message in a case-sensitive manner. If the message is active
3933 (in the middle of a delivery attempt), its status is not altered. This option
3934 can be used only by an admin user.
3935
3936 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3937 .oindex "&%-Mrm%&"
3938 .cindex "removing messages"
3939 .cindex "abandoning mail"
3940 .cindex "message" "manually discarding"
3941 This option requests Exim to remove the given messages from the queue. No
3942 bounce messages are sent; each message is simply forgotten. However, if any of
3943 the messages are active, their status is not altered. This option can be used
3944 only by an admin user or by the user who originally caused the message to be
3945 placed on the queue.
3946
3947 .vitem &%-Mset%&&~<&'message&~id'&>
3948 .oindex "&%-Mset%&
3949 .cindex "testing" "string expansion"
3950 .cindex "expansion" "testing"
3951 This option is useful only in conjunction with &%-be%& (that is, when testing
3952 string expansions). Exim loads the given message from its spool before doing
3953 the test expansions, thus setting message-specific variables such as
3954 &$message_size$& and the header variables. The &$recipients$& variable is made
3955 available. This feature is provided to make it easier to test expansions that
3956 make use of these variables. However, this option can be used only by an admin
3957 user. See also &%-bem%&.
3958
3959 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3960 .oindex "&%-Mt%&"
3961 .cindex "thawing messages"
3962 .cindex "unfreezing messages"
3963 .cindex "frozen messages" "thawing"
3964 .cindex "message" "thawing frozen"
3965 This option requests Exim to &"thaw"& any of the listed messages that are
3966 &"frozen"&, so that delivery attempts can resume. However, if any of the
3967 messages are active, their status is not altered. This option can be used only
3968 by an admin user.
3969
3970 .vitem &%-Mvb%&&~<&'message&~id'&>
3971 .oindex "&%-Mvb%&"
3972 .cindex "listing" "message body"
3973 .cindex "message" "listing body of"
3974 This option causes the contents of the message body (-D) spool file to be
3975 written to the standard output. This option can be used only by an admin user.
3976
3977 .vitem &%-Mvc%&&~<&'message&~id'&>
3978 .oindex "&%-Mvc%&"
3979 .cindex "message" "listing in RFC 2822 format"
3980 .cindex "listing" "message in RFC 2822 format"
3981 This option causes a copy of the complete message (header lines plus body) to
3982 be written to the standard output in RFC 2822 format. This option can be used
3983 only by an admin user.
3984
3985 .vitem &%-Mvh%&&~<&'message&~id'&>
3986 .oindex "&%-Mvh%&"
3987 .cindex "listing" "message headers"
3988 .cindex "header lines" "listing"
3989 .cindex "message" "listing header lines"
3990 This option causes the contents of the message headers (-H) spool file to be
3991 written to the standard output. This option can be used only by an admin user.
3992
3993 .vitem &%-Mvl%&&~<&'message&~id'&>
3994 .oindex "&%-Mvl%&"
3995 .cindex "listing" "message log"
3996 .cindex "message" "listing message log"
3997 This option causes the contents of the message log spool file to be written to
3998 the standard output. This option can be used only by an admin user.
3999
4000 .vitem &%-m%&
4001 .oindex "&%-m%&"
4002 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4003 treats it that way too.
4004
4005 .vitem &%-N%&
4006 .oindex "&%-N%&"
4007 .cindex "debugging" "&%-N%& option"
4008 .cindex "debugging" "suppressing delivery"
4009 This is a debugging option that inhibits delivery of a message at the transport
4010 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4011 it just doesn't actually transport the message, but instead behaves as if it
4012 had successfully done so. However, it does not make any updates to the retry
4013 database, and the log entries for deliveries are flagged with &"*>"& rather
4014 than &"=>"&.
4015
4016 Because &%-N%& discards any message to which it applies, only root or the Exim
4017 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4018 words, an ordinary user can use it only when supplying an incoming message to
4019 which it will apply. Although transportation never fails when &%-N%& is set, an
4020 address may be deferred because of a configuration problem on a transport, or a
4021 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4022 the message, and applies to any subsequent delivery attempts that may happen
4023 for that message.
4024
4025 .vitem &%-n%&
4026 .oindex "&%-n%&"
4027 This option is interpreted by Sendmail to mean &"no aliasing"&.
4028 For normal modes of operation, it is ignored by Exim.
4029 When combined with &%-bP%& it makes the output more terse (suppresses
4030 option names, environment values and config pretty printing).
4031
4032 .vitem &%-O%&&~<&'data'&>
4033 .oindex "&%-O%&"
4034 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4035 Exim.
4036
4037 .vitem &%-oA%&&~<&'file&~name'&>
4038 .oindex "&%-oA%&"
4039 .cindex "Sendmail compatibility" "&%-oA%& option"
4040 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4041 alternative alias file name. Exim handles &%-bi%& differently; see the
4042 description above.
4043
4044 .vitem &%-oB%&&~<&'n'&>
4045 .oindex "&%-oB%&"
4046 .cindex "SMTP" "passed connection"
4047 .cindex "SMTP" "multiple deliveries"
4048 .cindex "multiple SMTP deliveries"
4049 This is a debugging option which limits the maximum number of messages that can
4050 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4051 transport. If <&'n'&> is omitted, the limit is set to 1.
4052
4053 .vitem &%-odb%&
4054 .oindex "&%-odb%&"
4055 .cindex "background delivery"
4056 .cindex "delivery" "in the background"
4057 This option applies to all modes in which Exim accepts incoming messages,
4058 including the listening daemon. It requests &"background"& delivery of such
4059 messages, which means that the accepting process automatically starts a
4060 delivery process for each message received, but does not wait for the delivery
4061 processes to finish.
4062
4063 When all the messages have been received, the reception process exits,
4064 leaving the delivery processes to finish in their own time. The standard output
4065 and error streams are closed at the start of each delivery process.
4066 This is the default action if none of the &%-od%& options are present.
4067
4068 If one of the queueing options in the configuration file
4069 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4070 overrides it if &%queue_only_override%& is set true, which is the default
4071 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4072
4073 .vitem &%-odf%&
4074 .oindex "&%-odf%&"
4075 .cindex "foreground delivery"
4076 .cindex "delivery" "in the foreground"
4077 This option requests &"foreground"& (synchronous) delivery when Exim has
4078 accepted a locally-generated message. (For the daemon it is exactly the same as
4079 &%-odb%&.) A delivery process is automatically started to deliver the message,
4080 and Exim waits for it to complete before proceeding.
4081
4082 The original Exim reception process does not finish until the delivery
4083 process for the final message has ended. The standard error stream is left open
4084 during deliveries.
4085
4086 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4087 false and one of the queueing options in the configuration file is in effect.
4088
4089 If there is a temporary delivery error during foreground delivery, the
4090 message is left on the queue for later delivery, and the original reception
4091 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4092 restricted configuration that never queues messages.
4093
4094
4095 .vitem &%-odi%&
4096 .oindex "&%-odi%&"
4097 This option is synonymous with &%-odf%&. It is provided for compatibility with
4098 Sendmail.
4099
4100 .vitem &%-odq%&
4101 .oindex "&%-odq%&"
4102 .cindex "non-immediate delivery"
4103 .cindex "delivery" "suppressing immediate"
4104 .cindex "queueing incoming messages"
4105 This option applies to all modes in which Exim accepts incoming messages,
4106 including the listening daemon. It specifies that the accepting process should
4107 not automatically start a delivery process for each message received. Messages
4108 are placed on the queue, and remain there until a subsequent queue runner
4109 process encounters them. There are several configuration options (such as
4110 &%queue_only%&) that can be used to queue incoming messages under certain
4111 conditions. This option overrides all of them and also &%-odqs%&. It always
4112 forces queueing.
4113
4114 .vitem &%-odqs%&
4115 .oindex "&%-odqs%&"
4116 .cindex "SMTP" "delaying delivery"
4117 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4118 However, like &%-odb%& and &%-odi%&, this option has no effect if
4119 &%queue_only_override%& is false and one of the queueing options in the
4120 configuration file is in effect.
4121
4122 When &%-odqs%& does operate, a delivery process is started for each incoming
4123 message, in the background by default, but in the foreground if &%-odi%& is
4124 also present. The recipient addresses are routed, and local deliveries are done
4125 in the normal way. However, if any SMTP deliveries are required, they are not
4126 done at this time, so the message remains on the queue until a subsequent queue
4127 runner process encounters it. Because routing was done, Exim knows which
4128 messages are waiting for which hosts, and so a number of messages for the same
4129 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4130 configuration option has the same effect for specific domains. See also the
4131 &%-qq%& option.
4132
4133 .vitem &%-oee%&
4134 .oindex "&%-oee%&"
4135 .cindex "error" "reporting"
4136 If an error is detected while a non-SMTP message is being received (for
4137 example, a malformed address), the error is reported to the sender in a mail
4138 message.
4139
4140 .cindex "return code" "for &%-oee%&"
4141 Provided
4142 this error message is successfully sent, the Exim receiving process
4143 exits with a return code of zero. If not, the return code is 2 if the problem
4144 is that the original message has no recipients, or 1 for any other error.
4145 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4146
4147 .vitem &%-oem%&
4148 .oindex "&%-oem%&"
4149 .cindex "error" "reporting"
4150 .cindex "return code" "for &%-oem%&"
4151 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4152 return code, whether or not the error message was successfully sent.
4153 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4154
4155 .vitem &%-oep%&
4156 .oindex "&%-oep%&"
4157 .cindex "error" "reporting"
4158 If an error is detected while a non-SMTP message is being received, the
4159 error is reported by writing a message to the standard error file (stderr).
4160 .cindex "return code" "for &%-oep%&"
4161 The return code is 1 for all errors.
4162
4163 .vitem &%-oeq%&
4164 .oindex "&%-oeq%&"
4165 .cindex "error" "reporting"
4166 This option is supported for compatibility with Sendmail, but has the same
4167 effect as &%-oep%&.
4168
4169 .vitem &%-oew%&
4170 .oindex "&%-oew%&"
4171 .cindex "error" "reporting"
4172 This option is supported for compatibility with Sendmail, but has the same
4173 effect as &%-oem%&.
4174
4175 .vitem &%-oi%&
4176 .oindex "&%-oi%&"
4177 .cindex "dot" "in incoming non-SMTP message"
4178 This option, which has the same effect as &%-i%&, specifies that a dot on a
4179 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4180 single dot does terminate, though Exim does no special processing for other
4181 lines that start with a dot. This option is set by default if Exim is called as
4182 &'rmail'&. See also &%-ti%&.
4183
4184 .vitem &%-oitrue%&
4185 .oindex "&%-oitrue%&"
4186 This option is treated as synonymous with &%-oi%&.
4187
4188 .vitem &%-oMa%&&~<&'host&~address'&>
4189 .oindex "&%-oMa%&"
4190 .cindex "sender" "host address, specifying for local message"
4191 A number of options starting with &%-oM%& can be used to set values associated
4192 with remote hosts on locally-submitted messages (that is, messages not received
4193 over TCP/IP). These options can be used by any caller in conjunction with the
4194 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4195 other circumstances, they are ignored unless the caller is trusted.
4196
4197 The &%-oMa%& option sets the sender host address. This may include a port
4198 number at the end, after a full stop (period). For example:
4199 .code
4200 exim -bs -oMa 10.9.8.7.1234
4201 .endd
4202 An alternative syntax is to enclose the IP address in square brackets,
4203 followed by a colon and the port number:
4204 .code
4205 exim -bs -oMa [10.9.8.7]:1234
4206 .endd
4207 The IP address is placed in the &$sender_host_address$& variable, and the
4208 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4209 are present on the command line, the sender host IP address is taken from
4210 whichever one is last.
4211
4212 .vitem &%-oMaa%&&~<&'name'&>
4213 .oindex "&%-oMaa%&"
4214 .cindex "authentication" "name, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4216 option sets the value of &$sender_host_authenticated$& (the authenticator
4217 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4218 This option can be used with &%-bh%& and &%-bs%& to set up an
4219 authenticated SMTP session without actually using the SMTP AUTH command.
4220
4221 .vitem &%-oMai%&&~<&'string'&>
4222 .oindex "&%-oMai%&"
4223 .cindex "authentication" "id, specifying for local message"
4224 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4225 option sets the value of &$authenticated_id$& (the id that was authenticated).
4226 This overrides the default value (the caller's login id, except with &%-bh%&,
4227 where there is no default) for messages from local sources. See chapter
4228 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4229
4230 .vitem &%-oMas%&&~<&'address'&>
4231 .oindex "&%-oMas%&"
4232 .cindex "authentication" "sender, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4234 option sets the authenticated sender value in &$authenticated_sender$&. It
4235 overrides the sender address that is created from the caller's login id for
4236 messages from local sources, except when &%-bh%& is used, when there is no
4237 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4238 specified on a MAIL command overrides this value. See chapter
4239 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4240
4241 .vitem &%-oMi%&&~<&'interface&~address'&>
4242 .oindex "&%-oMi%&"
4243 .cindex "interface" "address, specifying for local message"
4244 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4245 option sets the IP interface address value. A port number may be included,
4246 using the same syntax as for &%-oMa%&. The interface address is placed in
4247 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4248
4249 .vitem &%-oMm%&&~<&'message&~reference'&>
4250 .oindex "&%-oMm%&"
4251 .cindex "message reference" "message reference, specifying for local message"
4252 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4253 option sets the message reference, e.g. message-id, and is logged during
4254 delivery. This is useful when some kind of audit trail is required to tie
4255 messages together. The format of the message reference is checked and will
4256 abort if the format is invalid. The option will only be accepted if exim is
4257 running in trusted mode, not as any regular user.
4258
4259 The best example of a message reference is when Exim sends a bounce message.
4260 The message reference is the message-id of the original message for which Exim
4261 is sending the bounce.
4262
4263 .vitem &%-oMr%&&~<&'protocol&~name'&>
4264 .oindex "&%-oMr%&"
4265 .cindex "protocol, specifying for local message"
4266 .vindex "&$received_protocol$&"
4267 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4268 option sets the received protocol value that is stored in
4269 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4270 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4271 SMTP protocol names (see the description of &$received_protocol$& in section
4272 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4273 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4274 be set by &%-oMr%&.
4275
4276 .vitem &%-oMs%&&~<&'host&~name'&>
4277 .oindex "&%-oMs%&"
4278 .cindex "sender" "host name, specifying for local message"
4279 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4280 option sets the sender host name in &$sender_host_name$&. When this option is
4281 present, Exim does not attempt to look up a host name from an IP address; it
4282 uses the name it is given.
4283
4284 .vitem &%-oMt%&&~<&'ident&~string'&>
4285 .oindex "&%-oMt%&"
4286 .cindex "sender" "ident string, specifying for local message"
4287 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4288 option sets the sender ident value in &$sender_ident$&. The default setting for
4289 local callers is the login id of the calling process, except when &%-bh%& is
4290 used, when there is no default.
4291
4292 .vitem &%-om%&
4293 .oindex "&%-om%&"
4294 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4295 In Sendmail, this option means &"me too"&, indicating that the sender of a
4296 message should receive a copy of the message if the sender appears in an alias
4297 expansion. Exim always does this, so the option does nothing.
4298
4299 .vitem &%-oo%&
4300 .oindex "&%-oo%&"
4301 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4302 This option is ignored. In Sendmail it specifies &"old style headers"&,
4303 whatever that means.
4304
4305 .vitem &%-oP%&&~<&'path'&>
4306 .oindex "&%-oP%&"
4307 .cindex "pid (process id)" "of daemon"
4308 .cindex "daemon" "process id (pid)"
4309 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4310 value. The option specifies the file to which the process id of the daemon is
4311 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4312 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4313 because in those cases, the normal pid file is not used.
4314
4315 .vitem &%-or%&&~<&'time'&>
4316 .oindex "&%-or%&"
4317 .cindex "timeout" "for non-SMTP input"
4318 This option sets a timeout value for incoming non-SMTP messages. If it is not
4319 set, Exim will wait forever for the standard input. The value can also be set
4320 by the &%receive_timeout%& option. The format used for specifying times is
4321 described in section &<<SECTtimeformat>>&.
4322
4323 .vitem &%-os%&&~<&'time'&>
4324 .oindex "&%-os%&"
4325 .cindex "timeout" "for SMTP input"
4326 .cindex "SMTP" "input timeout"
4327 This option sets a timeout value for incoming SMTP messages. The timeout
4328 applies to each SMTP command and block of data. The value can also be set by
4329 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4330 for specifying times is described in section &<<SECTtimeformat>>&.
4331
4332 .vitem &%-ov%&
4333 .oindex "&%-ov%&"
4334 This option has exactly the same effect as &%-v%&.
4335
4336 .vitem &%-oX%&&~<&'number&~or&~string'&>
4337 .oindex "&%-oX%&"
4338 .cindex "TCP/IP" "setting listening ports"
4339 .cindex "TCP/IP" "setting listening interfaces"
4340 .cindex "port" "receiving TCP/IP"
4341 This option is relevant only when the &%-bd%& (start listening daemon) option
4342 is also given. It controls which ports and interfaces the daemon uses. Details
4343 of the syntax, and how it interacts with configuration file options, are given
4344 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4345 file is written unless &%-oP%& is also present to specify a pid file name.
4346
4347 .vitem &%-pd%&
4348 .oindex "&%-pd%&"
4349 .cindex "Perl" "starting the interpreter"
4350 This option applies when an embedded Perl interpreter is linked with Exim (see
4351 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4352 option, forcing the starting of the interpreter to be delayed until it is
4353 needed.
4354
4355 .vitem &%-ps%&
4356 .oindex "&%-ps%&"
4357 .cindex "Perl" "starting the interpreter"
4358 This option applies when an embedded Perl interpreter is linked with Exim (see
4359 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4360 option, forcing the starting of the interpreter to occur as soon as Exim is
4361 started.
4362
4363 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4364 .oindex "&%-p%&"
4365 For compatibility with Sendmail, this option is equivalent to
4366 .display
4367 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4368 .endd
4369 It sets the incoming protocol and host name (for trusted callers). The
4370 host name and its colon can be omitted when only the protocol is to be set.
4371 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4372 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4373 or &`s`& using this option (but that does not seem a real limitation).
4374
4375 .vitem &%-q%&
4376 .oindex "&%-q%&"
4377 .cindex "queue runner" "starting manually"
4378 This option is normally restricted to admin users. However, there is a
4379 configuration option called &%prod_requires_admin%& which can be set false to
4380 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4381 and &%-S%& options).
4382
4383 .cindex "queue runner" "description of operation"
4384 .new
4385 If other commandline options do not specify an action,
4386 .wen
4387 the &%-q%& option starts one queue runner process. This scans the queue of
4388 waiting messages, and runs a delivery process for each one in turn. It waits
4389 for each delivery process to finish before starting the next one. A delivery
4390 process may not actually do any deliveries if the retry times for the addresses
4391 have not been reached. Use &%-qf%& (see below) if you want to override this.
4392
4393 If
4394 .cindex "SMTP" "passed connection"
4395 .cindex "SMTP" "multiple deliveries"
4396 .cindex "multiple SMTP deliveries"
4397 the delivery process spawns other processes to deliver other messages down
4398 passed SMTP connections, the queue runner waits for these to finish before
4399 proceeding.
4400
4401 When all the queued messages have been considered, the original queue runner
4402 process terminates. In other words, a single pass is made over the waiting
4403 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4404 this to be repeated periodically.
4405
4406 Exim processes the waiting messages in an unpredictable order. It isn't very
4407 random, but it is likely to be different each time, which is all that matters.
4408 If one particular message screws up a remote MTA, other messages to the same
4409 MTA have a chance of getting through if they get tried first.
4410
4411 It is possible to cause the messages to be processed in lexical message id
4412 order, which is essentially the order in which they arrived, by setting the
4413 &%queue_run_in_order%& option, but this is not recommended for normal use.
4414
4415 .vitem &%-q%&<&'qflags'&>
4416 The &%-q%& option may be followed by one or more flag letters that change its
4417 behaviour. They are all optional, but if more than one is present, they must
4418 appear in the correct order. Each flag is described in a separate item below.
4419
4420 .vitem &%-qq...%&
4421 .oindex "&%-qq%&"
4422 .cindex "queue" "double scanning"
4423 .cindex "queue" "routing"
4424 .cindex "routing" "whole queue before delivery"
4425 An option starting with &%-qq%& requests a two-stage queue run. In the first
4426 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4427 every domain. Addresses are routed, local deliveries happen, but no remote
4428 transports are run.
4429
4430 .cindex "hints database" "remembering routing"
4431 The hints database that remembers which messages are waiting for specific hosts
4432 is updated, as if delivery to those hosts had been deferred. After this is
4433 complete, a second, normal queue scan happens, with routing and delivery taking
4434 place as normal. Messages that are routed to the same host should mostly be
4435 delivered down a single SMTP
4436 .cindex "SMTP" "passed connection"
4437 .cindex "SMTP" "multiple deliveries"
4438 .cindex "multiple SMTP deliveries"
4439 connection because of the hints that were set up during the first queue scan.
4440 This option may be useful for hosts that are connected to the Internet
4441 intermittently.
4442
4443 .vitem &%-q[q]i...%&
4444 .oindex "&%-qi%&"
4445 .cindex "queue" "initial delivery"
4446 If the &'i'& flag is present, the queue runner runs delivery processes only for
4447 those messages that haven't previously been tried. (&'i'& stands for &"initial
4448 delivery"&.) This can be helpful if you are putting messages on the queue using
4449 &%-odq%& and want a queue runner just to process the new messages.
4450
4451 .vitem &%-q[q][i]f...%&
4452 .oindex "&%-qf%&"
4453 .cindex "queue" "forcing delivery"
4454 .cindex "delivery" "forcing in queue run"
4455 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4456 message, whereas without &'f'& only those non-frozen addresses that have passed
4457 their retry times are tried.
4458
4459 .vitem &%-q[q][i]ff...%&
4460 .oindex "&%-qff%&"
4461 .cindex "frozen messages" "forcing delivery"
4462 If &'ff'& is present, a delivery attempt is forced for every message, whether
4463 frozen or not.
4464
4465 .vitem &%-q[q][i][f[f]]l%&
4466 .oindex "&%-ql%&"
4467 .cindex "queue" "local deliveries only"
4468 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4469 be done. If a message requires any remote deliveries, it remains on the queue
4470 for later delivery.
4471
4472 .new
4473 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4474 .oindex "&%-qG%&"
4475 .cindex queue named
4476 .cindex "named queues"
4477 .cindex "queue" "delivering specific messages"
4478 If the &'G'& flag and a name is present, the queue runner operates on the
4479 queue with the given name rather than the default queue.
4480 The name should not contain a &'/'& character.
4481 For a periodic queue run (see below)
4482 append to the name a slash and a time value.
4483
4484 If other commandline options speicify an action, a &'-qG<name>'& option
4485 will specify a queue to operate on.
4486 For example:
4487 .code
4488 exim -bp -qGquarantine
4489 mailq -qGquarantime
4490 exim -qGoffpeak -Rf @special.domain.example
4491 .endd
4492 .wen
4493
4494 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4495 When scanning the queue, Exim can be made to skip over messages whose ids are
4496 lexically less than a given value by following the &%-q%& option with a
4497 starting message id. For example:
4498 .code
4499 exim -q 0t5C6f-0000c8-00
4500 .endd
4501 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4502 second message id is given, messages whose ids are lexically greater than it
4503 are also skipped. If the same id is given twice, for example,
4504 .code
4505 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4506 .endd
4507 just one delivery process is started, for that message. This differs from
4508 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4509 that it counts as a delivery from a queue run. Note that the selection
4510 mechanism does not affect the order in which the messages are scanned. There
4511 are also other ways of selecting specific sets of messages for delivery in a
4512 queue run &-- see &%-R%& and &%-S%&.
4513
4514 .vitem &%-q%&<&'qflags'&><&'time'&>
4515 .cindex "queue runner" "starting periodically"
4516 .cindex "periodic queue running"
4517 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4518 starting a queue runner process at intervals specified by the given time value
4519 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4520 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4521 single daemon process handles both functions. A common way of starting up a
4522 combined daemon at system boot time is to use a command such as
4523 .code
4524 /usr/exim/bin/exim -bd -q30m
4525 .endd
4526 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4527 process every 30 minutes.
4528
4529 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4530 pid file is written unless one is explicitly requested by the &%-oP%& option.
4531
4532 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4533 .oindex "&%-qR%&"
4534 This option is synonymous with &%-R%&. It is provided for Sendmail
4535 compatibility.
4536
4537 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4538 .oindex "&%-qS%&"
4539 This option is synonymous with &%-S%&.
4540
4541 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4542 .oindex "&%-R%&"
4543 .cindex "queue runner" "for specific recipients"
4544 .cindex "delivery" "to given domain"
4545 .cindex "domain" "delivery to"
4546 The <&'rsflags'&> may be empty, in which case the white space before the string
4547 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4548 which are the possible values for <&'rsflags'&>. White space is required if
4549 <&'rsflags'&> is not empty.
4550
4551 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4552 perform a single queue run, except that, when scanning the messages on the
4553 queue, Exim processes only those that have at least one undelivered recipient
4554 address containing the given string, which is checked in a case-independent
4555 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4556 regular expression; otherwise it is a literal string.
4557
4558 If you want to do periodic queue runs for messages with specific recipients,
4559 you can combine &%-R%& with &%-q%& and a time value. For example:
4560 .code
4561 exim -q25m -R @special.domain.example
4562 .endd
4563 This example does a queue run for messages with recipients in the given domain
4564 every 25 minutes. Any additional flags that are specified with &%-q%& are
4565 applied to each queue run.
4566
4567 Once a message is selected for delivery by this mechanism, all its addresses
4568 are processed. For the first selected message, Exim overrides any retry
4569 information and forces a delivery attempt for each undelivered address. This
4570 means that if delivery of any address in the first message is successful, any
4571 existing retry information is deleted, and so delivery attempts for that
4572 address in subsequently selected messages (which are processed without forcing)
4573 will run. However, if delivery of any address does not succeed, the retry
4574 information is updated, and in subsequently selected messages, the failing
4575 address will be skipped.
4576
4577 .cindex "frozen messages" "forcing delivery"
4578 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4579 all selected messages, not just the first; frozen messages are included when
4580 &'ff'& is present.
4581
4582 The &%-R%& option makes it straightforward to initiate delivery of all messages
4583 to a given domain after a host has been down for some time. When the SMTP
4584 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4585 effect is to run Exim with the &%-R%& option, but it can be configured to run
4586 an arbitrary command instead.
4587
4588 .vitem &%-r%&
4589 .oindex "&%-r%&"
4590 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4591
4592 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4593 .oindex "&%-S%&"
4594 .cindex "delivery" "from given sender"
4595 .cindex "queue runner" "for specific senders"
4596 This option acts like &%-R%& except that it checks the string against each
4597 message's sender instead of against the recipients. If &%-R%& is also set, both
4598 conditions must be met for a message to be selected. If either of the options
4599 has &'f'& or &'ff'& in its flags, the associated action is taken.
4600
4601 .vitem &%-Tqt%&&~<&'times'&>
4602 .oindex "&%-Tqt%&"
4603 This is an option that is exclusively for use by the Exim testing suite. It is not
4604 recognized when Exim is run normally. It allows for the setting up of explicit
4605 &"queue times"& so that various warning/retry features can be tested.
4606
4607 .vitem &%-t%&
4608 .oindex "&%-t%&"
4609 .cindex "recipient" "extracting from header lines"
4610 .cindex "&'Bcc:'& header line"
4611 .cindex "&'Cc:'& header line"
4612 .cindex "&'To:'& header line"
4613 When Exim is receiving a locally-generated, non-SMTP message on its standard
4614 input, the &%-t%& option causes the recipients of the message to be obtained
4615 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4616 from the command arguments. The addresses are extracted before any rewriting
4617 takes place and the &'Bcc:'& header line, if present, is then removed.
4618
4619 .cindex "Sendmail compatibility" "&%-t%& option"
4620 If the command has any arguments, they specify addresses to which the message
4621 is &'not'& to be delivered. That is, the argument addresses are removed from
4622 the recipients list obtained from the headers. This is compatible with Smail 3
4623 and in accordance with the documented behaviour of several versions of
4624 Sendmail, as described in man pages on a number of operating systems (e.g.
4625 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4626 argument addresses to those obtained from the headers, and the O'Reilly
4627 Sendmail book documents it that way. Exim can be made to add argument addresses
4628 instead of subtracting them by setting the option
4629 &%extract_addresses_remove_arguments%& false.
4630
4631 .cindex "&%Resent-%& header lines" "with &%-t%&"
4632 If there are any &%Resent-%& header lines in the message, Exim extracts
4633 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4634 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4635 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4636 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4637
4638 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4639 message is resent several times). The RFC also specifies that they should be
4640 added at the front of the message, and separated by &'Received:'& lines. It is
4641 not at all clear how &%-t%& should operate in the present of multiple sets,
4642 nor indeed exactly what constitutes a &"set"&.
4643 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4644 are often added at the end of the header, and if a message is resent more than
4645 once, it is common for the original set of &%Resent-%& headers to be renamed as
4646 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4647
4648 .vitem &%-ti%&
4649 .oindex "&%-ti%&"
4650 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4651 compatibility with Sendmail.
4652
4653 .vitem &%-tls-on-connect%&
4654 .oindex "&%-tls-on-connect%&"
4655 .cindex "TLS" "use without STARTTLS"
4656 .cindex "TLS" "automatic start"
4657 This option is available when Exim is compiled with TLS support. It forces all
4658 incoming SMTP connections to behave as if the incoming port is listed in the
4659 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4660 &<<CHAPTLS>>& for further details.
4661
4662
4663 .vitem &%-U%&
4664 .oindex "&%-U%&"
4665 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4666 Sendmail uses this option for &"initial message submission"&, and its
4667 documentation states that in future releases, it may complain about
4668 syntactically invalid messages rather than fixing them when this flag is not
4669 set. Exim ignores this option.
4670
4671 .vitem &%-v%&
4672 .oindex "&%-v%&"
4673 This option causes Exim to write information to the standard error stream,
4674 describing what it is doing. In particular, it shows the log lines for
4675 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4676 dialogue is shown. Some of the log lines shown may not actually be written to
4677 the log if the setting of &%log_selector%& discards them. Any relevant
4678 selectors are shown with each log line. If none are shown, the logging is
4679 unconditional.
4680
4681 .vitem &%-x%&
4682 .oindex "&%-x%&"
4683 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4684 National Language Support extended characters in the body of the mail item"&).
4685 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4686 this option.
4687
4688 .vitem &%-X%&&~<&'logfile'&>
4689 .oindex "&%-X%&"
4690 This option is interpreted by Sendmail to cause debug information to be sent
4691 to the named file.  It is ignored by Exim.
4692
4693 .vitem &%-z%&&~<&'log-line'&>
4694 .oindex "&%-z%&"
4695 This option writes its argument to Exim's logfile.
4696 Use is restricted to administrators; the intent is for operational notes.
4697 Quotes should be used to maintain a multi-word item as a single argument,
4698 under most shells.
4699 .endlist
4700
4701 .ecindex IIDclo1
4702 .ecindex IIDclo2
4703
4704
4705 . ////////////////////////////////////////////////////////////////////////////
4706 . Insert a stylized DocBook comment here, to identify the end of the command
4707 . line options. This is for the benefit of the Perl script that automatically
4708 . creates a man page for the options.
4709 . ////////////////////////////////////////////////////////////////////////////
4710
4711 .literal xml
4712 <!-- === End of command line options === -->
4713 .literal off
4714
4715
4716
4717
4718
4719 . ////////////////////////////////////////////////////////////////////////////
4720 . ////////////////////////////////////////////////////////////////////////////
4721
4722
4723 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4724          "The runtime configuration file"
4725
4726 .cindex "run time configuration"
4727 .cindex "configuration file" "general description"
4728 .cindex "CONFIGURE_FILE"
4729 .cindex "configuration file" "errors in"
4730 .cindex "error" "in configuration file"
4731 .cindex "return code" "for bad configuration"
4732 Exim uses a single run time configuration file that is read whenever an Exim
4733 binary is executed. Note that in normal operation, this happens frequently,
4734 because Exim is designed to operate in a distributed manner, without central
4735 control.
4736
4737 If a syntax error is detected while reading the configuration file, Exim
4738 writes a message on the standard error, and exits with a non-zero return code.
4739 The message is also written to the panic log. &*Note*&: Only simple syntax
4740 errors can be detected at this time. The values of any expanded options are
4741 not checked until the expansion happens, even when the expansion does not
4742 actually alter the string.
4743
4744 The name of the configuration file is compiled into the binary for security
4745 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4746 most configurations, this specifies a single file. However, it is permitted to
4747 give a colon-separated list of file names, in which case Exim uses the first
4748 existing file in the list.
4749
4750 .cindex "EXIM_USER"
4751 .cindex "EXIM_GROUP"
4752 .cindex "CONFIGURE_OWNER"
4753 .cindex "CONFIGURE_GROUP"
4754 .cindex "configuration file" "ownership"
4755 .cindex "ownership" "configuration file"
4756 The run time configuration file must be owned by root or by the user that is
4757 specified at compile time by the CONFIGURE_OWNER option (if set). The
4758 configuration file must not be world-writeable, or group-writeable unless its
4759 group is the root group or the one specified at compile time by the
4760 CONFIGURE_GROUP option.
4761
4762 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4763 to root, anybody who is able to edit the run time configuration file has an
4764 easy way to run commands as root. If you specify a user or group in the
4765 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4766 who are members of that group will trivially be able to obtain root privileges.
4767
4768 Up to Exim version 4.72, the run time configuration file was also permitted to
4769 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4770 since it offered a simple privilege escalation for any attacker who managed to
4771 compromise the Exim user account.
4772
4773 A default configuration file, which will work correctly in simple situations,
4774 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4775 defines just one file name, the installation process copies the default
4776 configuration to a new file of that name if it did not previously exist. If
4777 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4778 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4779 configuration.
4780
4781
4782
4783 .section "Using a different configuration file" "SECID40"
4784 .cindex "configuration file" "alternate"
4785 A one-off alternate configuration can be specified by the &%-C%& command line
4786 option, which may specify a single file or a list of files. However, when
4787 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4788 unless the argument for &%-C%& is identical to the built-in value from
4789 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4790 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4791 is useful mainly for checking the syntax of configuration files before
4792 installing them. No owner or group checks are done on a configuration file
4793 specified by &%-C%&, if root privilege has been dropped.
4794
4795 Even the Exim user is not trusted to specify an arbitrary configuration file
4796 with the &%-C%& option to be used with root privileges, unless that file is
4797 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4798 testing a configuration using &%-C%& right through message reception and
4799 delivery, even if the caller is root. The reception works, but by that time,
4800 Exim is running as the Exim user, so when it re-execs to regain privilege for
4801 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4802 can test reception and delivery using two separate commands (one to put a
4803 message on the queue, using &%-odq%&, and another to do the delivery, using
4804 &%-M%&).
4805
4806 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4807 prefix string with which any file named in a &%-C%& command line option must
4808 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4809 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4810 name can be used with &%-C%&.
4811
4812 One-off changes to a configuration can be specified by the &%-D%& command line
4813 option, which defines and overrides values for macros used inside the
4814 configuration file. However, like &%-C%&, the use of this option by a
4815 non-privileged user causes Exim to discard its root privilege.
4816 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4817 completely disabled, and its use causes an immediate error exit.
4818
4819 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4820 to declare certain macro names trusted, such that root privilege will not
4821 necessarily be discarded.
4822 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4823 considered safe and, if &%-D%& only supplies macros from this list, and the
4824 values are acceptable, then Exim will not give up root privilege if the caller
4825 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4826 transition mechanism and is expected to be removed in the future.  Acceptable
4827 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4828
4829 Some sites may wish to use the same Exim binary on different machines that
4830 share a file system, but to use different configuration files on each machine.
4831 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4832 looks for a file whose name is the configuration file name followed by a dot
4833 and the machine's node name, as obtained from the &[uname()]& function. If this
4834 file does not exist, the standard name is tried. This processing occurs for
4835 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4836
4837 In some esoteric situations different versions of Exim may be run under
4838 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4839 help with this. See the comments in &_src/EDITME_& for details.
4840
4841
4842
4843 .section "Configuration file format" "SECTconffilfor"
4844 .cindex "configuration file" "format of"
4845 .cindex "format" "configuration file"
4846 Exim's configuration file is divided into a number of different parts. General
4847 option settings must always appear at the start of the file. The other parts
4848 are all optional, and may appear in any order. Each part other than the first
4849 is introduced by the word &"begin"& followed by at least one literal
4850 space, and the name of the part. The optional parts are:
4851
4852 .ilist
4853 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4854 &<<CHAPACL>>&).
4855 .next
4856 .cindex "AUTH" "configuration"
4857 &'authenticators'&: Configuration settings for the authenticator drivers. These
4858 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4859 .next
4860 &'routers'&: Configuration settings for the router drivers. Routers process
4861 addresses and determine how the message is to be delivered (see chapters
4862 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4863 .next
4864 &'transports'&: Configuration settings for the transport drivers. Transports
4865 define mechanisms for copying messages to destinations (see chapters
4866 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4867 .next
4868 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4869 If there is no retry section, or if it is empty (that is, no retry rules are
4870 defined), Exim will not retry deliveries. In this situation, temporary errors
4871 are treated the same as permanent errors. Retry rules are discussed in chapter
4872 &<<CHAPretry>>&.
4873 .next
4874 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4875 when new addresses are generated during delivery. Rewriting is discussed in
4876 chapter &<<CHAPrewrite>>&.
4877 .next
4878 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4879 want to use this feature, you must set
4880 .code
4881 LOCAL_SCAN_HAS_OPTIONS=yes
4882 .endd
4883 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4884 facility are given in chapter &<<CHAPlocalscan>>&.
4885 .endlist
4886
4887 .cindex "configuration file" "leading white space in"
4888 .cindex "configuration file" "trailing white space in"
4889 .cindex "white space" "in configuration file"
4890 Leading and trailing white space in configuration lines is always ignored.
4891
4892 Blank lines in the file, and lines starting with a # character (ignoring
4893 leading white space) are treated as comments and are ignored. &*Note*&: A
4894 # character other than at the beginning of a line is not treated specially,
4895 and does not introduce a comment.
4896
4897 Any non-comment line can be continued by ending it with a backslash. Note that
4898 the general rule for white space means that trailing white space after the
4899 backslash and leading white space at the start of continuation
4900 lines is ignored. Comment lines beginning with # (but not empty lines) may
4901 appear in the middle of a sequence of continuation lines.
4902
4903 A convenient way to create a configuration file is to start from the
4904 default, which is supplied in &_src/configure.default_&, and add, delete, or
4905 change settings as required.
4906
4907 The ACLs, retry rules, and rewriting rules have their own syntax which is
4908 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4909 respectively. The other parts of the configuration file have some syntactic
4910 items in common, and these are described below, from section &<<SECTcos>>&
4911 onwards. Before that, the inclusion, macro, and conditional facilities are
4912 described.
4913
4914
4915
4916 .section "File inclusions in the configuration file" "SECID41"
4917 .cindex "inclusions in configuration file"
4918 .cindex "configuration file" "including other files"
4919 .cindex "&`.include`& in configuration file"
4920 .cindex "&`.include_if_exists`& in configuration file"
4921 You can include other files inside Exim's run time configuration file by
4922 using this syntax:
4923 .display
4924 &`.include`& <&'file name'&>
4925 &`.include_if_exists`& <&'file name'&>
4926 .endd
4927 on a line by itself. Double quotes round the file name are optional. If you use
4928 the first form, a configuration error occurs if the file does not exist; the
4929 second form does nothing for non-existent files. In all cases, an absolute file
4930 name is required.
4931
4932 Includes may be nested to any depth, but remember that Exim reads its
4933 configuration file often, so it is a good idea to keep them to a minimum.
4934 If you change the contents of an included file, you must HUP the daemon,
4935 because an included file is read only when the configuration itself is read.
4936
4937 The processing of inclusions happens early, at a physical line level, so, like
4938 comment lines, an inclusion can be used in the middle of an option setting,
4939 for example:
4940 .code
4941 hosts_lookup = a.b.c \
4942                .include /some/file
4943 .endd
4944 Include processing happens after macro processing (see below). Its effect is to
4945 process the lines of the included file as if they occurred inline where the
4946 inclusion appears.
4947
4948
4949
4950 .section "Macros in the configuration file" "SECTmacrodefs"
4951 .cindex "macro" "description of"
4952 .cindex "configuration file" "macros"
4953 If a line in the main part of the configuration (that is, before the first
4954 &"begin"& line) begins with an upper case letter, it is taken as a macro
4955 definition, and must be of the form
4956 .display
4957 <&'name'&> = <&'rest of line'&>
4958 .endd
4959 The name must consist of letters, digits, and underscores, and need not all be
4960 in upper case, though that is recommended. The rest of the line, including any
4961 continuations, is the replacement text, and has leading and trailing white
4962 space removed. Quotes are not removed. The replacement text can never end with
4963 a backslash character, but this doesn't seem to be a serious limitation.
4964
4965 Macros may also be defined between router, transport, authenticator, or ACL
4966 definitions. They may not, however, be defined within an individual driver or
4967 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4968
4969 .section "Macro substitution" "SECID42"
4970 Once a macro is defined, all subsequent lines in the file (and any included
4971 files) are scanned for the macro name; if there are several macros, the line is
4972 scanned for each in turn, in the order in which the macros are defined. The
4973 replacement text is not re-scanned for the current macro, though it is scanned
4974 for subsequently defined macros. For this reason, a macro name may not contain
4975 the name of a previously defined macro as a substring. You could, for example,
4976 define
4977 .display
4978 &`ABCD_XYZ = `&<&'something'&>
4979 &`ABCD = `&<&'something else'&>
4980 .endd
4981 but putting the definitions in the opposite order would provoke a configuration
4982 error. Macro expansion is applied to individual physical lines from the file,
4983 before checking for line continuation or file inclusion (see above). If a line
4984 consists solely of a macro name, and the expansion of the macro is empty, the
4985 line is ignored. A macro at the start of a line may turn the line into a
4986 comment line or a &`.include`& line.
4987
4988
4989 .section "Redefining macros" "SECID43"
4990 Once defined, the value of a macro can be redefined later in the configuration
4991 (or in an included file). Redefinition is specified by using &'=='& instead of
4992 &'='&. For example:
4993 .code
4994 MAC =  initial value
4995 ...
4996 MAC == updated value
4997 .endd
4998 Redefinition does not alter the order in which the macros are applied to the
4999 subsequent lines of the configuration file. It is still the same order in which
5000 the macros were originally defined. All that changes is the macro's value.
5001 Redefinition makes it possible to accumulate values. For example:
5002 .code
5003 MAC =  initial value
5004 ...
5005 MAC == MAC and something added
5006 .endd
5007 This can be helpful in situations where the configuration file is built
5008 from a number of other files.
5009
5010 .section "Overriding macro values" "SECID44"
5011 The values set for macros in the configuration file can be overridden by the
5012 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5013 used, unless called by root or the Exim user. A definition on the command line
5014 using the &%-D%& option causes all definitions and redefinitions within the
5015 file to be ignored.
5016
5017
5018
5019 .section "Example of macro usage" "SECID45"
5020 As an example of macro usage, consider a configuration where aliases are looked
5021 up in a MySQL database. It helps to keep the file less cluttered if long
5022 strings such as SQL statements are defined separately as macros, for example:
5023 .code
5024 ALIAS_QUERY = select mailbox from user where \
5025               login='${quote_mysql:$local_part}';
5026 .endd
5027 This can then be used in a &(redirect)& router setting like this:
5028 .code
5029 data = ${lookup mysql{ALIAS_QUERY}}
5030 .endd
5031 In earlier versions of Exim macros were sometimes used for domain, host, or
5032 address lists. In Exim 4 these are handled better by named lists &-- see
5033 section &<<SECTnamedlists>>&.
5034
5035
5036 .new
5037 .section "Builtin macros" "SECTbuiltinmacros"
5038 Exim defines some macros depending on facilities available, which may
5039 differ due to build-time definitions and from one release to another.
5040 All of these macros start with an underscore.
5041 They can be used to conditionally include parts of a configuration
5042 (see below).
5043
5044 The following classes of macros are defined:
5045 .display
5046 &` _HAVE_                     `&  build-time defines
5047 &` _DRVR_AUTH_                `&  authehticator drivers
5048 &` _DRVR_RTR_                 `&  router drivers
5049 &` _DRVR_TPT_                 `&  transport drivers
5050 &` _OPT_                      `&  configuration option support
5051 .endd
5052
5053 Use an &"exim -bP macros"& command to get the list of macros.
5054 .wen
5055
5056
5057 .section "Conditional skips in the configuration file" "SECID46"
5058 .cindex "configuration file" "conditional skips"
5059 .cindex "&`.ifdef`&"
5060 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5061 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5062 portions of the configuration file. The processing happens whenever the file is
5063 read (that is, when an Exim binary starts to run).
5064
5065 The implementation is very simple. Instances of the first four directives must
5066 be followed by text that includes the names of one or macros. The condition
5067 that is tested is whether or not any macro substitution has taken place in the
5068 line. Thus:
5069 .code
5070 .ifdef AAA
5071 message_size_limit = 50M
5072 .else
5073 message_size_limit = 100M
5074 .endif
5075 .endd
5076 sets a message size limit of 50M if the macro &`AAA`& is defined
5077 (or &`A`& or &`AA`&), and 100M
5078 otherwise. If there is more than one macro named on the line, the condition
5079 is true if any of them are defined. That is, it is an &"or"& condition. To
5080 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5081
5082 Although you can use a macro expansion to generate one of these directives,
5083 it is not very useful, because the condition &"there was a macro substitution
5084 in this line"& will always be true.
5085
5086 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5087 to clarify complicated nestings.
5088
5089
5090
5091 .section "Common option syntax" "SECTcos"
5092 .cindex "common option syntax"
5093 .cindex "syntax of common options"
5094 .cindex "configuration file" "common option syntax"
5095 For the main set of options, driver options, and &[local_scan()]& options,
5096 each setting is on a line by itself, and starts with a name consisting of
5097 lower-case letters and underscores. Many options require a data value, and in
5098 these cases the name must be followed by an equals sign (with optional white
5099 space) and then the value. For example:
5100 .code
5101 qualify_domain = mydomain.example.com
5102 .endd
5103 .cindex "hiding configuration option values"
5104 .cindex "configuration options" "hiding value of"
5105 .cindex "options" "hiding value of"
5106 Some option settings may contain sensitive data, for example, passwords for
5107 accessing databases. To stop non-admin users from using the &%-bP%& command
5108 line option to read these values, you can precede the option settings with the
5109 word &"hide"&. For example:
5110 .code
5111 hide mysql_servers = localhost/users/admin/secret-password
5112 .endd
5113 For non-admin users, such options are displayed like this:
5114 .code
5115 mysql_servers = <value not displayable>
5116 .endd
5117 If &"hide"& is used on a driver option, it hides the value of that option on
5118 all instances of the same driver.
5119
5120 The following sections describe the syntax used for the different data types
5121 that are found in option settings.
5122
5123
5124 .section "Boolean options" "SECID47"
5125 .cindex "format" "boolean"
5126 .cindex "boolean configuration values"
5127 .oindex "&%no_%&&'xxx'&"
5128 .oindex "&%not_%&&'xxx'&"
5129 Options whose type is given as boolean are on/off switches. There are two
5130 different ways of specifying such options: with and without a data value. If
5131 the option name is specified on its own without data, the switch is turned on;
5132 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5133 boolean options may be followed by an equals sign and one of the words
5134 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5135 the following two settings have exactly the same effect:
5136 .code
5137 queue_only
5138 queue_only = true
5139 .endd
5140 The following two lines also have the same (opposite) effect:
5141 .code
5142 no_queue_only
5143 queue_only = false
5144 .endd
5145 You can use whichever syntax you prefer.
5146
5147
5148
5149
5150 .section "Integer values" "SECID48"
5151 .cindex "integer configuration values"
5152 .cindex "format" "integer"
5153 If an option's type is given as &"integer"&, the value can be given in decimal,
5154 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5155 number is assumed. Otherwise, it is treated as an octal number unless it starts
5156 with the characters &"0x"&, in which case the remainder is interpreted as a
5157 hexadecimal number.
5158
5159 If an integer value is followed by the letter K, it is multiplied by 1024; if
5160 it is followed by the letter M, it is multiplied by 1024x1024;
5161 .new
5162 if by the letter G, 1024x1024x1024.
5163 .wen
5164 When the values
5165 of integer option settings are output, values which are an exact multiple of
5166 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5167 and M. The printing style is independent of the actual input format that was
5168 used.
5169
5170
5171 .section "Octal integer values" "SECID49"
5172 .cindex "integer format"
5173 .cindex "format" "octal integer"
5174 If an option's type is given as &"octal integer"&, its value is always
5175 interpreted as an octal number, whether or not it starts with the digit zero.
5176 Such options are always output in octal.
5177
5178
5179 .section "Fixed point numbers" "SECID50"
5180 .cindex "fixed point configuration values"
5181 .cindex "format" "fixed point"
5182 If an option's type is given as &"fixed-point"&, its value must be a decimal
5183 integer, optionally followed by a decimal point and up to three further digits.
5184
5185
5186
5187 .section "Time intervals" "SECTtimeformat"
5188 .cindex "time interval" "specifying in configuration"
5189 .cindex "format" "time interval"
5190 A time interval is specified as a sequence of numbers, each followed by one of
5191 the following letters, with no intervening white space:
5192
5193 .table2 30pt
5194 .irow &%s%& seconds
5195 .irow &%m%& minutes
5196 .irow &%h%& hours
5197 .irow &%d%& days
5198 .irow &%w%& weeks
5199 .endtable
5200
5201 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5202 intervals are output in the same format. Exim does not restrict the values; it
5203 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5204
5205
5206
5207 .section "String values" "SECTstrings"
5208 .cindex "string" "format of configuration values"
5209 .cindex "format" "string"
5210 If an option's type is specified as &"string"&, the value can be specified with
5211 or without double-quotes. If it does not start with a double-quote, the value
5212 consists of the remainder of the line plus any continuation lines, starting at
5213 the first character after any leading white space, with trailing white space
5214 removed, and with no interpretation of the characters in the string. Because
5215 Exim removes comment lines (those beginning with #) at an early stage, they can
5216 appear in the middle of a multi-line string. The following two settings are
5217 therefore equivalent:
5218 .code
5219 trusted_users = uucp:mail
5220 trusted_users = uucp:\
5221                 # This comment line is ignored
5222                 mail
5223 .endd
5224 .cindex "string" "quoted"
5225 .cindex "escape characters in quoted strings"
5226 If a string does start with a double-quote, it must end with a closing
5227 double-quote, and any backslash characters other than those used for line
5228 continuation are interpreted as escape characters, as follows:
5229
5230 .table2 100pt
5231 .irow &`\\`&                     "single backslash"
5232 .irow &`\n`&                     "newline"
5233 .irow &`\r`&                     "carriage return"
5234 .irow &`\t`&                     "tab"
5235 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5236 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5237                                    character"
5238 .endtable
5239
5240 If a backslash is followed by some other character, including a double-quote
5241 character, that character replaces the pair.
5242
5243 Quoting is necessary only if you want to make use of the backslash escapes to
5244 insert special characters, or if you need to specify a value with leading or
5245 trailing spaces. These cases are rare, so quoting is almost never needed in
5246 current versions of Exim. In versions of Exim before 3.14, quoting was required
5247 in order to continue lines, so you may come across older configuration files
5248 and examples that apparently quote unnecessarily.
5249
5250
5251 .section "Expanded strings" "SECID51"
5252 .cindex "expansion" "definition of"
5253 Some strings in the configuration file are subjected to &'string expansion'&,
5254 by which means various parts of the string may be changed according to the
5255 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5256 is as just described; in particular, the handling of backslashes in quoted
5257 strings is done as part of the input process, before expansion takes place.
5258 However, backslash is also an escape character for the expander, so any
5259 backslashes that are required for that reason must be doubled if they are
5260 within a quoted configuration string.
5261
5262
5263 .section "User and group names" "SECID52"
5264 .cindex "user name" "format of"
5265 .cindex "format" "user name"
5266 .cindex "groups" "name format"
5267 .cindex "format" "group name"
5268 User and group names are specified as strings, using the syntax described
5269 above, but the strings are interpreted specially. A user or group name must
5270 either consist entirely of digits, or be a name that can be looked up using the
5271 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5272
5273
5274 .section "List construction" "SECTlistconstruct"
5275 .cindex "list" "syntax of in configuration"
5276 .cindex "format" "list item in configuration"
5277 .cindex "string" "list, definition of"
5278 The data for some configuration options is a list of items, with colon as the
5279 default separator. Many of these options are shown with type &"string list"& in
5280 the descriptions later in this document. Others are listed as &"domain list"&,
5281 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5282 are all the same; however, those other than &"string list"& are subject to
5283 particular kinds of interpretation, as described in chapter
5284 &<<CHAPdomhosaddlists>>&.
5285
5286 In all these cases, the entire list is treated as a single string as far as the
5287 input syntax is concerned. The &%trusted_users%& setting in section
5288 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5289 in a list, it must be entered as two colons. Leading and trailing white space
5290 on each item in a list is ignored. This makes it possible to include items that
5291 start with a colon, and in particular, certain forms of IPv6 address. For
5292 example, the list
5293 .code
5294 local_interfaces = 127.0.0.1 : ::::1
5295 .endd
5296 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5297
5298 &*Note*&: Although leading and trailing white space is ignored in individual
5299 list items, it is not ignored when parsing the list. The space after the first
5300 colon in the example above is necessary. If it were not there, the list would
5301 be interpreted as the two items 127.0.0.1:: and 1.
5302
5303 .section "Changing list separators" "SECTlistsepchange"
5304 .cindex "list separator" "changing"
5305 .cindex "IPv6" "addresses in lists"
5306 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5307 introduced to allow the separator character to be changed. If a list begins
5308 with a left angle bracket, followed by any punctuation character, that
5309 character is used instead of colon as the list separator. For example, the list
5310 above can be rewritten to use a semicolon separator like this:
5311 .code
5312 local_interfaces = <; 127.0.0.1 ; ::1
5313 .endd
5314 This facility applies to all lists, with the exception of the list in
5315 &%log_file_path%&. It is recommended that the use of non-colon separators be
5316 confined to circumstances where they really are needed.
5317
5318 .cindex "list separator" "newline as"
5319 .cindex "newline" "as list separator"
5320 It is also possible to use newline and other control characters (those with
5321 code values less than 32, plus DEL) as separators in lists. Such separators
5322 must be provided literally at the time the list is processed. For options that
5323 are string-expanded, you can write the separator using a normal escape
5324 sequence. This will be processed by the expander before the string is
5325 interpreted as a list. For example, if a newline-separated list of domains is
5326 generated by a lookup, you can process it directly by a line such as this:
5327 .code
5328 domains = <\n ${lookup mysql{.....}}
5329 .endd
5330 This avoids having to change the list separator in such data. You are unlikely
5331 to want to use a control character as a separator in an option that is not
5332 expanded, because the value is literal text. However, it can be done by giving
5333 the value in quotes. For example:
5334 .code
5335 local_interfaces = "<\n 127.0.0.1 \n ::1"
5336 .endd
5337 Unlike printing character separators, which can be included in list items by
5338 doubling, it is not possible to include a control character as data when it is
5339 set as the separator. Two such characters in succession are interpreted as
5340 enclosing an empty list item.
5341
5342
5343
5344 .section "Empty items in lists" "SECTempitelis"
5345 .cindex "list" "empty item in"
5346 An empty item at the end of a list is always ignored. In other words, trailing
5347 separator characters are ignored. Thus, the list in
5348 .code
5349 senders = user@domain :
5350 .endd
5351 contains only a single item. If you want to include an empty string as one item
5352 in a list, it must not be the last item. For example, this list contains three
5353 items, the second of which is empty:
5354 .code
5355 senders = user1@domain : : user2@domain
5356 .endd
5357 &*Note*&: There must be white space between the two colons, as otherwise they
5358 are interpreted as representing a single colon data character (and the list
5359 would then contain just one item). If you want to specify a list that contains
5360 just one, empty item, you can do it as in this example:
5361 .code
5362 senders = :
5363 .endd
5364 In this case, the first item is empty, and the second is discarded because it
5365 is at the end of the list.
5366
5367
5368
5369
5370 .section "Format of driver configurations" "SECTfordricon"
5371 .cindex "drivers" "configuration format"
5372 There are separate parts in the configuration for defining routers, transports,
5373 and authenticators. In each part, you are defining a number of driver
5374 instances, each with its own set of options. Each driver instance is defined by
5375 a sequence of lines like this:
5376 .display
5377 <&'instance name'&>:
5378   <&'option'&>
5379   ...
5380   <&'option'&>
5381 .endd
5382 In the following example, the instance name is &(localuser)&, and it is
5383 followed by three options settings:
5384 .code
5385 localuser:
5386   driver = accept
5387   check_local_user
5388   transport = local_delivery
5389 .endd
5390 For each driver instance, you specify which Exim code module it uses &-- by the
5391 setting of the &%driver%& option &-- and (optionally) some configuration
5392 settings. For example, in the case of transports, if you want a transport to
5393 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5394 a local file you would use the &(appendfile)& driver. Each of the drivers is
5395 described in detail in its own separate chapter later in this manual.
5396
5397 You can have several routers, transports, or authenticators that are based on
5398 the same underlying driver (each must have a different instance name).
5399
5400 The order in which routers are defined is important, because addresses are
5401 passed to individual routers one by one, in order. The order in which
5402 transports are defined does not matter at all. The order in which
5403 authenticators are defined is used only when Exim, as a client, is searching
5404 them to find one that matches an authentication mechanism offered by the
5405 server.
5406
5407 .cindex "generic options"
5408 .cindex "options" "generic &-- definition of"
5409 Within a driver instance definition, there are two kinds of option: &'generic'&
5410 and &'private'&. The generic options are those that apply to all drivers of the
5411 same type (that is, all routers, all transports or all authenticators). The
5412 &%driver%& option is a generic option that must appear in every definition.
5413 .cindex "private options"
5414 The private options are special for each driver, and none need appear, because
5415 they all have default values.
5416
5417 The options may appear in any order, except that the &%driver%& option must
5418 precede any private options, since these depend on the particular driver. For
5419 this reason, it is recommended that &%driver%& always be the first option.
5420
5421 Driver instance names, which are used for reference in log entries and
5422 elsewhere, can be any sequence of letters, digits, and underscores (starting
5423 with a letter) and must be unique among drivers of the same type. A router and
5424 a transport (for example) can each have the same name, but no two router
5425 instances can have the same name. The name of a driver instance should not be
5426 confused with the name of the underlying driver module. For example, the
5427 configuration lines:
5428 .code
5429 remote_smtp:
5430   driver = smtp
5431 .endd
5432 create an instance of the &(smtp)& transport driver whose name is
5433 &(remote_smtp)&. The same driver code can be used more than once, with
5434 different instance names and different option settings each time. A second
5435 instance of the &(smtp)& transport, with different options, might be defined
5436 thus:
5437 .code
5438 special_smtp:
5439   driver = smtp
5440   port = 1234
5441   command_timeout = 10s
5442 .endd
5443 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5444 these transport instances from routers, and these names would appear in log
5445 lines.
5446
5447 Comment lines may be present in the middle of driver specifications. The full
5448 list of option settings for any particular driver instance, including all the
5449 defaulted values, can be extracted by making use of the &%-bP%& command line
5450 option.
5451
5452
5453
5454
5455
5456
5457 . ////////////////////////////////////////////////////////////////////////////
5458 . ////////////////////////////////////////////////////////////////////////////
5459
5460 .chapter "The default configuration file" "CHAPdefconfil"
5461 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5462 .cindex "default" "configuration file &""walk through""&"
5463 The default configuration file supplied with Exim as &_src/configure.default_&
5464 is sufficient for a host with simple mail requirements. As an introduction to
5465 the way Exim is configured, this chapter &"walks through"& the default
5466 configuration, giving brief explanations of the settings. Detailed descriptions
5467 of the options are given in subsequent chapters. The default configuration file
5468 itself contains extensive comments about ways you might want to modify the
5469 initial settings. However, note that there are many options that are not
5470 mentioned at all in the default configuration.
5471
5472
5473
5474 .section "Main configuration settings" "SECTdefconfmain"
5475 The main (global) configuration option settings must always come first in the
5476 file. The first thing you'll see in the file, after some initial comments, is
5477 the line
5478 .code
5479 # primary_hostname =
5480 .endd
5481 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5482 to know the official, fully qualified name of your host, and this is where you
5483 can specify it. However, in most cases you do not need to set this option. When
5484 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5485
5486 The first three non-comment configuration lines are as follows:
5487 .code
5488 domainlist local_domains    = @
5489 domainlist relay_to_domains =
5490 hostlist   relay_from_hosts = 127.0.0.1
5491 .endd
5492 These are not, in fact, option settings. They are definitions of two named
5493 domain lists and one named host list. Exim allows you to give names to lists of
5494 domains, hosts, and email addresses, in order to make it easier to manage the
5495 configuration file (see section &<<SECTnamedlists>>&).
5496
5497 The first line defines a domain list called &'local_domains'&; this is used
5498 later in the configuration to identify domains that are to be delivered
5499 on the local host.
5500
5501 .cindex "@ in a domain list"
5502 There is just one item in this list, the string &"@"&. This is a special form
5503 of entry which means &"the name of the local host"&. Thus, if the local host is
5504 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5505 be delivered locally. Because the local host's name is referenced indirectly,
5506 the same configuration file can be used on different hosts.
5507
5508 The second line defines a domain list called &'relay_to_domains'&, but the
5509 list itself is empty. Later in the configuration we will come to the part that
5510 controls mail relaying through the local host; it allows relaying to any
5511 domains in this list. By default, therefore, no relaying on the basis of a mail
5512 domain is permitted.
5513
5514 The third line defines a host list called &'relay_from_hosts'&. This list is
5515 used later in the configuration to permit relaying from any host or IP address
5516 that matches the list. The default contains just the IP address of the IPv4
5517 loopback interface, which means that processes on the local host are able to
5518 submit mail for relaying by sending it over TCP/IP to that interface. No other
5519 hosts are permitted to submit messages for relaying.
5520
5521 Just to be sure there's no misunderstanding: at this point in the configuration
5522 we aren't actually setting up any controls. We are just defining some domains
5523 and hosts that will be used in the controls that are specified later.
5524
5525 The next two configuration lines are genuine option settings:
5526 .code
5527 acl_smtp_rcpt = acl_check_rcpt
5528 acl_smtp_data = acl_check_data
5529 .endd
5530 These options specify &'Access Control Lists'& (ACLs) that are to be used
5531 during an incoming SMTP session for every recipient of a message (every RCPT
5532 command), and after the contents of the message have been received,
5533 respectively. The names of the lists are &'acl_check_rcpt'& and
5534 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5535 section of the configuration. The RCPT ACL controls which recipients are
5536 accepted for an incoming message &-- if a configuration does not provide an ACL
5537 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5538 contents of a message to be checked.
5539
5540 Two commented-out option settings are next:
5541 .code
5542 # av_scanner = clamd:/tmp/clamd
5543 # spamd_address = 127.0.0.1 783
5544 .endd
5545 These are example settings that can be used when Exim is compiled with the
5546 content-scanning extension. The first specifies the interface to the virus
5547 scanner, and the second specifies the interface to SpamAssassin. Further
5548 details are given in chapter &<<CHAPexiscan>>&.
5549
5550 Three more commented-out option settings follow:
5551 .code
5552 # tls_advertise_hosts = *
5553 # tls_certificate = /etc/ssl/exim.crt
5554 # tls_privatekey = /etc/ssl/exim.pem
5555 .endd
5556 These are example settings that can be used when Exim is compiled with
5557 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5558 first one specifies the list of clients that are allowed to use TLS when
5559 connecting to this server; in this case the wildcard means all clients. The
5560 other options specify where Exim should find its TLS certificate and private
5561 key, which together prove the server's identity to any clients that connect.
5562 More details are given in chapter &<<CHAPTLS>>&.
5563
5564 Another two commented-out option settings follow:
5565 .code
5566 # daemon_smtp_ports = 25 : 465 : 587
5567 # tls_on_connect_ports = 465
5568 .endd
5569 .cindex "port" "465 and 587"
5570 .cindex "port" "for message submission"
5571 .cindex "message" "submission, ports for"
5572 .cindex "ssmtp protocol"
5573 .cindex "smtps protocol"
5574 .cindex "SMTP" "ssmtp protocol"
5575 .cindex "SMTP" "smtps protocol"
5576 These options provide better support for roaming users who wish to use this
5577 server for message submission. They are not much use unless you have turned on
5578 TLS (as described in the previous paragraph) and authentication (about which
5579 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5580 on end-user networks, so RFC 4409 specifies that message submission should use
5581 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5582 configured to use port 587 correctly, so these settings also enable the
5583 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5584 &<<SECTsupobssmt>>&).
5585
5586 Two more commented-out options settings follow:
5587 .code
5588 # qualify_domain =
5589 # qualify_recipient =
5590 .endd
5591 The first of these specifies a domain that Exim uses when it constructs a
5592 complete email address from a local login name. This is often needed when Exim
5593 receives a message from a local process. If you do not set &%qualify_domain%&,
5594 the value of &%primary_hostname%& is used. If you set both of these options,
5595 you can have different qualification domains for sender and recipient
5596 addresses. If you set only the first one, its value is used in both cases.
5597
5598 .cindex "domain literal" "recognizing format"
5599 The following line must be uncommented if you want Exim to recognize
5600 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5601 (an IP address within square brackets) instead of a named domain.
5602 .code
5603 # allow_domain_literals
5604 .endd
5605 The RFCs still require this form, but many people think that in the modern
5606 Internet it makes little sense to permit mail to be sent to specific hosts by
5607 quoting their IP addresses. This ancient format has been used by people who
5608 try to abuse hosts by using them for unwanted relaying. However, some
5609 people believe there are circumstances (for example, messages addressed to
5610 &'postmaster'&) where domain literals are still useful.
5611
5612 The next configuration line is a kind of trigger guard:
5613 .code
5614 never_users = root
5615 .endd
5616 It specifies that no delivery must ever be run as the root user. The normal
5617 convention is to set up &'root'& as an alias for the system administrator. This
5618 setting is a guard against slips in the configuration.
5619 The list of users specified by &%never_users%& is not, however, the complete
5620 list; the build-time configuration in &_Local/Makefile_& has an option called
5621 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5622 contents of &%never_users%& are added to this list. By default
5623 FIXED_NEVER_USERS also specifies root.
5624
5625 When a remote host connects to Exim in order to send mail, the only information
5626 Exim has about the host's identity is its IP address. The next configuration
5627 line,
5628 .code
5629 host_lookup = *
5630 .endd
5631 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5632 in order to get a host name. This improves the quality of the logging
5633 information, but if you feel it is too expensive, you can remove it entirely,
5634 or restrict the lookup to hosts on &"nearby"& networks.
5635 Note that it is not always possible to find a host name from an IP address,
5636 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5637 unreachable.
5638
5639 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5640 1413 (hence their names):
5641 .code
5642 rfc1413_hosts = *
5643 rfc1413_query_timeout = 0s
5644 .endd
5645 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5646 Few hosts offer RFC1413 service these days; calls have to be
5647 terminated by a timeout and this needlessly delays the startup
5648 of an incoming SMTP connection.
5649 If you have hosts for which you trust RFC1413 and need this
5650 information, you can change this.
5651
5652 This line enables an efficiency SMTP option.  It is negotiated by clients
5653 and not expected to cause problems but can be disabled if needed.
5654 .code
5655 prdr_enable = true
5656 .endd
5657
5658 When Exim receives messages over SMTP connections, it expects all addresses to
5659 be fully qualified with a domain, as required by the SMTP definition. However,
5660 if you are running a server to which simple clients submit messages, you may
5661 find that they send unqualified addresses. The two commented-out options:
5662 .code
5663 # sender_unqualified_hosts =
5664 # recipient_unqualified_hosts =
5665 .endd
5666 show how you can specify hosts that are permitted to send unqualified sender
5667 and recipient addresses, respectively.
5668
5669 The &%log_selector%& option is used to increase the detail of logging
5670 over the default:
5671 .code
5672 log_selector = +smtp_protocol_error +smtp_syntax_error \
5673                +tls_certificate_verified
5674 .endd
5675
5676 The &%percent_hack_domains%& option is also commented out:
5677 .code
5678 # percent_hack_domains =
5679 .endd
5680 It provides a list of domains for which the &"percent hack"& is to operate.
5681 This is an almost obsolete form of explicit email routing. If you do not know
5682 anything about it, you can safely ignore this topic.
5683
5684 The next two settings in the main part of the default configuration are
5685 concerned with messages that have been &"frozen"& on Exim's queue. When a
5686 message is frozen, Exim no longer continues to try to deliver it. Freezing
5687 occurs when a bounce message encounters a permanent failure because the sender
5688 address of the original message that caused the bounce is invalid, so the
5689 bounce cannot be delivered. This is probably the most common case, but there
5690 are also other conditions that cause freezing, and frozen messages are not
5691 always bounce messages.
5692 .code
5693 ignore_bounce_errors_after = 2d
5694 timeout_frozen_after = 7d
5695 .endd
5696 The first of these options specifies that failing bounce messages are to be
5697 discarded after 2 days on the queue. The second specifies that any frozen
5698 message (whether a bounce message or not) is to be timed out (and discarded)
5699 after a week. In this configuration, the first setting ensures that no failing
5700 bounce message ever lasts a week.
5701
5702 Exim queues it's messages in a spool directory. If you expect to have
5703 large queues, you may consider using this option. It splits the spool
5704 directory into subdirectories to avoid file system degradation from
5705 many files in a single directory, resulting in better performance.
5706 Manual manipulation of queued messages becomes more complex (though fortunately
5707 not often needed).
5708 .code
5709 # split_spool_directory = true
5710 .endd
5711
5712 In an ideal world everybody follows the standards. For non-ASCII
5713 messages RFC 2047 is a standard, allowing a maximum line length of 76
5714 characters. Exim adheres that standard and won't process messages which
5715 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5716 In particular, the Exim maintainers have had multiple reports of
5717 problems from Russian administrators of issues until they disable this
5718 check, because of some popular, yet buggy, mail composition software.
5719 .code
5720 # check_rfc2047_length = false
5721 .endd
5722
5723 If you need to be strictly RFC compliant you may wish to disable the
5724 8BITMIME advertisement. Use this, if you exchange mails with systems
5725 that are not 8-bit clean.
5726 .code
5727 # accept_8bitmime = false
5728 .endd
5729
5730 Libraries you use may depend on specific environment settings.  This
5731 imposes a security risk (e.g. PATH). There are two lists:
5732 &%keep_environment%& for the variables to import as they are, and
5733 &%add_environment%& for variables we want to set to a fixed value.
5734 Note that TZ is handled separately, by the $%timezone%$ runtime
5735 option and by the TIMEZONE_DEFAULT buildtime option.
5736 .code
5737 # keep_environment = ^LDAP
5738 # add_environment = PATH=/usr/bin::/bin
5739 .endd
5740
5741
5742 .section "ACL configuration" "SECID54"
5743 .cindex "default" "ACLs"
5744 .cindex "&ACL;" "default configuration"
5745 In the default configuration, the ACL section follows the main configuration.
5746 It starts with the line
5747 .code
5748 begin acl
5749 .endd
5750 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5751 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5752 and &%acl_smtp_data%& above.
5753
5754 .cindex "RCPT" "ACL for"
5755 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5756 RCPT command specifies one of the message's recipients. The ACL statements
5757 are considered in order, until the recipient address is either accepted or
5758 rejected. The RCPT command is then accepted or rejected, according to the
5759 result of the ACL processing.
5760 .code
5761 acl_check_rcpt:
5762 .endd
5763 This line, consisting of a name terminated by a colon, marks the start of the
5764 ACL, and names it.
5765 .code
5766 accept  hosts = :
5767 .endd
5768 This ACL statement accepts the recipient if the sending host matches the list.
5769 But what does that strange list mean? It doesn't actually contain any host
5770 names or IP addresses. The presence of the colon puts an empty item in the
5771 list; Exim matches this only if the incoming message did not come from a remote
5772 host, because in that case, the remote hostname is empty. The colon is
5773 important. Without it, the list itself is empty, and can never match anything.
5774
5775 What this statement is doing is to accept unconditionally all recipients in
5776 messages that are submitted by SMTP from local processes using the standard
5777 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5778 manner.
5779 .code
5780 deny    message       = Restricted characters in address
5781         domains       = +local_domains
5782         local_parts   = ^[.] : ^.*[@%!/|]
5783
5784 deny    message       = Restricted characters in address
5785         domains       = !+local_domains
5786         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5787 .endd
5788 These statements are concerned with local parts that contain any of the
5789 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5790 Although these characters are entirely legal in local parts (in the case of
5791 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5792 in Internet mail addresses.
5793
5794 The first three have in the past been associated with explicitly routed
5795 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5796 option). Addresses containing these characters are regularly tried by spammers
5797 in an attempt to bypass relaying restrictions, and also by open relay testing
5798 programs. Unless you really need them it is safest to reject these characters
5799 at this early stage. This configuration is heavy-handed in rejecting these
5800 characters for all messages it accepts from remote hosts. This is a deliberate
5801 policy of being as safe as possible.
5802
5803 The first rule above is stricter, and is applied to messages that are addressed
5804 to one of the local domains handled by this host. This is implemented by the
5805 first condition, which restricts it to domains that are listed in the
5806 &'local_domains'& domain list. The &"+"& character is used to indicate a
5807 reference to a named list. In this configuration, there is just one domain in
5808 &'local_domains'&, but in general there may be many.
5809
5810 The second condition on the first statement uses two regular expressions to
5811 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5812 or &"|"&. If you have local accounts that include these characters, you will
5813 have to modify this rule.
5814
5815 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5816 allows them because they have been encountered in practice. (Consider the
5817 common convention of local parts constructed as
5818 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5819 the author of Exim, who has no second initial.) However, a local part starting
5820 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5821 file name (for example, for a mailing list). This is also true for local parts
5822 that contain slashes. A pipe symbol can also be troublesome if the local part
5823 is incorporated unthinkingly into a shell command line.
5824
5825 The second rule above applies to all other domains, and is less strict. This
5826 allows your own users to send outgoing messages to sites that use slashes
5827 and vertical bars in their local parts. It blocks local parts that begin
5828 with a dot, slash, or vertical bar, but allows these characters within the
5829 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5830 and &"!"& is blocked, as before. The motivation here is to prevent your users
5831 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5832 .code
5833 accept  local_parts   = postmaster
5834         domains       = +local_domains
5835 .endd
5836 This statement, which has two conditions, accepts an incoming address if the
5837 local part is &'postmaster'& and the domain is one of those listed in the
5838 &'local_domains'& domain list. The &"+"& character is used to indicate a
5839 reference to a named list. In this configuration, there is just one domain in
5840 &'local_domains'&, but in general there may be many.
5841
5842 The presence of this statement means that mail to postmaster is never blocked
5843 by any of the subsequent tests. This can be helpful while sorting out problems
5844 in cases where the subsequent tests are incorrectly denying access.
5845 .code
5846 require verify        = sender
5847 .endd
5848 This statement requires the sender address to be verified before any subsequent
5849 ACL statement can be used. If verification fails, the incoming recipient
5850 address is refused. Verification consists of trying to route the address, to
5851 see if a bounce message could be delivered to it. In the case of remote
5852 addresses, basic verification checks only the domain, but &'callouts'& can be
5853 used for more verification if required. Section &<<SECTaddressverification>>&
5854 discusses the details of address verification.
5855 .code
5856 accept  hosts         = +relay_from_hosts
5857         control       = submission
5858 .endd
5859 This statement accepts the address if the message is coming from one of the
5860 hosts that are defined as being allowed to relay through this host. Recipient
5861 verification is omitted here, because in many cases the clients are dumb MUAs
5862 that do not cope well with SMTP error responses. For the same reason, the
5863 second line specifies &"submission mode"& for messages that are accepted. This
5864 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5865 messages that are deficient in some way, for example, because they lack a
5866 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5867 probably add recipient verification here, and disable submission mode.
5868 .code
5869 accept  authenticated = *
5870         control       = submission
5871 .endd
5872 This statement accepts the address if the client host has authenticated itself.
5873 Submission mode is again specified, on the grounds that such messages are most
5874 likely to come from MUAs. The default configuration does not define any
5875 authenticators, though it does include some nearly complete commented-out
5876 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5877 fact authenticate until you complete the authenticator definitions.
5878 .code
5879 require message = relay not permitted
5880         domains = +local_domains : +relay_to_domains
5881 .endd
5882 This statement rejects the address if its domain is neither a local domain nor
5883 one of the domains for which this host is a relay.
5884 .code
5885 require verify = recipient
5886 .endd
5887 This statement requires the recipient address to be verified; if verification
5888 fails, the address is rejected.
5889 .code
5890 # deny    message     = rejected because $sender_host_address \
5891 #                       is in a black list at $dnslist_domain\n\
5892 #                       $dnslist_text
5893 #         dnslists    = black.list.example
5894 #
5895 # warn    dnslists    = black.list.example
5896 #         add_header  = X-Warning: $sender_host_address is in \
5897 #                       a black list at $dnslist_domain
5898 #         log_message = found in $dnslist_domain
5899 .endd
5900 These commented-out lines are examples of how you could configure Exim to check
5901 sending hosts against a DNS black list. The first statement rejects messages
5902 from blacklisted hosts, whereas the second just inserts a warning header
5903 line.
5904 .code
5905 # require verify = csa
5906 .endd
5907 This commented-out line is an example of how you could turn on client SMTP
5908 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5909 records.
5910 .code
5911 accept
5912 .endd
5913 The final statement in the first ACL unconditionally accepts any recipient
5914 address that has successfully passed all the previous tests.
5915 .code
5916 acl_check_data:
5917 .endd
5918 This line marks the start of the second ACL, and names it. Most of the contents
5919 of this ACL are commented out:
5920 .code
5921 # deny    malware   = *
5922 #         message   = This message contains a virus \
5923 #                     ($malware_name).
5924 .endd
5925 These lines are examples of how to arrange for messages to be scanned for
5926 viruses when Exim has been compiled with the content-scanning extension, and a
5927 suitable virus scanner is installed. If the message is found to contain a
5928 virus, it is rejected with the given custom error message.
5929 .code
5930 # warn    spam      = nobody
5931 #         message   = X-Spam_score: $spam_score\n\
5932 #                     X-Spam_score_int: $spam_score_int\n\
5933 #                     X-Spam_bar: $spam_bar\n\
5934 #                     X-Spam_report: $spam_report
5935 .endd
5936 These lines are an example of how to arrange for messages to be scanned by
5937 SpamAssassin when Exim has been compiled with the content-scanning extension,
5938 and SpamAssassin has been installed. The SpamAssassin check is run with
5939 &`nobody`& as its user parameter, and the results are added to the message as a
5940 series of extra header line. In this case, the message is not rejected,
5941 whatever the spam score.
5942 .code
5943 accept
5944 .endd
5945 This final line in the DATA ACL accepts the message unconditionally.
5946
5947
5948 .section "Router configuration" "SECID55"
5949 .cindex "default" "routers"
5950 .cindex "routers" "default"
5951 The router configuration comes next in the default configuration, introduced
5952 by the line
5953 .code
5954 begin routers
5955 .endd
5956 Routers are the modules in Exim that make decisions about where to send
5957 messages. An address is passed to each router in turn, until it is either
5958 accepted, or failed. This means that the order in which you define the routers
5959 matters. Each router is fully described in its own chapter later in this
5960 manual. Here we give only brief overviews.
5961 .code
5962 # domain_literal:
5963 #   driver = ipliteral
5964 #   domains = !+local_domains
5965 #   transport = remote_smtp
5966 .endd
5967 .cindex "domain literal" "default router"
5968 This router is commented out because the majority of sites do not want to
5969 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5970 you uncomment this router, you also need to uncomment the setting of
5971 &%allow_domain_literals%& in the main part of the configuration.
5972 .code
5973 dnslookup:
5974   driver = dnslookup
5975   domains = ! +local_domains
5976   transport = remote_smtp
5977   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5978   no_more
5979 .endd
5980 The first uncommented router handles addresses that do not involve any local
5981 domains. This is specified by the line
5982 .code
5983 domains = ! +local_domains
5984 .endd
5985 The &%domains%& option lists the domains to which this router applies, but the
5986 exclamation mark is a negation sign, so the router is used only for domains
5987 that are not in the domain list called &'local_domains'& (which was defined at
5988 the start of the configuration). The plus sign before &'local_domains'&
5989 indicates that it is referring to a named list. Addresses in other domains are
5990 passed on to the following routers.
5991
5992 The name of the router driver is &(dnslookup)&,
5993 and is specified by the &%driver%& option. Do not be confused by the fact that
5994 the name of this router instance is the same as the name of the driver. The
5995 instance name is arbitrary, but the name set in the &%driver%& option must be
5996 one of the driver modules that is in the Exim binary.
5997
5998 The &(dnslookup)& router routes addresses by looking up their domains in the
5999 DNS in order to obtain a list of hosts to which the address is routed. If the
6000 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6001 specified by the &%transport%& option. If the router does not find the domain
6002 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6003 the address fails and is bounced.
6004
6005 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6006 be entirely ignored. This option is present because a number of cases have been
6007 encountered where MX records in the DNS point to host names
6008 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6009 Completely ignoring these IP addresses causes Exim to fail to route the
6010 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6011 continue to try to deliver the message periodically until the address timed
6012 out.
6013 .code
6014 system_aliases:
6015   driver = redirect
6016   allow_fail
6017   allow_defer
6018   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6019 # user = exim
6020   file_transport = address_file
6021   pipe_transport = address_pipe
6022 .endd
6023 Control reaches this and subsequent routers only for addresses in the local
6024 domains. This router checks to see whether the local part is defined as an
6025 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6026 data that it looks up from that file. If no data is found for the local part,
6027 the value of the &%data%& option is empty, causing the address to be passed to
6028 the next router.
6029
6030 &_/etc/aliases_& is a conventional name for the system aliases file that is
6031 often used. That is why it is referenced by from the default configuration
6032 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6033 &_Local/Makefile_& before building Exim.
6034 .code
6035 userforward:
6036   driver = redirect
6037   check_local_user
6038 # local_part_suffix = +* : -*
6039 # local_part_suffix_optional
6040   file = $home/.forward
6041 # allow_filter
6042   no_verify
6043   no_expn
6044   check_ancestor
6045   file_transport = address_file
6046   pipe_transport = address_pipe
6047   reply_transport = address_reply
6048 .endd
6049 This is the most complicated router in the default configuration. It is another
6050 redirection router, but this time it is looking for forwarding data set up by
6051 individual users. The &%check_local_user%& setting specifies a check that the
6052 local part of the address is the login name of a local user. If it is not, the
6053 router is skipped. The two commented options that follow &%check_local_user%&,
6054 namely:
6055 .code
6056 # local_part_suffix = +* : -*
6057 # local_part_suffix_optional
6058 .endd
6059 .vindex "&$local_part_suffix$&"
6060 show how you can specify the recognition of local part suffixes. If the first
6061 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6062 by any sequence of characters, is removed from the local part and placed in the
6063 variable &$local_part_suffix$&. The second suffix option specifies that the
6064 presence of a suffix in the local part is optional. When a suffix is present,
6065 the check for a local login uses the local part with the suffix removed.
6066
6067 When a local user account is found, the file called &_.forward_& in the user's
6068 home directory is consulted. If it does not exist, or is empty, the router
6069 declines. Otherwise, the contents of &_.forward_& are interpreted as
6070 redirection data (see chapter &<<CHAPredirect>>& for more details).
6071
6072 .cindex "Sieve filter" "enabling in default router"
6073 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6074 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6075 is commented out by default), the contents of the file are interpreted as a set
6076 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6077 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6078 separate document entitled &'Exim's interfaces to mail filtering'&.
6079
6080 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6081 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6082 There are two reasons for doing this:
6083
6084 .olist
6085 Whether or not a local user has a &_.forward_& file is not really relevant when
6086 checking an address for validity; it makes sense not to waste resources doing
6087 unnecessary work.
6088 .next
6089 More importantly, when Exim is verifying addresses or handling an EXPN
6090 command during an SMTP session, it is running as the Exim user, not as root.
6091 The group is the Exim group, and no additional groups are set up.
6092 It may therefore not be possible for Exim to read users' &_.forward_& files at
6093 this time.
6094 .endlist
6095
6096 The setting of &%check_ancestor%& prevents the router from generating a new
6097 address that is the same as any previous address that was redirected. (This
6098 works round a problem concerning a bad interaction between aliasing and
6099 forwarding &-- see section &<<SECTredlocmai>>&).
6100
6101 The final three option settings specify the transports that are to be used when
6102 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6103 auto-reply, respectively. For example, if a &_.forward_& file contains
6104 .code
6105 a.nother@elsewhere.example, /home/spqr/archive
6106 .endd
6107 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6108 transport.
6109 .code
6110 localuser:
6111   driver = accept
6112   check_local_user
6113 # local_part_suffix = +* : -*
6114 # local_part_suffix_optional
6115   transport = local_delivery
6116 .endd
6117 The final router sets up delivery into local mailboxes, provided that the local
6118 part is the name of a local login, by accepting the address and assigning it to
6119 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6120 routers, so the address is bounced. The commented suffix settings fulfil the
6121 same purpose as they do for the &(userforward)& router.
6122
6123
6124 .section "Transport configuration" "SECID56"
6125 .cindex "default" "transports"
6126 .cindex "transports" "default"
6127 Transports define mechanisms for actually delivering messages. They operate
6128 only when referenced from routers, so the order in which they are defined does
6129 not matter. The transports section of the configuration starts with
6130 .code
6131 begin transports
6132 .endd
6133 One remote transport and four local transports are defined.
6134 .code
6135 remote_smtp:
6136   driver = smtp
6137   hosts_try_prdr = *
6138 .endd
6139 This transport is used for delivering messages over SMTP connections.
6140 The list of remote hosts comes from the router.
6141 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6142 It is negotiated between client and server
6143 and not expected to cause problems but can be disabled if needed.
6144 All other options are defaulted.
6145 .code
6146 local_delivery:
6147   driver = appendfile
6148   file = /var/mail/$local_part
6149   delivery_date_add
6150   envelope_to_add
6151   return_path_add
6152 # group = mail
6153 # mode = 0660
6154 .endd
6155 This &(appendfile)& transport is used for local delivery to user mailboxes in
6156 traditional BSD mailbox format. By default it runs under the uid and gid of the
6157 local user, which requires the sticky bit to be set on the &_/var/mail_&
6158 directory. Some systems use the alternative approach of running mail deliveries
6159 under a particular group instead of using the sticky bit. The commented options
6160 show how this can be done.
6161
6162 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6163 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6164 similarly-named options above.
6165 .code
6166 address_pipe:
6167   driver = pipe
6168   return_output
6169 .endd
6170 This transport is used for handling deliveries to pipes that are generated by
6171 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6172 option specifies that any output on stdout or stderr generated by the pipe is to
6173 be returned to the sender.
6174 .code
6175 address_file:
6176   driver = appendfile
6177   delivery_date_add
6178   envelope_to_add
6179   return_path_add
6180 .endd
6181 This transport is used for handling deliveries to files that are generated by
6182 redirection. The name of the file is not specified in this instance of
6183 &(appendfile)&, because it comes from the &(redirect)& router.
6184 .code
6185 address_reply:
6186   driver = autoreply
6187 .endd
6188 This transport is used for handling automatic replies generated by users'
6189 filter files.
6190
6191
6192
6193 .section "Default retry rule" "SECID57"
6194 .cindex "retry" "default rule"
6195 .cindex "default" "retry rule"
6196 The retry section of the configuration file contains rules which affect the way
6197 Exim retries deliveries that cannot be completed at the first attempt. It is
6198 introduced by the line
6199 .code
6200 begin retry
6201 .endd
6202 In the default configuration, there is just one rule, which applies to all
6203 errors:
6204 .code
6205 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6206 .endd
6207 This causes any temporarily failing address to be retried every 15 minutes for
6208 2 hours, then at intervals starting at one hour and increasing by a factor of
6209 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6210 is not delivered after 4 days of temporary failure, it is bounced. The time is
6211 measured from first failure, not from the time the message was received.
6212
6213 If the retry section is removed from the configuration, or is empty (that is,
6214 if no retry rules are defined), Exim will not retry deliveries. This turns
6215 temporary errors into permanent errors.
6216
6217
6218 .section "Rewriting configuration" "SECID58"
6219 The rewriting section of the configuration, introduced by
6220 .code
6221 begin rewrite
6222 .endd
6223 contains rules for rewriting addresses in messages as they arrive. There are no
6224 rewriting rules in the default configuration file.
6225
6226
6227
6228 .section "Authenticators configuration" "SECTdefconfauth"
6229 .cindex "AUTH" "configuration"
6230 The authenticators section of the configuration, introduced by
6231 .code
6232 begin authenticators
6233 .endd
6234 defines mechanisms for the use of the SMTP AUTH command. The default
6235 configuration file contains two commented-out example authenticators
6236 which support plaintext username/password authentication using the
6237 standard PLAIN mechanism and the traditional but non-standard LOGIN
6238 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6239 to support most MUA software.
6240
6241 The example PLAIN authenticator looks like this:
6242 .code
6243 #PLAIN:
6244 #  driver                  = plaintext
6245 #  server_set_id           = $auth2
6246 #  server_prompts          = :
6247 #  server_condition        = Authentication is not yet configured
6248 #  server_advertise_condition = ${if def:tls_in_cipher }
6249 .endd
6250 And the example LOGIN authenticator looks like this:
6251 .code
6252 #LOGIN:
6253 #  driver                  = plaintext
6254 #  server_set_id           = $auth1
6255 #  server_prompts          = <| Username: | Password:
6256 #  server_condition        = Authentication is not yet configured
6257 #  server_advertise_condition = ${if def:tls_in_cipher }
6258 .endd
6259
6260 The &%server_set_id%& option makes Exim remember the authenticated username
6261 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6262 &%server_prompts%& option configures the &(plaintext)& authenticator so
6263 that it implements the details of the specific authentication mechanism,
6264 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6265 when Exim offers authentication to clients; in the examples, this is only
6266 when TLS or SSL has been started, so to enable the authenticators you also
6267 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6268
6269 The &%server_condition%& setting defines how to verify that the username and
6270 password are correct. In the examples it just produces an error message.
6271 To make the authenticators work, you can use a string expansion
6272 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6273
6274 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6275 usercode and password are in different positions.
6276 Chapter &<<CHAPplaintext>>& covers both.
6277
6278 .ecindex IIDconfiwal
6279
6280
6281
6282 . ////////////////////////////////////////////////////////////////////////////
6283 . ////////////////////////////////////////////////////////////////////////////
6284
6285 .chapter "Regular expressions" "CHAPregexp"
6286
6287 .cindex "regular expressions" "library"
6288 .cindex "PCRE"
6289 Exim supports the use of regular expressions in many of its options. It
6290 uses the PCRE regular expression library; this provides regular expression
6291 matching that is compatible with Perl 5. The syntax and semantics of
6292 regular expressions is discussed in
6293 .new
6294 online Perl manpages, in
6295 .wen
6296 many Perl reference books, and also in
6297 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6298 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6299
6300 The documentation for the syntax and semantics of the regular expressions that
6301 are supported by PCRE is included in the PCRE distribution, and no further
6302 description is included here. The PCRE functions are called from Exim using
6303 the default option settings (that is, with no PCRE options set), except that
6304 the PCRE_CASELESS option is set when the matching is required to be
6305 case-insensitive.
6306
6307 In most cases, when a regular expression is required in an Exim configuration,
6308 it has to start with a circumflex, in order to distinguish it from plain text
6309 or an &"ends with"& wildcard. In this example of a configuration setting, the
6310 second item in the colon-separated list is a regular expression.
6311 .code
6312 domains = a.b.c : ^\\d{3} : *.y.z : ...
6313 .endd
6314 The doubling of the backslash is required because of string expansion that
6315 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6316 of this issue, and a way of avoiding the need for doubling backslashes. The
6317 regular expression that is eventually used in this example contains just one
6318 backslash. The circumflex is included in the regular expression, and has the
6319 normal effect of &"anchoring"& it to the start of the string that is being
6320 matched.
6321
6322 There are, however, two cases where a circumflex is not required for the
6323 recognition of a regular expression: these are the &%match%& condition in a
6324 string expansion, and the &%matches%& condition in an Exim filter file. In
6325 these cases, the relevant string is always treated as a regular expression; if
6326 it does not start with a circumflex, the expression is not anchored, and can
6327 match anywhere in the subject string.
6328
6329 In all cases, if you want a regular expression to match at the end of a string,
6330 you must code the $ metacharacter to indicate this. For example:
6331 .code
6332 domains = ^\\d{3}\\.example
6333 .endd
6334 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6335 You need to use:
6336 .code
6337 domains = ^\\d{3}\\.example\$
6338 .endd
6339 if you want &'example'& to be the top-level domain. The backslash before the
6340 $ is needed because string expansion also interprets dollar characters.
6341
6342
6343
6344 . ////////////////////////////////////////////////////////////////////////////
6345 . ////////////////////////////////////////////////////////////////////////////
6346
6347 .chapter "File and database lookups" "CHAPfdlookup"
6348 .scindex IIDfidalo1 "file" "lookups"
6349 .scindex IIDfidalo2 "database" "lookups"
6350 .cindex "lookup" "description of"
6351 Exim can be configured to look up data in files or databases as it processes
6352 messages. Two different kinds of syntax are used:
6353
6354 .olist
6355 A string that is to be expanded may contain explicit lookup requests. These
6356 cause parts of the string to be replaced by data that is obtained from the
6357 lookup. Lookups of this type are conditional expansion items. Different results
6358 can be defined for the cases of lookup success and failure. See chapter
6359 &<<CHAPexpand>>&, where string expansions are described in detail.
6360 The key for the lookup is specified as part of the string expansion.
6361 .next
6362 Lists of domains, hosts, and email addresses can contain lookup requests as a
6363 way of avoiding excessively long linear lists. In this case, the data that is
6364 returned by the lookup is often (but not always) discarded; whether the lookup
6365 succeeds or fails is what really counts. These kinds of list are described in
6366 chapter &<<CHAPdomhosaddlists>>&.
6367 The key for the lookup is given by the context in which the list is expanded.
6368 .endlist
6369
6370 String expansions, lists, and lookups interact with each other in such a way
6371 that there is no order in which to describe any one of them that does not
6372 involve references to the others. Each of these three chapters makes more sense
6373 if you have read the other two first. If you are reading this for the first
6374 time, be aware that some of it will make a lot more sense after you have read
6375 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6376
6377 .section "Examples of different lookup syntax" "SECID60"
6378 It is easy to confuse the two different kinds of lookup, especially as the
6379 lists that may contain the second kind are always expanded before being
6380 processed as lists. Therefore, they may also contain lookups of the first kind.
6381 Be careful to distinguish between the following two examples:
6382 .code
6383 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6384 domains = lsearch;/some/file
6385 .endd
6386 The first uses a string expansion, the result of which must be a domain list.
6387 No strings have been specified for a successful or a failing lookup; the
6388 defaults in this case are the looked-up data and an empty string, respectively.
6389 The expansion takes place before the string is processed as a list, and the
6390 file that is searched could contain lines like this:
6391 .code
6392 192.168.3.4: domain1:domain2:...
6393 192.168.1.9: domain3:domain4:...
6394 .endd
6395 When the lookup succeeds, the result of the expansion is a list of domains (and
6396 possibly other types of item that are allowed in domain lists).
6397
6398 In the second example, the lookup is a single item in a domain list. It causes
6399 Exim to use a lookup to see if the domain that is being processed can be found
6400 in the file. The file could contains lines like this:
6401 .code
6402 domain1:
6403 domain2:
6404 .endd
6405 Any data that follows the keys is not relevant when checking that the domain
6406 matches the list item.
6407
6408 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6409 Consider a file containing lines like this:
6410 .code
6411 192.168.5.6: lsearch;/another/file
6412 .endd
6413 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6414 first &%domains%& setting above generates the second setting, which therefore
6415 causes a second lookup to occur.
6416
6417 The rest of this chapter describes the different lookup types that are
6418 available. Any of them can be used in any part of the configuration where a
6419 lookup is permitted.
6420
6421
6422 .section "Lookup types" "SECID61"
6423 .cindex "lookup" "types of"
6424 .cindex "single-key lookup" "definition of"
6425 Two different types of data lookup are implemented:
6426
6427 .ilist
6428 The &'single-key'& type requires the specification of a file in which to look,
6429 and a single key to search for. The key must be a non-empty string for the
6430 lookup to succeed. The lookup type determines how the file is searched.
6431 .next
6432 .cindex "query-style lookup" "definition of"
6433 The &'query-style'& type accepts a generalized database query. No particular
6434 key value is assumed by Exim for query-style lookups. You can use whichever
6435 Exim variables you need to construct the database query.
6436 .endlist
6437
6438 The code for each lookup type is in a separate source file that is included in
6439 the binary of Exim only if the corresponding compile-time option is set. The
6440 default settings in &_src/EDITME_& are:
6441 .code
6442 LOOKUP_DBM=yes
6443 LOOKUP_LSEARCH=yes
6444 .endd
6445 which means that only linear searching and DBM lookups are included by default.
6446 For some types of lookup (e.g. SQL databases), you need to install appropriate
6447 libraries and header files before building Exim.
6448
6449
6450
6451
6452 .section "Single-key lookup types" "SECTsinglekeylookups"
6453 .cindex "lookup" "single-key types"
6454 .cindex "single-key lookup" "list of types"
6455 The following single-key lookup types are implemented:
6456
6457 .ilist
6458 .cindex "cdb" "description of"
6459 .cindex "lookup" "cdb"
6460 .cindex "binary zero" "in lookup key"
6461 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6462 string without a terminating binary zero. The cdb format is designed for
6463 indexed files that are read frequently and never updated, except by total
6464 re-creation. As such, it is particularly suitable for large files containing
6465 aliases or other indexed data referenced by an MTA. Information about cdb can
6466 be found in several places:
6467 .display
6468 &url(http://www.pobox.com/~djb/cdb.html)
6469 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6470 &url(http://packages.debian.org/stable/utils/freecdb.html)
6471 .endd
6472 A cdb distribution is not needed in order to build Exim with cdb support,
6473 because the code for reading cdb files is included directly in Exim itself.
6474 However, no means of building or testing cdb files is provided with Exim, so
6475 you need to obtain a cdb distribution in order to do this.
6476 .next
6477 .cindex "DBM" "lookup type"
6478 .cindex "lookup" "dbm"
6479 .cindex "binary zero" "in lookup key"
6480 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6481 DBM file by looking up the record with the given key. A terminating binary
6482 zero is included in the key that is passed to the DBM library. See section
6483 &<<SECTdb>>& for a discussion of DBM libraries.
6484
6485 .cindex "Berkeley DB library" "file format"
6486 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6487 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6488 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6489 the DB_UNKNOWN option. This enables it to handle any of the types of database
6490 that the library supports, and can be useful for accessing DBM files created by
6491 other applications. (For earlier DB versions, DB_HASH is always used.)
6492 .next
6493 .cindex "lookup" "dbmjz"
6494 .cindex "lookup" "dbm &-- embedded NULs"
6495 .cindex "sasldb2"
6496 .cindex "dbmjz lookup type"
6497 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6498 interpreted as an Exim list; the elements of the list are joined together with
6499 ASCII NUL characters to form the lookup key.  An example usage would be to
6500 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6501 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6502 &(cram_md5)& authenticator.
6503 .next
6504 .cindex "lookup" "dbmnz"
6505 .cindex "lookup" "dbm &-- terminating zero"
6506 .cindex "binary zero" "in lookup key"
6507 .cindex "Courier"
6508 .cindex "&_/etc/userdbshadow.dat_&"
6509 .cindex "dbmnz lookup type"
6510 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6511 is not included in the key that is passed to the DBM library. You may need this
6512 if you want to look up data in files that are created by or shared with some
6513 other application that does not use terminating zeros. For example, you need to
6514 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6515 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6516 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6517 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6518 .next
6519 .cindex "lookup" "dsearch"
6520 .cindex "dsearch lookup type"
6521 &(dsearch)&: The given file must be a directory; this is searched for an entry
6522 whose name is the key by calling the &[lstat()]& function. The key may not
6523 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6524 the lookup is the name of the entry, which may be a file, directory,
6525 symbolic link, or any other kind of directory entry. An example of how this
6526 lookup can be used to support virtual domains is given in section
6527 &<<SECTvirtualdomains>>&.
6528 .next
6529 .cindex "lookup" "iplsearch"
6530 .cindex "iplsearch lookup type"
6531 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6532 terminated by a colon or white space or the end of the line. The keys in the
6533 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6534 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6535 being interpreted as a key terminator. For example:
6536 .code
6537 1.2.3.4:           data for 1.2.3.4
6538 192.168.0.0/16:    data for 192.168.0.0/16
6539 "abcd::cdab":      data for abcd::cdab
6540 "abcd:abcd::/32"   data for abcd:abcd::/32
6541 .endd
6542 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6543 file is searched linearly, using the CIDR masks where present, until a matching
6544 key is found. The first key that matches is used; there is no attempt to find a
6545 &"best"& match. Apart from the way the keys are matched, the processing for
6546 &(iplsearch)& is the same as for &(lsearch)&.
6547
6548 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6549 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6550 lookup types support only literal keys.
6551
6552 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6553 the implicit key is the host's IP address rather than its name (see section
6554 &<<SECThoslispatsikey>>&).
6555 .next
6556 .cindex "linear search"
6557 .cindex "lookup" "lsearch"
6558 .cindex "lsearch lookup type"
6559 .cindex "case sensitivity" "in lsearch lookup"
6560 &(lsearch)&: The given file is a text file that is searched linearly for a
6561 line beginning with the search key, terminated by a colon or white space or the
6562 end of the line. The search is case-insensitive; that is, upper and lower case
6563 letters are treated as the same. The first occurrence of the key that is found
6564 in the file is used.
6565
6566 White space between the key and the colon is permitted. The remainder of the
6567 line, with leading and trailing white space removed, is the data. This can be
6568 continued onto subsequent lines by starting them with any amount of white
6569 space, but only a single space character is included in the data at such a
6570 junction. If the data begins with a colon, the key must be terminated by a
6571 colon, for example:
6572 .code
6573 baduser:  :fail:
6574 .endd
6575 Empty lines and lines beginning with # are ignored, even if they occur in the
6576 middle of an item. This is the traditional textual format of alias files. Note
6577 that the keys in an &(lsearch)& file are literal strings. There is no
6578 wildcarding of any kind.
6579
6580 .cindex "lookup" "lsearch &-- colons in keys"
6581 .cindex "white space" "in lsearch key"
6582 In most &(lsearch)& files, keys are not required to contain colons or #
6583 characters, or white space. However, if you need this feature, it is available.
6584 If a key begins with a doublequote character, it is terminated only by a
6585 matching quote (or end of line), and the normal escaping rules apply to its
6586 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6587 quoted keys (exactly as for unquoted keys). There is no special handling of
6588 quotes for the data part of an &(lsearch)& line.
6589
6590 .next
6591 .cindex "NIS lookup type"
6592 .cindex "lookup" "NIS"
6593 .cindex "binary zero" "in lookup key"
6594 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6595 the given key, without a terminating binary zero. There is a variant called
6596 &(nis0)& which does include the terminating binary zero in the key. This is
6597 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6598 aliases; the full map names must be used.
6599
6600 .next
6601 .cindex "wildlsearch lookup type"
6602 .cindex "lookup" "wildlsearch"
6603 .cindex "nwildlsearch lookup type"
6604 .cindex "lookup" "nwildlsearch"
6605 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6606 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6607 the file may be wildcarded. The difference between these two lookup types is
6608 that for &(wildlsearch)&, each key in the file is string-expanded before being
6609 used, whereas for &(nwildlsearch)&, no expansion takes place.
6610
6611 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6612 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6613 file that are regular expressions can be made case-sensitive by the use of
6614 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6615
6616 . ==== As this is a nested list, any displays it contains must be indented
6617 . ==== as otherwise they are too far to the left.
6618
6619 .olist
6620 The string may begin with an asterisk to mean &"ends with"&. For example:
6621 .code
6622     *.a.b.c       data for anything.a.b.c
6623     *fish         data for anythingfish
6624 .endd
6625 .next
6626 The string may begin with a circumflex to indicate a regular expression. For
6627 example, for &(wildlsearch)&:
6628 .code
6629     ^\N\d+\.a\.b\N    data for <digits>.a.b
6630 .endd
6631 Note the use of &`\N`& to disable expansion of the contents of the regular
6632 expression. If you are using &(nwildlsearch)&, where the keys are not
6633 string-expanded, the equivalent entry is:
6634 .code
6635     ^\d+\.a\.b        data for <digits>.a.b
6636 .endd
6637 The case-insensitive flag is set at the start of compiling the regular
6638 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6639 For example, to make the entire pattern case-sensitive:
6640 .code
6641     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6642 .endd
6643
6644 If the regular expression contains white space or colon characters, you must
6645 either quote it (see &(lsearch)& above), or represent these characters in other
6646 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6647 colon. This may be easier than quoting, because if you quote, you have to
6648 escape all the backslashes inside the quotes.
6649
6650 &*Note*&: It is not possible to capture substrings in a regular expression
6651 match for later use, because the results of all lookups are cached. If a lookup
6652 is repeated, the result is taken from the cache, and no actual pattern matching
6653 takes place. The values of all the numeric variables are unset after a
6654 &((n)wildlsearch)& match.
6655
6656 .next
6657 Although I cannot see it being of much use, the general matching function that
6658 is used to implement &((n)wildlsearch)& means that the string may begin with a
6659 lookup name terminated by a semicolon, and followed by lookup data. For
6660 example:
6661 .code
6662     cdb;/some/file  data for keys that match the file
6663 .endd
6664 The data that is obtained from the nested lookup is discarded.
6665 .endlist olist
6666
6667 Keys that do not match any of these patterns are interpreted literally. The
6668 continuation rules for the data are the same as for &(lsearch)&, and keys may
6669 be followed by optional colons.
6670
6671 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6672 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6673 lookup types support only literal keys.
6674 .endlist ilist
6675
6676
6677 .section "Query-style lookup types" "SECTquerystylelookups"
6678 .cindex "lookup" "query-style types"
6679 .cindex "query-style lookup" "list of types"
6680 The supported query-style lookup types are listed below. Further details about
6681 many of them are given in later sections.
6682
6683 .ilist
6684 .cindex "DNS" "as a lookup type"
6685 .cindex "lookup" "DNS"
6686 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6687 are given in the supplied query. The resulting data is the contents of the
6688 records. See section &<<SECTdnsdb>>&.
6689 .next
6690 .cindex "InterBase lookup type"
6691 .cindex "lookup" "InterBase"
6692 &(ibase)&: This does a lookup in an InterBase database.
6693 .next
6694 .cindex "LDAP" "lookup type"
6695 .cindex "lookup" "LDAP"
6696 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6697 returns attributes from a single entry. There is a variant called &(ldapm)&
6698 that permits values from multiple entries to be returned. A third variant
6699 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6700 any attribute values. See section &<<SECTldap>>&.
6701 .next
6702 .cindex "MySQL" "lookup type"
6703 .cindex "lookup" "MySQL"
6704 &(mysql)&: The format of the query is an SQL statement that is passed to a
6705 MySQL database. See section &<<SECTsql>>&.
6706 .next
6707 .cindex "NIS+ lookup type"
6708 .cindex "lookup" "NIS+"
6709 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6710 the field to be returned. See section &<<SECTnisplus>>&.
6711 .next
6712 .cindex "Oracle" "lookup type"
6713 .cindex "lookup" "Oracle"
6714 &(oracle)&: The format of the query is an SQL statement that is passed to an
6715 Oracle database. See section &<<SECTsql>>&.
6716 .next
6717 .cindex "lookup" "passwd"
6718 .cindex "passwd lookup type"
6719 .cindex "&_/etc/passwd_&"
6720 &(passwd)& is a query-style lookup with queries that are just user names. The
6721 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6722 success, the result string is the same as you would get from an &(lsearch)&
6723 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6724 password value. For example:
6725 .code
6726 *:42:42:King Rat:/home/kr:/bin/bash
6727 .endd
6728 .next
6729 .cindex "PostgreSQL lookup type"
6730 .cindex "lookup" "PostgreSQL"
6731 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6732 PostgreSQL database. See section &<<SECTsql>>&.
6733
6734 .next
6735 .cindex "Redis lookup type"
6736 .cindex lookup Redis
6737 &(redis)&: The format of the query is an SQL statement that is passed to a
6738 Redis database. See section &<<SECTsql>>&.
6739
6740 .next
6741 .cindex "sqlite lookup type"
6742 .cindex "lookup" "sqlite"
6743 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6744 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6745
6746 .next
6747 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6748 not likely to be useful in normal operation.
6749 .next
6750 .cindex "whoson lookup type"
6751 .cindex "lookup" "whoson"
6752 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6753 allows a server to check whether a particular (dynamically allocated) IP
6754 address is currently allocated to a known (trusted) user and, optionally, to
6755 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6756 at one time for &"POP before SMTP"& authentication, but that approach has been
6757 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6758 &"POP before SMTP"& checking using ACL statements such as
6759 .code
6760 require condition = \
6761   ${lookup whoson {$sender_host_address}{yes}{no}}
6762 .endd
6763 The query consists of a single IP address. The value returned is the name of
6764 the authenticated user, which is stored in the variable &$value$&. However, in
6765 this example, the data in &$value$& is not used; the result of the lookup is
6766 one of the fixed strings &"yes"& or &"no"&.
6767 .endlist
6768
6769
6770
6771 .section "Temporary errors in lookups" "SECID63"
6772 .cindex "lookup" "temporary error in"
6773 Lookup functions can return temporary error codes if the lookup cannot be
6774 completed. For example, an SQL or LDAP database might be unavailable. For this
6775 reason, it is not advisable to use a lookup that might do this for critical
6776 options such as a list of local domains.
6777
6778 When a lookup cannot be completed in a router or transport, delivery
6779 of the message (to the relevant address) is deferred, as for any other
6780 temporary error. In other circumstances Exim may assume the lookup has failed,
6781 or may give up altogether.
6782
6783
6784
6785 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6786 .cindex "wildcard lookups"
6787 .cindex "lookup" "default values"
6788 .cindex "lookup" "wildcard"
6789 .cindex "lookup" "* added to type"
6790 .cindex "default" "in single-key lookups"
6791 In this context, a &"default value"& is a value specified by the administrator
6792 that is to be used if a lookup fails.
6793
6794 &*Note:*& This section applies only to single-key lookups. For query-style
6795 lookups, the facilities of the query language must be used. An attempt to
6796 specify a default for a query-style lookup provokes an error.
6797
6798 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6799 and the initial lookup fails, the key &"*"& is looked up in the file to
6800 provide a default value. See also the section on partial matching below.
6801
6802 .cindex "*@ with single-key lookup"
6803 .cindex "lookup" "*@ added to type"
6804 .cindex "alias file" "per-domain default"
6805 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6806 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6807 character, a second lookup is done with everything before the last @ replaced
6808 by *. This makes it possible to provide per-domain defaults in alias files
6809 that include the domains in the keys. If the second lookup fails (or doesn't
6810 take place because there is no @ in the key), &"*"& is looked up.
6811 For example, a &(redirect)& router might contain:
6812 .code
6813 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6814 .endd
6815 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6816 looks up these keys, in this order:
6817 .code
6818 jane@eyre.example
6819 *@eyre.example
6820 *
6821 .endd
6822 The data is taken from whichever key it finds first. &*Note*&: In an
6823 &(lsearch)& file, this does not mean the first of these keys in the file. A
6824 complete scan is done for each key, and only if it is not found at all does
6825 Exim move on to try the next key.
6826
6827
6828
6829 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6830 .cindex "partial matching"
6831 .cindex "wildcard lookups"
6832 .cindex "lookup" "partial matching"
6833 .cindex "lookup" "wildcard"
6834 .cindex "asterisk" "in search type"
6835 The normal operation of a single-key lookup is to search the file for an exact
6836 match with the given key. However, in a number of situations where domains are
6837 being looked up, it is useful to be able to do partial matching. In this case,
6838 information in the file that has a key starting with &"*."& is matched by any
6839 domain that ends with the components that follow the full stop. For example, if
6840 a key in a DBM file is
6841 .code
6842 *.dates.fict.example
6843 .endd
6844 then when partial matching is enabled this is matched by (amongst others)
6845 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6846 by &'dates.fict.example'&, if that does not appear as a separate key in the
6847 file.
6848
6849 &*Note*&: Partial matching is not available for query-style lookups. It is
6850 also not available for any lookup items in address lists (see section
6851 &<<SECTaddresslist>>&).
6852
6853 Partial matching is implemented by doing a series of separate lookups using
6854 keys constructed by modifying the original subject key. This means that it can
6855 be used with any of the single-key lookup types, provided that
6856 partial matching keys
6857 beginning with a special prefix (default &"*."&) are included in the data file.
6858 Keys in the file that do not begin with the prefix are matched only by
6859 unmodified subject keys when partial matching is in use.
6860
6861 Partial matching is requested by adding the string &"partial-"& to the front of
6862 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6863 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6864 is added at the start of the subject key, and it is looked up again. If that
6865 fails, further lookups are tried with dot-separated components removed from the
6866 start of the subject key, one-by-one, and &"*."& added on the front of what
6867 remains.
6868
6869 A minimum number of two non-* components are required. This can be adjusted
6870 by including a number before the hyphen in the search type. For example,
6871 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6872 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6873 subject key is &'2250.dates.fict.example'& then the following keys are looked
6874 up when the minimum number of non-* components is two:
6875 .code
6876 2250.dates.fict.example
6877 *.2250.dates.fict.example
6878 *.dates.fict.example
6879 *.fict.example
6880 .endd
6881 As soon as one key in the sequence is successfully looked up, the lookup
6882 finishes.
6883
6884 .cindex "lookup" "partial matching &-- changing prefix"
6885 .cindex "prefix" "for partial matching"
6886 The use of &"*."& as the partial matching prefix is a default that can be
6887 changed. The motivation for this feature is to allow Exim to operate with file
6888 formats that are used by other MTAs. A different prefix can be supplied in
6889 parentheses instead of the hyphen after &"partial"&. For example:
6890 .code
6891 domains = partial(.)lsearch;/some/file
6892 .endd
6893 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6894 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6895 components is unchanged). The prefix may consist of any punctuation characters
6896 other than a closing parenthesis. It may be empty, for example:
6897 .code
6898 domains = partial1()cdb;/some/file
6899 .endd
6900 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6901 &`a.b.c`&, &`b.c`&, and &`c`&.
6902
6903 If &"partial0"& is specified, what happens at the end (when the lookup with
6904 just one non-wild component has failed, and the original key is shortened right
6905 down to the null string) depends on the prefix:
6906
6907 .ilist
6908 If the prefix has zero length, the whole lookup fails.
6909 .next
6910 If the prefix has length 1, a lookup for just the prefix is done. For
6911 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6912 .next
6913 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6914 remainder is looked up. With the default prefix, therefore, the final lookup is
6915 for &"*"& on its own.
6916 .next
6917 Otherwise, the whole prefix is looked up.
6918 .endlist
6919
6920
6921 If the search type ends in &"*"& or &"*@"& (see section
6922 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6923 this implies happens after all partial lookups have failed. If &"partial0"& is
6924 specified, adding &"*"& to the search type has no effect with the default
6925 prefix, because the &"*"& key is already included in the sequence of partial
6926 lookups. However, there might be a use for lookup types such as
6927 &"partial0(.)lsearch*"&.
6928
6929 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6930 in domain lists and the like. Partial matching works only in terms of
6931 dot-separated components; a key such as &`*fict.example`&
6932 in a database file is useless, because the asterisk in a partial matching
6933 subject key is always followed by a dot.
6934
6935
6936
6937
6938 .section "Lookup caching" "SECID64"
6939 .cindex "lookup" "caching"
6940 .cindex "caching" "lookup data"
6941 Exim caches all lookup results in order to avoid needless repetition of
6942 lookups. However, because (apart from the daemon) Exim operates as a collection
6943 of independent, short-lived processes, this caching applies only within a
6944 single Exim process. There is no inter-process lookup caching facility.
6945
6946 For single-key lookups, Exim keeps the relevant files open in case there is
6947 another lookup that needs them. In some types of configuration this can lead to
6948 many files being kept open for messages with many recipients. To avoid hitting
6949 the operating system limit on the number of simultaneously open files, Exim
6950 closes the least recently used file when it needs to open more files than its
6951 own internal limit, which can be changed via the &%lookup_open_max%& option.
6952
6953 The single-key lookup files are closed and the lookup caches are flushed at
6954 strategic points during delivery &-- for example, after all routing is
6955 complete.
6956
6957
6958
6959
6960 .section "Quoting lookup data" "SECID65"
6961 .cindex "lookup" "quoting"
6962 .cindex "quoting" "in lookups"
6963 When data from an incoming message is included in a query-style lookup, there
6964 is the possibility of special characters in the data messing up the syntax of
6965 the query. For example, a NIS+ query that contains
6966 .code
6967 [name=$local_part]
6968 .endd
6969 will be broken if the local part happens to contain a closing square bracket.
6970 For NIS+, data can be enclosed in double quotes like this:
6971 .code
6972 [name="$local_part"]
6973 .endd
6974 but this still leaves the problem of a double quote in the data. The rule for
6975 NIS+ is that double quotes must be doubled. Other lookup types have different
6976 rules, and to cope with the differing requirements, an expansion operator
6977 of the following form is provided:
6978 .code
6979 ${quote_<lookup-type>:<string>}
6980 .endd
6981 For example, the safest way to write the NIS+ query is
6982 .code
6983 [name="${quote_nisplus:$local_part}"]
6984 .endd
6985 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6986 operator can be used for all lookup types, but has no effect for single-key
6987 lookups, since no quoting is ever needed in their key strings.
6988
6989
6990
6991
6992 .section "More about dnsdb" "SECTdnsdb"
6993 .cindex "dnsdb lookup"
6994 .cindex "lookup" "dnsdb"
6995 .cindex "DNS" "as a lookup type"
6996 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6997 of a record type and a domain name, separated by an equals sign. For example,
6998 an expansion string could contain:
6999 .code
7000 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7001 .endd
7002 If the lookup succeeds, the result is placed in &$value$&, which in this case
7003 is used on its own as the result. If the lookup does not succeed, the
7004 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7005 &<<SECTforexpfai>>& for an explanation of what this means.
7006
7007 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7008 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7009 If no type is given, TXT is assumed.
7010
7011 For any record type, if multiple records are found, the data is returned as a
7012 concatenation, with newline as the default separator. The order, of course,
7013 depends on the DNS resolver. You can specify a different separator character
7014 between multiple records by putting a right angle-bracket followed immediately
7015 by the new separator at the start of the query. For example:
7016 .code
7017 ${lookup dnsdb{>: a=host1.example}}
7018 .endd
7019 It is permitted to specify a space as the separator character. Further
7020 white space is ignored.
7021 For lookup types that return multiple fields per record,
7022 an alternate field separator can be specified using a comma after the main
7023 separator character, followed immediately by the field separator.
7024
7025 .cindex "PTR record" "in &(dnsdb)& lookup"
7026 When the type is PTR,
7027 the data can be an IP address, written as normal; inversion and the addition of
7028 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7029 .code
7030 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7031 .endd
7032 If the data for a PTR record is not a syntactically valid IP address, it is not
7033 altered and nothing is added.
7034
7035 .cindex "MX record" "in &(dnsdb)& lookup"
7036 .cindex "SRV record" "in &(dnsdb)& lookup"
7037 For an MX lookup, both the preference value and the host name are returned for
7038 each record, separated by a space. For an SRV lookup, the priority, weight,
7039 port, and host name are returned for each record, separated by spaces.
7040 The field separator can be modified as above.
7041
7042 .cindex "TXT record" "in &(dnsdb)& lookup"
7043 .cindex "SPF record" "in &(dnsdb)& lookup"
7044 For TXT records with multiple items of data, only the first item is returned,
7045 unless a field separator is specified.
7046 To concatenate items without a separator, use a semicolon instead.
7047 For SPF records the
7048 default behaviour is to concatenate multiple items without using a separator.
7049 .code
7050 ${lookup dnsdb{>\n,: txt=a.b.example}}
7051 ${lookup dnsdb{>\n; txt=a.b.example}}
7052 ${lookup dnsdb{spf=example.org}}
7053 .endd
7054 It is permitted to specify a space as the separator character. Further
7055 white space is ignored.
7056
7057 .cindex "SOA record" "in &(dnsdb)& lookup"
7058 For an SOA lookup, while no result is obtained the lookup is redone with
7059 successively more leading components dropped from the given domain.
7060 Only the primary-nameserver field is returned unless a field separator is
7061 specified.
7062 .code
7063 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7064 .endd
7065
7066 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7067 .cindex "dnsdb modifiers"
7068 .cindex "modifiers" "dnsdb"
7069 .cindex "options" "dnsdb"
7070 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7071 each followed by a comma,
7072 that may appear before the record type.
7073
7074 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7075 temporary DNS error for any of them, the behaviour is controlled by
7076 a defer-option modifier.
7077 The possible keywords are
7078 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7079 With &"strict"& behaviour, any temporary DNS error causes the
7080 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7081 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7082 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7083 error causes the whole lookup to defer only if none of the other lookups
7084 succeed. The default is &"lax"&, so the following lookups are equivalent:
7085 .code
7086 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7087 ${lookup dnsdb{a=one.host.com:two.host.com}}
7088 .endd
7089 Thus, in the default case, as long as at least one of the DNS lookups
7090 yields some data, the lookup succeeds.
7091
7092 .cindex "DNSSEC" "dns lookup"
7093 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7094 The possible keywords are
7095 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7096 With &"strict"& or &"lax"& DNSSEC information is requested
7097 with the lookup.
7098 With &"strict"& a response from the DNS resolver that
7099 is not labelled as authenticated data
7100 is treated as equivalent to a temporary DNS error.
7101 The default is &"never"&.
7102
7103 See also the &$lookup_dnssec_authenticated$& variable.
7104
7105 .cindex timeout "dns lookup"
7106 .cindex "DNS" timeout
7107 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7108 The form is &"retrans_VAL"& where VAL is an Exim time specification
7109 (e.g. &"5s"&).
7110 The default value is set by the main configuration option &%dns_retrans%&.
7111
7112 Retries for the dnsdb lookup can be controlled by a retry modifier.
7113 The form if &"retry_VAL"& where VAL is an integer.
7114 The default count is set by the main configuration option &%dns_retry%&.
7115
7116 .cindex cacheing "of dns lookup"
7117 .cindex TTL "of dns lookup"
7118 .cindex DNS TTL
7119 Dnsdb lookup results are cached within a single process (and its children).
7120 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7121 value of the set of returned DNS records.
7122
7123
7124 .section "Pseudo dnsdb record types" "SECID66"
7125 .cindex "MX record" "in &(dnsdb)& lookup"
7126 By default, both the preference value and the host name are returned for
7127 each MX record, separated by a space. If you want only host names, you can use
7128 the pseudo-type MXH:
7129 .code
7130 ${lookup dnsdb{mxh=a.b.example}}
7131 .endd
7132 In this case, the preference values are omitted, and just the host names are
7133 returned.
7134
7135 .cindex "name server for enclosing domain"
7136 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7137 records on the given domain, but if none are found, it removes the first
7138 component of the domain name, and tries again. This process continues until NS
7139 records are found or there are no more components left (or there is a DNS
7140 error). In other words, it may return the name servers for a top-level domain,
7141 but it never returns the root name servers. If there are no NS records for the
7142 top-level domain, the lookup fails. Consider these examples:
7143 .code
7144 ${lookup dnsdb{zns=xxx.quercite.com}}
7145 ${lookup dnsdb{zns=xxx.edu}}
7146 .endd
7147 Assuming that in each case there are no NS records for the full domain name,
7148 the first returns the name servers for &%quercite.com%&, and the second returns
7149 the name servers for &%edu%&.
7150
7151 You should be careful about how you use this lookup because, unless the
7152 top-level domain does not exist, the lookup always returns some host names. The
7153 sort of use to which this might be put is for seeing if the name servers for a
7154 given domain are on a blacklist. You can probably assume that the name servers
7155 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7156 such a list.
7157
7158 .cindex "CSA" "in &(dnsdb)& lookup"
7159 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7160 records according to the CSA rules, which are described in section
7161 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7162 not sufficient because of the extra parent domain search behaviour of CSA. The
7163 result of a successful lookup such as:
7164 .code
7165 ${lookup dnsdb {csa=$sender_helo_name}}
7166 .endd
7167 has two space-separated fields: an authorization code and a target host name.
7168 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7169 authorization required but absent, or &"?"& for unknown.
7170
7171 .cindex "A+" "in &(dnsdb)& lookup"
7172 The pseudo-type A+ performs an AAAA
7173 and then an A lookup.  All results are returned; defer processing
7174 (see below) is handled separately for each lookup.  Example:
7175 .code
7176 ${lookup dnsdb {>; a+=$sender_helo_name}}
7177 .endd
7178
7179
7180 .section "Multiple dnsdb lookups" "SECID67"
7181 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7182 However, you can specify a list of domains or IP addresses in a single
7183 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7184 the default separator, but with the ability to change this. For example:
7185 .code
7186 ${lookup dnsdb{one.domain.com:two.domain.com}}
7187 ${lookup dnsdb{a=one.host.com:two.host.com}}
7188 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7189 .endd
7190 In order to retain backwards compatibility, there is one special case: if
7191 the lookup type is PTR and no change of separator is specified, Exim looks
7192 to see if the rest of the string is precisely one IPv6 address. In this
7193 case, it does not treat it as a list.
7194
7195 The data from each lookup is concatenated, with newline separators by default,
7196 in the same way that multiple DNS records for a single item are handled. A
7197 different separator can be specified, as described above.
7198
7199
7200
7201
7202 .section "More about LDAP" "SECTldap"
7203 .cindex "LDAP" "lookup, more about"
7204 .cindex "lookup" "LDAP"
7205 .cindex "Solaris" "LDAP"
7206 The original LDAP implementation came from the University of Michigan; this has
7207 become &"Open LDAP"&, and there are now two different releases. Another
7208 implementation comes from Netscape, and Solaris 7 and subsequent releases
7209 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7210 the lookup function level, their error handling is different. For this reason
7211 it is necessary to set a compile-time variable when building Exim with LDAP, to
7212 indicate which LDAP library is in use. One of the following should appear in
7213 your &_Local/Makefile_&:
7214 .code
7215 LDAP_LIB_TYPE=UMICHIGAN
7216 LDAP_LIB_TYPE=OPENLDAP1
7217 LDAP_LIB_TYPE=OPENLDAP2
7218 LDAP_LIB_TYPE=NETSCAPE
7219 LDAP_LIB_TYPE=SOLARIS
7220 .endd
7221 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7222 same interface as the University of Michigan version.
7223
7224 There are three LDAP lookup types in Exim. These behave slightly differently in
7225 the way they handle the results of a query:
7226
7227 .ilist
7228 &(ldap)& requires the result to contain just one entry; if there are more, it
7229 gives an error.
7230 .next
7231 &(ldapdn)& also requires the result to contain just one entry, but it is the
7232 Distinguished Name that is returned rather than any attribute values.
7233 .next
7234 &(ldapm)& permits the result to contain more than one entry; the attributes
7235 from all of them are returned.
7236 .endlist
7237
7238
7239 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7240 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7241 the data returned by a successful lookup is described in the next section.
7242 First we explain how LDAP queries are coded.
7243
7244
7245 .section "Format of LDAP queries" "SECTforldaque"
7246 .cindex "LDAP" "query format"
7247 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7248 the configuration of a &(redirect)& router one might have this setting:
7249 .code
7250 data = ${lookup ldap \
7251   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7252   c=UK?mailbox?base?}}
7253 .endd
7254 .cindex "LDAP" "with TLS"
7255 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7256 secure (encrypted) LDAP connections. The second of these ensures that an
7257 encrypted TLS connection is used.
7258
7259 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7260 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7261 See the &%ldap_start_tls%& option.
7262
7263 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7264 controlled. Every part of the TLS configuration can be configured by settings in
7265 &_exim.conf_&. Depending on the version of the client libraries installed on
7266 your system, some of the initialization may have required setting options in
7267 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7268 certificates. This revealed a nuance where the current UID that exim was
7269 running as could affect which config files it read. With Exim 4.83, these
7270 methods become optional, only taking effect if not specifically set in
7271 &_exim.conf_&.
7272
7273
7274 .section "LDAP quoting" "SECID68"
7275 .cindex "LDAP" "quoting"
7276 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7277 and the second because the LDAP query is represented as a URL. Furthermore,
7278 within an LDAP query, two different kinds of quoting are required. For this
7279 reason, there are two different LDAP-specific quoting operators.
7280
7281 The &%quote_ldap%& operator is designed for use on strings that are part of
7282 filter specifications. Conceptually, it first does the following conversions on
7283 the string:
7284 .code
7285 *   =>   \2A
7286 (   =>   \28
7287 )   =>   \29
7288 \   =>   \5C
7289 .endd
7290 in accordance with RFC 2254. The resulting string is then quoted according
7291 to the rules for URLs, that is, all non-alphanumeric characters except
7292 .code
7293 ! $ ' - . _ ( ) * +
7294 .endd
7295 are converted to their hex values, preceded by a percent sign. For example:
7296 .code
7297 ${quote_ldap: a(bc)*, a<yz>; }
7298 .endd
7299 yields
7300 .code
7301 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7302 .endd
7303 Removing the URL quoting, this is (with a leading and a trailing space):
7304 .code
7305 a\28bc\29\2A, a<yz>;
7306 .endd
7307 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7308 base DN specifications in queries. Conceptually, it first converts the string
7309 by inserting a backslash in front of any of the following characters:
7310 .code
7311 , + " \ < > ;
7312 .endd
7313 It also inserts a backslash before any leading spaces or # characters, and
7314 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7315 is then quoted according to the rules for URLs. For example:
7316 .code
7317 ${quote_ldap_dn: a(bc)*, a<yz>; }
7318 .endd
7319 yields
7320 .code
7321 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7322 .endd
7323 Removing the URL quoting, this is (with a trailing space):
7324 .code
7325 \ a(bc)*\, a\<yz\>\;\
7326 .endd
7327 There are some further comments about quoting in the section on LDAP
7328 authentication below.
7329
7330
7331 .section "LDAP connections" "SECID69"
7332 .cindex "LDAP" "connections"
7333 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7334 is in use, via a Unix domain socket. The example given above does not specify
7335 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7336 by starting it with
7337 .code
7338 ldap://<hostname>:<port>/...
7339 .endd
7340 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7341 used. When no server is specified in a query, a list of default servers is
7342 taken from the &%ldap_default_servers%& configuration option. This supplies a
7343 colon-separated list of servers which are tried in turn until one successfully
7344 handles a query, or there is a serious error. Successful handling either
7345 returns the requested data, or indicates that it does not exist. Serious errors
7346 are syntactical, or multiple values when only a single value is expected.
7347 Errors which cause the next server to be tried are connection failures, bind
7348 failures, and timeouts.
7349
7350 For each server name in the list, a port number can be given. The standard way
7351 of specifying a host and port is to use a colon separator (RFC 1738). Because
7352 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7353 doubled. For example
7354 .code
7355 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7356 .endd
7357 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7358 to the LDAP library with no server name, and the library's default (normally
7359 the local host) is used.
7360
7361 If you are using the OpenLDAP library, you can connect to an LDAP server using
7362 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7363 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7364 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7365 not available.
7366
7367 For this type of connection, instead of a host name for the server, a pathname
7368 for the socket is required, and the port number is not relevant. The pathname
7369 can be specified either as an item in &%ldap_default_servers%&, or inline in
7370 the query. In the former case, you can have settings such as
7371 .code
7372 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7373 .endd
7374 When the pathname is given in the query, you have to escape the slashes as
7375 &`%2F`& to fit in with the LDAP URL syntax. For example:
7376 .code
7377 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7378 .endd
7379 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7380 a pathname, it uses the Unix domain socket code, even if the query actually
7381 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7382 socket connection. This behaviour means that you can use a setting of
7383 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7384 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7385 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7386 backup host.
7387
7388 If an explicit &`ldapi`& type is given in a query when a host name is
7389 specified, an error is diagnosed. However, if there are more items in
7390 &%ldap_default_servers%&, they are tried. In other words:
7391
7392 .ilist
7393 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7394 interface.
7395 .next
7396 Using &`ldapi`& with a host name causes an error.
7397 .endlist
7398
7399
7400 Using &`ldapi`& with no host or path in the query, and no setting of
7401 &%ldap_default_servers%&, does whatever the library does by default.
7402
7403
7404
7405 .section "LDAP authentication and control information" "SECID70"
7406 .cindex "LDAP" "authentication"
7407 The LDAP URL syntax provides no way of passing authentication and other control
7408 information to the server. To make this possible, the URL in an LDAP query may
7409 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7410 spaces. If a value contains spaces it must be enclosed in double quotes, and
7411 when double quotes are used, backslash is interpreted in the usual way inside
7412 them. The following names are recognized:
7413 .display
7414 &`DEREFERENCE`&  set the dereferencing parameter
7415 &`NETTIME    `&  set a timeout for a network operation
7416 &`USER       `&  set the DN, for authenticating the LDAP bind
7417 &`PASS       `&  set the password, likewise
7418 &`REFERRALS  `&  set the referrals parameter
7419 &`SERVERS    `&  set alternate server list for this query only
7420 &`SIZE       `&  set the limit for the number of entries returned
7421 &`TIME       `&  set the maximum waiting time for a query
7422 .endd
7423 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7424 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7425 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7426 library from trying to follow referrals issued by the LDAP server.
7427
7428 .cindex LDAP timeout
7429 .cindex timeout "LDAP lookup"
7430 The name CONNECT is an obsolete name for NETTIME, retained for
7431 backwards compatibility. This timeout (specified as a number of seconds) is
7432 enforced from the client end for operations that can be carried out over a
7433 network. Specifically, it applies to network connections and calls to the
7434 &'ldap_result()'& function. If the value is greater than zero, it is used if
7435 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7436 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7437 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7438 Netscape SDK; for OpenLDAP no action is taken.
7439
7440 The TIME parameter (also a number of seconds) is passed to the server to
7441 set a server-side limit on the time taken to complete a search.
7442
7443 The SERVERS parameter allows you to specify an alternate list of ldap servers
7444 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7445 default list of ldap servers, and a single lookup can specify a single ldap
7446 server to use.  But when you need to do a lookup with a list of servers that is
7447 different than the default list (maybe different order, maybe a completely
7448 different set of servers), the SERVERS parameter allows you to specify this
7449 alternate list (colon-separated).
7450
7451 Here is an example of an LDAP query in an Exim lookup that uses some of these
7452 values. This is a single line, folded to fit on the page:
7453 .code
7454 ${lookup ldap
7455   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7456   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7457   {$value}fail}
7458 .endd
7459 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7460 any of the auxiliary data. Exim configuration settings that include lookups
7461 which contain password information should be preceded by &"hide"& to prevent
7462 non-admin users from using the &%-bP%& option to see their values.
7463
7464 The auxiliary data items may be given in any order. The default is no
7465 connection timeout (the system timeout is used), no user or password, no limit
7466 on the number of entries returned, and no time limit on queries.
7467
7468 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7469 removes any URL quoting that it may contain before passing it LDAP. Apparently
7470 some libraries do this for themselves, but some do not. Removing the URL
7471 quoting has two advantages:
7472
7473 .ilist
7474 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7475 DNs as with DNs inside actual queries.
7476 .next
7477 It permits spaces inside USER= DNs.
7478 .endlist
7479
7480 For example, a setting such as
7481 .code
7482 USER=cn=${quote_ldap_dn:$1}
7483 .endd
7484 should work even if &$1$& contains spaces.
7485
7486 Expanded data for the PASS= value should be quoted using the &%quote%&
7487 expansion operator, rather than the LDAP quote operators. The only reason this
7488 field needs quoting is to ensure that it conforms to the Exim syntax, which
7489 does not allow unquoted spaces. For example:
7490 .code
7491 PASS=${quote:$3}
7492 .endd
7493 The LDAP authentication mechanism can be used to check passwords as part of
7494 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7495 &<<CHAPexpand>>&.
7496
7497
7498
7499 .section "Format of data returned by LDAP" "SECID71"
7500 .cindex "LDAP" "returned data formats"
7501 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7502 as a sequence of values, for example
7503 .code
7504 cn=manager,o=University of Cambridge,c=UK
7505 .endd
7506 The &(ldap)& lookup type generates an error if more than one entry matches the
7507 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7508 the result between the data from different entries. It is possible for multiple
7509 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7510 you know that whatever values are returned all came from a single entry in the
7511 directory.
7512
7513 In the common case where you specify a single attribute in your LDAP query, the
7514 result is not quoted, and does not contain the attribute name. If the attribute
7515 has multiple values, they are separated by commas. Any comma that is
7516 part of an attribute's value is doubled.
7517
7518 If you specify multiple attributes, the result contains space-separated, quoted
7519 strings, each preceded by the attribute name and an equals sign. Within the
7520 quotes, the quote character, backslash, and newline are escaped with
7521 backslashes, and commas are used to separate multiple values for the attribute.
7522 Any commas in attribute values are doubled
7523 (permitting treatment of the values as a comma-separated list).
7524 Apart from the escaping, the string within quotes takes the same form as the
7525 output when a single attribute is requested. Specifying no attributes is the
7526 same as specifying all of an entry's attributes.
7527
7528 Here are some examples of the output format. The first line of each pair is an
7529 LDAP query, and the second is the data that is returned. The attribute called
7530 &%attr1%& has two values, one of them with an embedded comma, whereas
7531 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7532 (they have SUP &%attr%& in their schema definitions).
7533
7534 .code
7535 ldap:///o=base?attr1?sub?(uid=fred)
7536 value1.1,value1,,2
7537
7538 ldap:///o=base?attr2?sub?(uid=fred)
7539 value two
7540
7541 ldap:///o=base?attr?sub?(uid=fred)
7542 value1.1,value1,,2,value two
7543
7544 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7545 attr1="value1.1,value1,,2" attr2="value two"
7546
7547 ldap:///o=base??sub?(uid=fred)
7548 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7549 .endd
7550 You can
7551 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7552 results of LDAP lookups.
7553 The &%extract%& operator in string expansions can be used to pick out
7554 individual fields from data that consists of &'key'&=&'value'& pairs.
7555 The &%listextract%& operator should be used to pick out individual values
7556 of attributes, even when only a single value is expected.
7557 The doubling of embedded commas allows you to use the returned data as a
7558 comma separated list (using the "<," syntax for changing the input list separator).
7559
7560
7561
7562
7563 .section "More about NIS+" "SECTnisplus"
7564 .cindex "NIS+ lookup type"
7565 .cindex "lookup" "NIS+"
7566 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7567 and field name. If this is given, the result of a successful query is the
7568 contents of the named field; otherwise the result consists of a concatenation
7569 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7570 values containing spaces are quoted. For example, the query
7571 .code
7572 [name=mg1456],passwd.org_dir
7573 .endd
7574 might return the string
7575 .code
7576 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7577 home=/home/mg1456 shell=/bin/bash shadow=""
7578 .endd
7579 (split over two lines here to fit on the page), whereas
7580 .code
7581 [name=mg1456],passwd.org_dir:gcos
7582 .endd
7583 would just return
7584 .code
7585 Martin Guerre
7586 .endd
7587 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7588 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7589 operator is to double any quote characters within the text.
7590
7591
7592
7593 .section "SQL lookups" "SECTsql"
7594 .cindex "SQL lookup types"
7595 .cindex "MySQL" "lookup type"
7596 .cindex "PostgreSQL lookup type"
7597 .cindex "lookup" "MySQL"
7598 .cindex "lookup" "PostgreSQL"
7599 .cindex "Oracle" "lookup type"
7600 .cindex "lookup" "Oracle"
7601 .cindex "InterBase lookup type"
7602 .cindex "lookup" "InterBase"
7603 .cindex "Redis lookup type"
7604 .cindex lookup Redis
7605 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7606 and SQLite
7607 databases. Queries for these databases contain SQL statements, so an example
7608 might be
7609 .code
7610 ${lookup mysql{select mailbox from users where id='userx'}\
7611   {$value}fail}
7612 .endd
7613 If the result of the query contains more than one field, the data for each
7614 field in the row is returned, preceded by its name, so the result of
7615 .code
7616 ${lookup pgsql{select home,name from users where id='userx'}\
7617   {$value}}
7618 .endd
7619 might be
7620 .code
7621 home=/home/userx name="Mister X"
7622 .endd
7623 Empty values and values containing spaces are double quoted, with embedded
7624 quotes escaped by a backslash. If the result of the query contains just one
7625 field, the value is passed back verbatim, without a field name, for example:
7626 .code
7627 Mister X
7628 .endd
7629 If the result of the query yields more than one row, it is all concatenated,
7630 with a newline between the data for each row.
7631
7632
7633 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7634 .cindex "MySQL" "lookup type"
7635 .cindex "PostgreSQL lookup type"
7636 .cindex "lookup" "MySQL"
7637 .cindex "lookup" "PostgreSQL"
7638 .cindex "Oracle" "lookup type"
7639 .cindex "lookup" "Oracle"
7640 .cindex "InterBase lookup type"
7641 .cindex "lookup" "InterBase"
7642 .cindex "Redis lookup type"
7643 .cindex lookup Redis
7644 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7645 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7646 or &%redis_servers%&
7647 option (as appropriate) must be set to a colon-separated list of server
7648 information.
7649 (For MySQL and PostgreSQL, the global option need not be set if all
7650 queries contain their own server information &-- see section
7651 &<<SECTspeserque>>&.)
7652 For all but Redis
7653 each item in the list is a slash-separated list of four
7654 items: host name, database name, user name, and password. In the case of
7655 Oracle, the host name field is used for the &"service name"&, and the database
7656 name field is not used and should be empty. For example:
7657 .code
7658 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7659 .endd
7660 Because password data is sensitive, you should always precede the setting with
7661 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7662 option. Here is an example where two MySQL servers are listed:
7663 .code
7664 hide mysql_servers = localhost/users/root/secret:\
7665                      otherhost/users/root/othersecret
7666 .endd
7667 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7668 because this is a colon-separated list, the colon has to be doubled. For each
7669 query, these parameter groups are tried in order until a connection is made and
7670 a query is successfully processed. The result of a query may be that no data is
7671 found, but that is still a successful query. In other words, the list of
7672 servers provides a backup facility, not a list of different places to look.
7673
7674 For Redis the global option need not be specified if all queries contain their
7675 own server information &-- see section &<<SECTspeserque>>&.
7676 If specified, the option must be set to a colon-separated list of server
7677 information.
7678 Each item in the list is a slash-separated list of three items:
7679 host, database number, and password.
7680 .olist
7681 The host is required and may be either an IPv4 address and optional
7682 port number (separated by a colon, which needs doubling due to the
7683 higher-level list), or a Unix socket pathname enclosed in parentheses
7684 .next
7685 The database number is optional; if present that number is selected in the backend
7686 .next
7687 The password is optional; if present it is used to authenticate to the backend
7688 .endlist
7689
7690 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7691 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7692 respectively, and the characters single-quote, double-quote, and backslash
7693 itself are escaped with backslashes.
7694
7695 The &%quote_redis%& expansion operator
7696 escapes whitespace and backslash characters with a backslash.
7697
7698 .section "Specifying the server in the query" "SECTspeserque"
7699 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7700 it is possible to specify a list of servers with an individual query. This is
7701 done by starting the query with
7702 .display
7703 &`servers=`&&'server1:server2:server3:...'&&`;`&
7704 .endd
7705 Each item in the list may take one of two forms:
7706 .olist
7707 If it contains no slashes it is assumed to be just a host name. The appropriate
7708 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7709 of the same name, and the remaining parameters (database, user, password) are
7710 taken from there.
7711 .next
7712 If it contains any slashes, it is taken as a complete parameter set.
7713 .endlist
7714 The list of servers is used in exactly the same way as the global list.
7715 Once a connection to a server has happened and a query has been
7716 successfully executed, processing of the lookup ceases.
7717
7718 This feature is intended for use in master/slave situations where updates
7719 are occurring and you want to update the master rather than a slave. If the
7720 master is in the list as a backup for reading, you might have a global setting
7721 like this:
7722 .code
7723 mysql_servers = slave1/db/name/pw:\
7724                 slave2/db/name/pw:\
7725                 master/db/name/pw
7726 .endd
7727 In an updating lookup, you could then write:
7728 .code
7729 ${lookup mysql{servers=master; UPDATE ...} }
7730 .endd
7731 That query would then be sent only to the master server. If, on the other hand,
7732 the master is not to be used for reading, and so is not present in the global
7733 option, you can still update it by a query of this form:
7734 .code
7735 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7736 .endd
7737
7738
7739 .section "Special MySQL features" "SECID73"
7740 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7741 causes a connection to the server on the local host by means of a Unix domain
7742 socket. An alternate socket can be specified in parentheses.
7743 An option group name for MySQL option files can be specified in square brackets;
7744 the default value is &"exim"&.
7745 The full syntax of each item in &%mysql_servers%& is:
7746 .display
7747 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7748   <&'database'&>/<&'user'&>/<&'password'&>
7749 .endd
7750 Any of the four sub-parts of the first field can be omitted. For normal use on
7751 the local host it can be left blank or set to just &"localhost"&.
7752
7753 No database need be supplied &-- but if it is absent here, it must be given in
7754 the queries.
7755
7756 If a MySQL query is issued that does not request any data (an insert, update,
7757 or delete command), the result of the lookup is the number of rows affected.
7758
7759 &*Warning*&: This can be misleading. If an update does not actually change
7760 anything (for example, setting a field to the value it already has), the result
7761 is zero because no rows are affected.
7762
7763
7764 .section "Special PostgreSQL features" "SECID74"
7765 PostgreSQL lookups can also use Unix domain socket connections to the database.
7766 This is usually faster and costs less CPU time than a TCP/IP connection.
7767 However it can be used only if the mail server runs on the same machine as the
7768 database server. A configuration line for PostgreSQL via Unix domain sockets
7769 looks like this:
7770 .code
7771 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7772 .endd
7773 In other words, instead of supplying a host name, a path to the socket is
7774 given. The path name is enclosed in parentheses so that its slashes aren't
7775 visually confused with the delimiters for the other server parameters.
7776
7777 If a PostgreSQL query is issued that does not request any data (an insert,
7778 update, or delete command), the result of the lookup is the number of rows
7779 affected.
7780
7781 .section "More about SQLite" "SECTsqlite"
7782 .cindex "lookup" "SQLite"
7783 .cindex "sqlite lookup type"
7784 SQLite is different to the other SQL lookups because a file name is required in
7785 addition to the SQL query. An SQLite database is a single file, and there is no
7786 daemon as in the other SQL databases. The interface to Exim requires the name
7787 of the file, as an absolute path, to be given at the start of the query. It is
7788 separated from the query by white space. This means that the path name cannot
7789 contain white space. Here is a lookup expansion example:
7790 .code
7791 ${lookup sqlite {/some/thing/sqlitedb \
7792   select name from aliases where id='userx';}}
7793 .endd
7794 In a list, the syntax is similar. For example:
7795 .code
7796 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7797    select * from relays where ip='$sender_host_address';
7798 .endd
7799 The only character affected by the &%quote_sqlite%& operator is a single
7800 quote, which it doubles.
7801
7802 .cindex timeout SQLite
7803 .cindex sqlite "lookup timeout"
7804 The SQLite library handles multiple simultaneous accesses to the database
7805 internally. Multiple readers are permitted, but only one process can
7806 update at once. Attempts to access the database while it is being updated
7807 are rejected after a timeout period, during which the SQLite library
7808 waits for the lock to be released. In Exim, the default timeout is set
7809 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7810 option.
7811 .ecindex IIDfidalo1
7812 .ecindex IIDfidalo2
7813
7814
7815 . ////////////////////////////////////////////////////////////////////////////
7816 . ////////////////////////////////////////////////////////////////////////////
7817
7818 .chapter "Domain, host, address, and local part lists" &&&
7819          "CHAPdomhosaddlists" &&&
7820          "Domain, host, and address lists"
7821 .scindex IIDdohoadli "lists of domains; hosts; etc."
7822 A number of Exim configuration options contain lists of domains, hosts,
7823 email addresses, or local parts. For example, the &%hold_domains%& option
7824 contains a list of domains whose delivery is currently suspended. These lists
7825 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7826 arguments to expansion conditions such as &%match_domain%&.
7827
7828 Each item in one of these lists is a pattern to be matched against a domain,
7829 host, email address, or local part, respectively. In the sections below, the
7830 different types of pattern for each case are described, but first we cover some
7831 general facilities that apply to all four kinds of list.
7832
7833 Note that other parts of Exim use a &'string list'& which does not
7834 support all the complexity available in
7835 domain, host, address and local part lists.
7836
7837
7838
7839 .section "Expansion of lists" "SECTlistexpand"
7840 .cindex "expansion" "of lists"
7841 Each list is expanded as a single string before it is used.
7842
7843 .new
7844 &'Exception: the router headers_remove option, where list-item
7845 splitting is done before string-expansion.'&
7846 .wen
7847
7848 The result of
7849 expansion must be a list, possibly containing empty items, which is split up
7850 into separate items for matching. By default, colon is the separator character,
7851 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7852 &<<SECTempitelis>>& for details of the list syntax; the second of these
7853 discusses the way to specify empty list items.
7854
7855
7856 If the string expansion is forced to fail, Exim behaves as if the item it is
7857 testing (domain, host, address, or local part) is not in the list. Other
7858 expansion failures cause temporary errors.
7859
7860 If an item in a list is a regular expression, backslashes, dollars and possibly
7861 other special characters in the expression must be protected against
7862 misinterpretation by the string expander. The easiest way to do this is to use
7863 the &`\N`& expansion feature to indicate that the contents of the regular
7864 expression should not be expanded. For example, in an ACL you might have:
7865 .code
7866 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7867                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7868 .endd
7869 The first item is a regular expression that is protected from expansion by
7870 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7871 senders based on the receiving domain.
7872
7873
7874
7875
7876 .section "Negated items in lists" "SECID76"
7877 .cindex "list" "negation"
7878 .cindex "negation" "in lists"
7879 Items in a list may be positive or negative. Negative items are indicated by a
7880 leading exclamation mark, which may be followed by optional white space. A list
7881 defines a set of items (domains, etc). When Exim processes one of these lists,
7882 it is trying to find out whether a domain, host, address, or local part
7883 (respectively) is in the set that is defined by the list. It works like this:
7884
7885 The list is scanned from left to right. If a positive item is matched, the
7886 subject that is being checked is in the set; if a negative item is matched, the
7887 subject is not in the set. If the end of the list is reached without the
7888 subject having matched any of the patterns, it is in the set if the last item
7889 was a negative one, but not if it was a positive one. For example, the list in
7890 .code
7891 domainlist relay_to_domains = !a.b.c : *.b.c
7892 .endd
7893 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7894 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7895 list is positive. However, if the setting were
7896 .code
7897 domainlist relay_to_domains = !a.b.c
7898 .endd
7899 then all domains other than &'a.b.c'& would match because the last item in the
7900 list is negative. In other words, a list that ends with a negative item behaves
7901 as if it had an extra item &`:*`& on the end.
7902
7903 Another way of thinking about positive and negative items in lists is to read
7904 the connector as &"or"& after a positive item and as &"and"& after a negative
7905 item.
7906
7907
7908
7909 .section "File names in lists" "SECTfilnamlis"
7910 .cindex "list" "file name in"
7911 If an item in a domain, host, address, or local part list is an absolute file
7912 name (beginning with a slash character), each line of the file is read and
7913 processed as if it were an independent item in the list, except that further
7914 file names are not allowed,
7915 and no expansion of the data from the file takes place.
7916 Empty lines in the file are ignored, and the file may also contain comment
7917 lines:
7918
7919 .ilist
7920 For domain and host lists, if a # character appears anywhere in a line of the
7921 file, it and all following characters are ignored.
7922 .next
7923 Because local parts may legitimately contain # characters, a comment in an
7924 address list or local part list file is recognized only if # is preceded by
7925 white space or the start of the line. For example:
7926 .code
7927 not#comment@x.y.z   # but this is a comment
7928 .endd
7929 .endlist
7930
7931 Putting a file name in a list has the same effect as inserting each line of the
7932 file as an item in the list (blank lines and comments excepted). However, there
7933 is one important difference: the file is read each time the list is processed,
7934 so if its contents vary over time, Exim's behaviour changes.
7935
7936 If a file name is preceded by an exclamation mark, the sense of any match
7937 within the file is inverted. For example, if
7938 .code
7939 hold_domains = !/etc/nohold-domains
7940 .endd
7941 and the file contains the lines
7942 .code
7943 !a.b.c
7944 *.b.c
7945 .endd
7946 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7947 any domain matching &`*.b.c`& is not.
7948
7949
7950
7951 .section "An lsearch file is not an out-of-line list" "SECID77"
7952 As will be described in the sections that follow, lookups can be used in lists
7953 to provide indexed methods of checking list membership. There has been some
7954 confusion about the way &(lsearch)& lookups work in lists. Because
7955 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7956 sometimes thought that it is allowed to contain wild cards and other kinds of
7957 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7958 always fixed strings, just as for any other single-key lookup type.
7959
7960 If you want to use a file to contain wild-card patterns that form part of a
7961 list, just give the file name on its own, without a search type, as described
7962 in the previous section. You could also use the &(wildlsearch)& or
7963 &(nwildlsearch)&, but there is no advantage in doing this.
7964
7965
7966
7967
7968 .section "Named lists" "SECTnamedlists"
7969 .cindex "named lists"
7970 .cindex "list" "named"
7971 A list of domains, hosts, email addresses, or local parts can be given a name
7972 which is then used to refer to the list elsewhere in the configuration. This is
7973 particularly convenient if the same list is required in several different
7974 places. It also allows lists to be given meaningful names, which can improve
7975 the readability of the configuration. For example, it is conventional to define
7976 a domain list called &'local_domains'& for all the domains that are handled
7977 locally on a host, using a configuration line such as
7978 .code
7979 domainlist local_domains = localhost:my.dom.example
7980 .endd
7981 Named lists are referenced by giving their name preceded by a plus sign, so,
7982 for example, a router that is intended to handle local domains would be
7983 configured with the line
7984 .code
7985 domains = +local_domains
7986 .endd
7987 The first router in a configuration is often one that handles all domains
7988 except the local ones, using a configuration with a negated item like this:
7989 .code
7990 dnslookup:
7991   driver = dnslookup
7992   domains = ! +local_domains
7993   transport = remote_smtp
7994   no_more
7995 .endd
7996 The four kinds of named list are created by configuration lines starting with
7997 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7998 respectively. Then there follows the name that you are defining, followed by an
7999 equals sign and the list itself. For example:
8000 .code
8001 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8002 addresslist bad_senders = cdb;/etc/badsenders
8003 .endd
8004 A named list may refer to other named lists:
8005 .code
8006 domainlist  dom1 = first.example : second.example
8007 domainlist  dom2 = +dom1 : third.example
8008 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8009 .endd
8010 &*Warning*&: If the last item in a referenced list is a negative one, the
8011 effect may not be what you intended, because the negation does not propagate
8012 out to the higher level. For example, consider:
8013 .code
8014 domainlist  dom1 = !a.b
8015 domainlist  dom2 = +dom1 : *.b
8016 .endd
8017 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8018 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8019 means it matches the second list as well. The effect is not the same as
8020 .code
8021 domainlist  dom2 = !a.b : *.b
8022 .endd
8023 where &'x.y'& does not match. It's best to avoid negation altogether in
8024 referenced lists if you can.
8025
8026 Named lists may have a performance advantage. When Exim is routing an
8027 address or checking an incoming message, it caches the result of tests on named
8028 lists. So, if you have a setting such as
8029 .code
8030 domains = +local_domains
8031 .endd
8032 on several of your routers
8033 or in several ACL statements,
8034 the actual test is done only for the first one. However, the caching works only
8035 if there are no expansions within the list itself or any sublists that it
8036 references. In other words, caching happens only for lists that are known to be
8037 the same each time they are referenced.
8038
8039 By default, there may be up to 16 named lists of each type. This limit can be
8040 extended by changing a compile-time variable. The use of domain and host lists
8041 is recommended for concepts such as local domains, relay domains, and relay
8042 hosts. The default configuration is set up like this.
8043
8044
8045
8046 .section "Named lists compared with macros" "SECID78"
8047 .cindex "list" "named compared with macro"
8048 .cindex "macro" "compared with named list"
8049 At first sight, named lists might seem to be no different from macros in the
8050 configuration file. However, macros are just textual substitutions. If you
8051 write
8052 .code
8053 ALIST = host1 : host2
8054 auth_advertise_hosts = !ALIST
8055 .endd
8056 it probably won't do what you want, because that is exactly the same as
8057 .code
8058 auth_advertise_hosts = !host1 : host2
8059 .endd
8060 Notice that the second host name is not negated. However, if you use a host
8061 list, and write
8062 .code
8063 hostlist alist = host1 : host2
8064 auth_advertise_hosts = ! +alist
8065 .endd
8066 the negation applies to the whole list, and so that is equivalent to
8067 .code
8068 auth_advertise_hosts = !host1 : !host2
8069 .endd
8070
8071
8072 .section "Named list caching" "SECID79"
8073 .cindex "list" "caching of named"
8074 .cindex "caching" "named lists"
8075 While processing a message, Exim caches the result of checking a named list if
8076 it is sure that the list is the same each time. In practice, this means that
8077 the cache operates only if the list contains no $ characters, which guarantees
8078 that it will not change when it is expanded. Sometimes, however, you may have
8079 an expanded list that you know will be the same each time within a given
8080 message. For example:
8081 .code
8082 domainlist special_domains = \
8083            ${lookup{$sender_host_address}cdb{/some/file}}
8084 .endd
8085 This provides a list of domains that depends only on the sending host's IP
8086 address. If this domain list is referenced a number of times (for example,
8087 in several ACL lines, or in several routers) the result of the check is not
8088 cached by default, because Exim does not know that it is going to be the
8089 same list each time.
8090
8091 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8092 cache the result anyway. For example:
8093 .code
8094 domainlist_cache special_domains = ${lookup{...
8095 .endd
8096 If you do this, you should be absolutely sure that caching is going to do
8097 the right thing in all cases. When in doubt, leave it out.
8098
8099
8100
8101 .section "Domain lists" "SECTdomainlist"
8102 .cindex "domain list" "patterns for"
8103 .cindex "list" "domain list"
8104 Domain lists contain patterns that are to be matched against a mail domain.
8105 The following types of item may appear in domain lists:
8106
8107 .ilist
8108 .cindex "primary host name"
8109 .cindex "host name" "matched in domain list"
8110 .oindex "&%primary_hostname%&"
8111 .cindex "domain list" "matching primary host name"
8112 .cindex "@ in a domain list"
8113 If a pattern consists of a single @ character, it matches the local host name,
8114 as set by the &%primary_hostname%& option (or defaulted). This makes it
8115 possible to use the same configuration file on several different hosts that
8116 differ only in their names.
8117 .next
8118 .cindex "@[] in a domain list"
8119 .cindex "domain list" "matching local IP interfaces"
8120 .cindex "domain literal"
8121 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8122 in square brackets (as in an email address that contains a domain literal), but
8123 only if that IP address is recognized as local for email routing purposes. The
8124 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8125 control which of a host's several IP addresses are treated as local.
8126 In today's Internet, the use of domain literals is controversial.
8127 .next
8128 .cindex "@mx_any"
8129 .cindex "@mx_primary"
8130 .cindex "@mx_secondary"
8131 .cindex "domain list" "matching MX pointers to local host"
8132 If a pattern consists of the string &`@mx_any`& it matches any domain that
8133 has an MX record pointing to the local host or to any host that is listed in
8134 .oindex "&%hosts_treat_as_local%&"
8135 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8136 are similar, except that the first matches only when a primary MX target is the
8137 local host, and the second only when no primary MX target is the local host,
8138 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8139 preference value &-- there may of course be more than one of them.
8140
8141 The MX lookup that takes place when matching a pattern of this type is
8142 performed with the resolver options for widening names turned off. Thus, for
8143 example, a single-component domain will &'not'& be expanded by adding the
8144 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8145 options of the &(dnslookup)& router for a discussion of domain widening.
8146
8147 Sometimes you may want to ignore certain IP addresses when using one of these
8148 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8149 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8150 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8151 on a router). For example:
8152 .code
8153 domains = @mx_any/ignore=127.0.0.1
8154 .endd
8155 This example matches any domain that has an MX record pointing to one of
8156 the local host's IP addresses other than 127.0.0.1.
8157
8158 The list of IP addresses is in fact processed by the same code that processes
8159 host lists, so it may contain CIDR-coded network specifications and it may also
8160 contain negative items.
8161
8162 Because the list of IP addresses is a sublist within a domain list, you have to
8163 be careful about delimiters if there is more than one address. Like any other
8164 list, the default delimiter can be changed. Thus, you might have:
8165 .code
8166 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8167           an.other.domain : ...
8168 .endd
8169 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8170 involved, it is easiest to change the delimiter for the main list as well:
8171 .code
8172 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8173           an.other.domain ? ...
8174 .endd
8175 .next
8176 .cindex "asterisk" "in domain list"
8177 .cindex "domain list" "asterisk in"
8178 .cindex "domain list" "matching &""ends with""&"
8179 If a pattern starts with an asterisk, the remaining characters of the pattern
8180 are compared with the terminating characters of the domain. The use of &"*"& in
8181 domain lists differs from its use in partial matching lookups. In a domain
8182 list, the character following the asterisk need not be a dot, whereas partial
8183 matching works only in terms of dot-separated components. For example, a domain
8184 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8185 &'cipher.key.ex'&.
8186
8187 .next
8188 .cindex "regular expressions" "in domain list"
8189 .cindex "domain list" "matching regular expression"
8190 If a pattern starts with a circumflex character, it is treated as a regular
8191 expression, and matched against the domain using a regular expression matching
8192 function. The circumflex is treated as part of the regular expression.
8193 Email domains are case-independent, so this regular expression match is by
8194 default case-independent, but you can make it case-dependent by starting it
8195 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8196 are given in chapter &<<CHAPregexp>>&.
8197
8198 &*Warning*&: Because domain lists are expanded before being processed, you
8199 must escape any backslash and dollar characters in the regular expression, or
8200 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8201 it is not to be expanded (unless you really do want to build a regular
8202 expression by expansion, of course).
8203 .next
8204 .cindex "lookup" "in domain list"
8205 .cindex "domain list" "matching by lookup"
8206 If a pattern starts with the name of a single-key lookup type followed by a
8207 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8208 must be a file name in a suitable format for the lookup type. For example, for
8209 &"cdb;"& it must be an absolute path:
8210 .code
8211 domains = cdb;/etc/mail/local_domains.cdb
8212 .endd
8213 The appropriate type of lookup is done on the file using the domain name as the
8214 key. In most cases, the data that is looked up is not used; Exim is interested
8215 only in whether or not the key is present in the file. However, when a lookup
8216 is used for the &%domains%& option on a router
8217 or a &%domains%& condition in an ACL statement, the data is preserved in the
8218 &$domain_data$& variable and can be referred to in other router options or
8219 other statements in the same ACL.
8220
8221 .next
8222 Any of the single-key lookup type names may be preceded by
8223 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8224 .code
8225 domains = partial-dbm;/partial/domains
8226 .endd
8227 This causes partial matching logic to be invoked; a description of how this
8228 works is given in section &<<SECTpartiallookup>>&.
8229
8230 .next
8231 .cindex "asterisk" "in lookup type"
8232 Any of the single-key lookup types may be followed by an asterisk. This causes
8233 a default lookup for a key consisting of a single asterisk to be done if the
8234 original lookup fails. This is not a useful feature when using a domain list to
8235 select particular domains (because any domain would match), but it might have
8236 value if the result of the lookup is being used via the &$domain_data$&
8237 expansion variable.
8238 .next
8239 If the pattern starts with the name of a query-style lookup type followed by a
8240 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8241 pattern must be an appropriate query for the lookup type, as described in
8242 chapter &<<CHAPfdlookup>>&. For example:
8243 .code
8244 hold_domains = mysql;select domain from holdlist \
8245   where domain = '${quote_mysql:$domain}';
8246 .endd
8247 In most cases, the data that is looked up is not used (so for an SQL query, for
8248 example, it doesn't matter what field you select). Exim is interested only in
8249 whether or not the query succeeds. However, when a lookup is used for the
8250 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8251 variable and can be referred to in other options.
8252 .next
8253 .cindex "domain list" "matching literal domain name"
8254 If none of the above cases apply, a caseless textual comparison is made
8255 between the pattern and the domain.
8256 .endlist
8257
8258 Here is an example that uses several different kinds of pattern:
8259 .code
8260 domainlist funny_domains = \
8261   @ : \
8262   lib.unseen.edu : \
8263   *.foundation.fict.example : \
8264   \N^[1-2]\d{3}\.fict\.example$\N : \
8265   partial-dbm;/opt/data/penguin/book : \
8266   nis;domains.byname : \
8267   nisplus;[name=$domain,status=local],domains.org_dir
8268 .endd
8269 There are obvious processing trade-offs among the various matching modes. Using
8270 an asterisk is faster than a regular expression, and listing a few names
8271 explicitly probably is too. The use of a file or database lookup is expensive,
8272 but may be the only option if hundreds of names are required. Because the
8273 patterns are tested in order, it makes sense to put the most commonly matched
8274 patterns earlier.
8275
8276
8277
8278 .section "Host lists" "SECThostlist"
8279 .cindex "host list" "patterns in"
8280 .cindex "list" "host list"
8281 Host lists are used to control what remote hosts are allowed to do. For
8282 example, some hosts may be allowed to use the local host as a relay, and some
8283 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8284 two different ways, by name or by IP address. In a host list, some types of
8285 pattern are matched to a host name, and some are matched to an IP address.
8286 You need to be particularly careful with this when single-key lookups are
8287 involved, to ensure that the right value is being used as the key.
8288
8289
8290 .section "Special host list patterns" "SECID80"
8291 .cindex "empty item in hosts list"
8292 .cindex "host list" "empty string in"
8293 If a host list item is the empty string, it matches only when no remote host is
8294 involved. This is the case when a message is being received from a local
8295 process using SMTP on the standard input, that is, when a TCP/IP connection is
8296 not used.
8297
8298 .cindex "asterisk" "in host list"
8299 The special pattern &"*"& in a host list matches any host or no host. Neither
8300 the IP address nor the name is actually inspected.
8301
8302
8303
8304 .section "Host list patterns that match by IP address" "SECThoslispatip"
8305 .cindex "host list" "matching IP addresses"
8306 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8307 the incoming address actually appears in the IPv6 host as
8308 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8309 list, it is converted into a traditional IPv4 address first. (Not all operating
8310 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8311 concerns.)
8312
8313 The following types of pattern in a host list check the remote host by
8314 inspecting its IP address:
8315
8316 .ilist
8317 If the pattern is a plain domain name (not a regular expression, not starting
8318 with *, not a lookup of any kind), Exim calls the operating system function
8319 to find the associated IP address(es). Exim uses the newer
8320 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8321 This typically causes a forward DNS lookup of the name. The result is compared
8322 with the IP address of the subject host.
8323
8324 If there is a temporary problem (such as a DNS timeout) with the host name
8325 lookup, a temporary error occurs. For example, if the list is being used in an
8326 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8327 temporary SMTP error code. If no IP address can be found for the host name,
8328 what happens is described in section &<<SECTbehipnot>>& below.
8329
8330 .next
8331 .cindex "@ in a host list"
8332 If the pattern is &"@"&, the primary host name is substituted and used as a
8333 domain name, as just described.
8334
8335 .next
8336 If the pattern is an IP address, it is matched against the IP address of the
8337 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8338 IPv6 addresses can be given in colon-separated format, but the colons have to
8339 be doubled so as not to be taken as item separators when the default list
8340 separator is used. IPv6 addresses are recognized even when Exim is compiled
8341 without IPv6 support. This means that if they appear in a host list on an
8342 IPv4-only host, Exim will not treat them as host names. They are just addresses
8343 that can never match a client host.
8344
8345 .next
8346 .cindex "@[] in a host list"
8347 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8348 the local host. For example, if the local host is an IPv4 host with one
8349 interface address 10.45.23.56, these two ACL statements have the same effect:
8350 .code
8351 accept hosts = 127.0.0.1 : 10.45.23.56
8352 accept hosts = @[]
8353 .endd
8354 .next
8355 .cindex "CIDR notation"
8356 If the pattern is an IP address followed by a slash and a mask length (for
8357 example 10.11.42.0/24), it is matched against the IP address of the subject
8358 host under the given mask. This allows, an entire network of hosts to be
8359 included (or excluded) by a single item. The mask uses CIDR notation; it
8360 specifies the number of address bits that must match, starting from the most
8361 significant end of the address.
8362
8363 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8364 of a range of addresses. It is the number of bits in the network portion of the
8365 address. The above example specifies a 24-bit netmask, so it matches all 256
8366 addresses in the 10.11.42.0 network. An item such as
8367 .code
8368 192.168.23.236/31
8369 .endd
8370 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8371 32 for an IPv4 address is the same as no mask at all; just a single address
8372 matches.
8373
8374 Here is another example which shows an IPv4 and an IPv6 network:
8375 .code
8376 recipient_unqualified_hosts = 192.168.0.0/16: \
8377                               3ffe::ffff::836f::::/48
8378 .endd
8379 The doubling of list separator characters applies only when these items
8380 appear inline in a host list. It is not required when indirecting via a file.
8381 For example:
8382 .code
8383 recipient_unqualified_hosts = /opt/exim/unqualnets
8384 .endd
8385 could make use of a file containing
8386 .code
8387 172.16.0.0/12
8388 3ffe:ffff:836f::/48
8389 .endd
8390 to have exactly the same effect as the previous example. When listing IPv6
8391 addresses inline, it is usually more convenient to use the facility for
8392 changing separator characters. This list contains the same two networks:
8393 .code
8394 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8395                                  3ffe:ffff:836f::/48
8396 .endd
8397 The separator is changed to semicolon by the leading &"<;"& at the start of the
8398 list.
8399 .endlist
8400
8401
8402
8403 .section "Host list patterns for single-key lookups by host address" &&&
8404          "SECThoslispatsikey"
8405 .cindex "host list" "lookup of IP address"
8406 When a host is to be identified by a single-key lookup of its complete IP
8407 address, the pattern takes this form:
8408 .display
8409 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8410 .endd
8411 For example:
8412 .code
8413 hosts_lookup = net-cdb;/hosts-by-ip.db
8414 .endd
8415 The text form of the IP address of the subject host is used as the lookup key.
8416 IPv6 addresses are converted to an unabbreviated form, using lower case
8417 letters, with dots as separators because colon is the key terminator in
8418 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8419 quoting the keys, but this is a facility that was added later.] The data
8420 returned by the lookup is not used.
8421
8422 .cindex "IP address" "masking"
8423 .cindex "host list" "masked IP address"
8424 Single-key lookups can also be performed using masked IP addresses, using
8425 patterns of this form:
8426 .display
8427 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8428 .endd
8429 For example:
8430 .code
8431 net24-dbm;/networks.db
8432 .endd
8433 The IP address of the subject host is masked using <&'number'&> as the mask
8434 length. A textual string is constructed from the masked value, followed by the
8435 mask, and this is used as the lookup key. For example, if the host's IP address
8436 is 192.168.34.6, the key that is looked up for the above example is
8437 &"192.168.34.0/24"&.
8438
8439 When an IPv6 address is converted to a string, dots are normally used instead
8440 of colons, so that keys in &(lsearch)& files need not contain colons (which
8441 terminate &(lsearch)& keys). This was implemented some time before the ability
8442 to quote keys was made available in &(lsearch)& files. However, the more
8443 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8444 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8445 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8446 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8447 addresses are always used.
8448
8449 Ideally, it would be nice to tidy up this anomalous situation by changing to
8450 colons in all cases, given that quoting is now available for &(lsearch)&.
8451 However, this would be an incompatible change that might break some existing
8452 configurations.
8453
8454 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8455 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8456 the former case the key strings include the mask value, whereas in the latter
8457 case the IP address is used on its own.
8458
8459
8460
8461 .section "Host list patterns that match by host name" "SECThoslispatnam"
8462 .cindex "host" "lookup failures"
8463 .cindex "unknown host name"
8464 .cindex "host list" "matching host name"
8465 There are several types of pattern that require Exim to know the name of the
8466 remote host. These are either wildcard patterns or lookups by name. (If a
8467 complete hostname is given without any wildcarding, it is used to find an IP
8468 address to match against, as described in section &<<SECThoslispatip>>&
8469 above.)
8470
8471 If the remote host name is not already known when Exim encounters one of these
8472 patterns, it has to be found from the IP address.
8473 Although many sites on the Internet are conscientious about maintaining reverse
8474 DNS data for their hosts, there are also many that do not do this.
8475 Consequently, a name cannot always be found, and this may lead to unwanted
8476 effects. Take care when configuring host lists with wildcarded name patterns.
8477 Consider what will happen if a name cannot be found.
8478
8479 Because of the problems of determining host names from IP addresses, matching
8480 against host names is not as common as matching against IP addresses.
8481
8482 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8483 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8484 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8485 are done can be changed by setting the &%host_lookup_order%& option. For
8486 security, once Exim has found one or more names, it looks up the IP addresses
8487 for these names and compares them with the IP address that it started with.
8488 Only those names whose IP addresses match are accepted. Any other names are
8489 discarded. If no names are left, Exim behaves as if the host name cannot be
8490 found. In the most common case there is only one name and one IP address.
8491
8492 There are some options that control what happens if a host name cannot be
8493 found. These are described in section &<<SECTbehipnot>>& below.
8494
8495 .cindex "host" "alias for"
8496 .cindex "alias for host"
8497 As a result of aliasing, hosts may have more than one name. When processing any
8498 of the following types of pattern, all the host's names are checked:
8499
8500 .ilist
8501 .cindex "asterisk" "in host list"
8502 If a pattern starts with &"*"& the remainder of the item must match the end of
8503 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8504 &'.b.c'&. This special simple form is provided because this is a very common
8505 requirement. Other kinds of wildcarding require the use of a regular
8506 expression.
8507 .next
8508 .cindex "regular expressions" "in host list"
8509 .cindex "host list" "regular expression in"
8510 If the item starts with &"^"& it is taken to be a regular expression which is
8511 matched against the host name. Host names are case-independent, so this regular
8512 expression match is by default case-independent, but you can make it
8513 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8514 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8515 example,
8516 .code
8517 ^(a|b)\.c\.d$
8518 .endd
8519 is a regular expression that matches either of the two hosts &'a.c.d'& or
8520 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8521 that backslash and dollar characters are not misinterpreted as part of the
8522 string expansion. The simplest way to do this is to use &`\N`& to mark that
8523 part of the string as non-expandable. For example:
8524 .code
8525 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8526 .endd
8527 &*Warning*&: If you want to match a complete host name, you must include the
8528 &`$`& terminating metacharacter in the regular expression, as in the above
8529 example. Without it, a match at the start of the host name is all that is
8530 required.
8531 .endlist
8532
8533
8534
8535
8536 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8537 .cindex "host" "lookup failures, permanent"
8538 While processing a host list, Exim may need to look up an IP address from a
8539 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8540 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8541 behaviour when it fails to find the information it is seeking is the same.
8542
8543 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8544 apply to temporary DNS errors, whose handling is described in the next section.
8545
8546 .cindex "&`+include_unknown`&"
8547 .cindex "&`+ignore_unknown`&"
8548 Exim parses a host list from left to right. If it encounters a permanent
8549 lookup failure in any item in the host list before it has found a match,
8550 Exim treats it as a failure and the default behavior is as if the host
8551 does not match the list. This may not always be what you want to happen.
8552 To change Exim's behaviour, the special items &`+include_unknown`& or
8553 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8554 not recognized in an indirected file).
8555
8556 .ilist
8557 If any item that follows &`+include_unknown`& requires information that
8558 cannot found, Exim behaves as if the host does match the list. For example,
8559 .code
8560 host_reject_connection = +include_unknown:*.enemy.ex
8561 .endd
8562 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8563 any hosts whose name it cannot find.
8564
8565 .next
8566 If any item that follows &`+ignore_unknown`& requires information that cannot
8567 be found, Exim ignores that item and proceeds to the rest of the list. For
8568 example:
8569 .code
8570 accept hosts = +ignore_unknown : friend.example : \
8571                192.168.4.5
8572 .endd
8573 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8574 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8575 name can be found for 192.168.4.5, it is rejected.
8576 .endlist
8577
8578 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8579 list. The effect of each one lasts until the next, or until the end of the
8580 list.
8581
8582 .section "Mixing wildcarded host names and addresses in host lists" &&&
8583          "SECTmixwilhos"
8584 .cindex "host list" "mixing names and addresses in"
8585
8586 This section explains the host/ip processing logic with the same concepts
8587 as the previous section, but specifically addresses what happens when a
8588 wildcarded hostname is one of the items in the hostlist.
8589
8590 .ilist
8591 If you have name lookups or wildcarded host names and
8592 IP addresses in the same host list, you should normally put the IP
8593 addresses first. For example, in an ACL you could have:
8594 .code
8595 accept hosts = 10.9.8.7 : *.friend.example
8596 .endd
8597 The reason you normally would order it this way lies in the
8598 left-to-right way that Exim processes lists.  It can test IP addresses
8599 without doing any DNS lookups, but when it reaches an item that requires
8600 a host name, it fails if it cannot find a host name to compare with the
8601 pattern. If the above list is given in the opposite order, the
8602 &%accept%& statement fails for a host whose name cannot be found, even
8603 if its IP address is 10.9.8.7.
8604
8605 .next
8606 If you really do want to do the name check first, and still recognize the IP
8607 address, you can rewrite the ACL like this:
8608 .code
8609 accept hosts = *.friend.example
8610 accept hosts = 10.9.8.7
8611 .endd
8612 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8613 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8614 &`+ignore_unknown`&, which was discussed in depth in the first example in
8615 this section.
8616 .endlist
8617
8618
8619 .section "Temporary DNS errors when looking up host information" &&&
8620          "SECTtemdnserr"
8621 .cindex "host" "lookup failures, temporary"
8622 .cindex "&`+include_defer`&"
8623 .cindex "&`+ignore_defer`&"
8624 A temporary DNS lookup failure normally causes a defer action (except when
8625 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8626 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8627 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8628 section. These options should be used with care, probably only in non-critical
8629 host lists such as whitelists.
8630
8631
8632
8633 .section "Host list patterns for single-key lookups by host name" &&&
8634          "SECThoslispatnamsk"
8635 .cindex "unknown host name"
8636 .cindex "host list" "matching host name"
8637 If a pattern is of the form
8638 .display
8639 <&'single-key-search-type'&>;<&'search-data'&>
8640 .endd
8641 for example
8642 .code
8643 dbm;/host/accept/list
8644 .endd
8645 a single-key lookup is performed, using the host name as its key. If the
8646 lookup succeeds, the host matches the item. The actual data that is looked up
8647 is not used.
8648
8649 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8650 keys in the file, not IP addresses. If you want to do lookups based on IP
8651 addresses, you must precede the search type with &"net-"& (see section
8652 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8653 two items in the same list, one doing an address lookup and one doing a name
8654 lookup, both using the same file.
8655
8656
8657
8658 .section "Host list patterns for query-style lookups" "SECID81"
8659 If a pattern is of the form
8660 .display
8661 <&'query-style-search-type'&>;<&'query'&>
8662 .endd
8663 the query is obeyed, and if it succeeds, the host matches the item. The actual
8664 data that is looked up is not used. The variables &$sender_host_address$& and
8665 &$sender_host_name$& can be used in the query. For example:
8666 .code
8667 hosts_lookup = pgsql;\
8668   select ip from hostlist where ip='$sender_host_address'
8669 .endd
8670 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8671 can use the &%sg%& expansion item to change this if you need to. If you want to
8672 use masked IP addresses in database queries, you can use the &%mask%& expansion
8673 operator.
8674
8675 If the query contains a reference to &$sender_host_name$&, Exim automatically
8676 looks up the host name if it has not already done so. (See section
8677 &<<SECThoslispatnam>>& for comments on finding host names.)
8678
8679 Historical note: prior to release 4.30, Exim would always attempt to find a
8680 host name before running the query, unless the search type was preceded by
8681 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8682 still recognized for query-style lookups, but its presence or absence has no
8683 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8684 See section &<<SECThoslispatsikey>>&.)
8685
8686
8687
8688
8689
8690 .section "Address lists" "SECTaddresslist"
8691 .cindex "list" "address list"
8692 .cindex "address list" "empty item"
8693 .cindex "address list" "patterns"
8694 Address lists contain patterns that are matched against mail addresses. There
8695 is one special case to be considered: the sender address of a bounce message is
8696 always empty. You can test for this by providing an empty item in an address
8697 list. For example, you can set up a router to process bounce messages by
8698 using this option setting:
8699 .code
8700 senders = :
8701 .endd
8702 The presence of the colon creates an empty item. If you do not provide any
8703 data, the list is empty and matches nothing. The empty sender can also be
8704 detected by a regular expression that matches an empty string,
8705 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8706
8707 Non-empty items in an address list can be straightforward email addresses. For
8708 example:
8709 .code
8710 senders = jbc@askone.example : hs@anacreon.example
8711 .endd
8712 A certain amount of wildcarding is permitted. If a pattern contains an @
8713 character, but is not a regular expression and does not begin with a
8714 semicolon-terminated lookup type (described below), the local part of the
8715 subject address is compared with the local part of the pattern, which may start
8716 with an asterisk. If the local parts match, the domain is checked in exactly
8717 the same way as for a pattern in a domain list. For example, the domain can be
8718 wildcarded, refer to a named list, or be a lookup:
8719 .code
8720 deny senders = *@*.spamming.site:\
8721                *@+hostile_domains:\
8722                bozo@partial-lsearch;/list/of/dodgy/sites:\
8723                *@dbm;/bad/domains.db
8724 .endd
8725 .cindex "local part" "starting with !"
8726 .cindex "address list" "local part starting with !"
8727 If a local part that begins with an exclamation mark is required, it has to be
8728 specified using a regular expression, because otherwise the exclamation mark is
8729 treated as a sign of negation, as is standard in lists.
8730
8731 If a non-empty pattern that is not a regular expression or a lookup does not
8732 contain an @ character, it is matched against the domain part of the subject
8733 address. The only two formats that are recognized this way are a literal
8734 domain, or a domain pattern that starts with *. In both these cases, the effect
8735 is the same as if &`*@`& preceded the pattern. For example:
8736 .code
8737 deny senders = enemy.domain : *.enemy.domain
8738 .endd
8739
8740 The following kinds of more complicated address list pattern can match any
8741 address, including the empty address that is characteristic of bounce message
8742 senders:
8743
8744 .ilist
8745 .cindex "regular expressions" "in address list"
8746 .cindex "address list" "regular expression in"
8747 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8748 done against the complete address, with the pattern as the regular expression.
8749 You must take care that backslash and dollar characters are not misinterpreted
8750 as part of the string expansion. The simplest way to do this is to use &`\N`&
8751 to mark that part of the string as non-expandable. For example:
8752 .code
8753 deny senders = \N^.*this.*@example\.com$\N : \
8754                \N^\d{8}.+@spamhaus.example$\N : ...
8755 .endd
8756 The &`\N`& sequences are removed by the expansion, so these items do indeed
8757 start with &"^"& by the time they are being interpreted as address patterns.
8758
8759 .next
8760 .cindex "address list" "lookup for complete address"
8761 Complete addresses can be looked up by using a pattern that starts with a
8762 lookup type terminated by a semicolon, followed by the data for the lookup. For
8763 example:
8764 .code
8765 deny senders = cdb;/etc/blocked.senders : \
8766   mysql;select address from blocked where \
8767   address='${quote_mysql:$sender_address}'
8768 .endd
8769 Both query-style and single-key lookup types can be used. For a single-key
8770 lookup type, Exim uses the complete address as the key. However, empty keys are
8771 not supported for single-key lookups, so a match against the empty address
8772 always fails. This restriction does not apply to query-style lookups.
8773
8774 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8775 cannot be used, and is ignored if specified, with an entry being written to the
8776 panic log.
8777 .cindex "*@ with single-key lookup"
8778 However, you can configure lookup defaults, as described in section
8779 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8780 default. For example, with this lookup:
8781 .code
8782 accept senders = lsearch*@;/some/file
8783 .endd
8784 the file could contains lines like this:
8785 .code
8786 user1@domain1.example
8787 *@domain2.example
8788 .endd
8789 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8790 that are tried is:
8791 .code
8792 nimrod@jaeger.example
8793 *@jaeger.example
8794 *
8795 .endd
8796 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8797 would mean that every address matches, thus rendering the test useless.
8798
8799 &*Warning 2*&: Do not confuse these two kinds of item:
8800 .code
8801 deny recipients = dbm*@;/some/file
8802 deny recipients = *@dbm;/some/file
8803 .endd
8804 The first does a whole address lookup, with defaulting, as just described,
8805 because it starts with a lookup type. The second matches the local part and
8806 domain independently, as described in a bullet point below.
8807 .endlist
8808
8809
8810 The following kinds of address list pattern can match only non-empty addresses.
8811 If the subject address is empty, a match against any of these pattern types
8812 always fails.
8813
8814
8815 .ilist
8816 .cindex "@@ with single-key lookup"
8817 .cindex "address list" "@@ lookup type"
8818 .cindex "address list" "split local part and domain"
8819 If a pattern starts with &"@@"& followed by a single-key lookup item
8820 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8821 split into a local part and a domain. The domain is looked up in the file. If
8822 it is not found, there is no match. If it is found, the data that is looked up
8823 from the file is treated as a colon-separated list of local part patterns, each
8824 of which is matched against the subject local part in turn.
8825
8826 .cindex "asterisk" "in address list"
8827 The lookup may be a partial one, and/or one involving a search for a default
8828 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8829 patterns that are looked up can be regular expressions or begin with &"*"&, or
8830 even be further lookups. They may also be independently negated. For example,
8831 with
8832 .code
8833 deny senders = @@dbm;/etc/reject-by-domain
8834 .endd
8835 the data from which the DBM file is built could contain lines like
8836 .code
8837 baddomain.com:  !postmaster : *
8838 .endd
8839 to reject all senders except &%postmaster%& from that domain.
8840
8841 .cindex "local part" "starting with !"
8842 If a local part that actually begins with an exclamation mark is required, it
8843 has to be specified using a regular expression. In &(lsearch)& files, an entry
8844 may be split over several lines by indenting the second and subsequent lines,
8845 but the separating colon must still be included at line breaks. White space
8846 surrounding the colons is ignored. For example:
8847 .code
8848 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8849   spammer3 : spammer4
8850 .endd
8851 As in all colon-separated lists in Exim, a colon can be included in an item by
8852 doubling.
8853
8854 If the last item in the list starts with a right angle-bracket, the remainder
8855 of the item is taken as a new key to look up in order to obtain a continuation
8856 list of local parts. The new key can be any sequence of characters. Thus one
8857 might have entries like
8858 .code
8859 aol.com: spammer1 : spammer 2 : >*
8860 xyz.com: spammer3 : >*
8861 *:       ^\d{8}$
8862 .endd
8863 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8864 local parts for all domains, in addition to the specific local parts listed for
8865 each domain. Of course, using this feature costs another lookup each time a
8866 chain is followed, but the effort needed to maintain the data is reduced.
8867
8868 .cindex "loop" "in lookups"
8869 It is possible to construct loops using this facility, and in order to catch
8870 them, the chains may be no more than fifty items long.
8871
8872 .next
8873 The @@<&'lookup'&> style of item can also be used with a query-style
8874 lookup, but in this case, the chaining facility is not available. The lookup
8875 can only return a single list of local parts.
8876 .endlist
8877
8878 &*Warning*&: There is an important difference between the address list items
8879 in these two examples:
8880 .code
8881 senders = +my_list
8882 senders = *@+my_list
8883 .endd
8884 In the first one, &`my_list`& is a named address list, whereas in the second
8885 example it is a named domain list.
8886
8887
8888
8889
8890 .section "Case of letters in address lists" "SECTcasletadd"
8891 .cindex "case of local parts"
8892 .cindex "address list" "case forcing"
8893 .cindex "case forcing in address lists"
8894 Domains in email addresses are always handled caselessly, but for local parts
8895 case may be significant on some systems (see &%caseful_local_part%& for how
8896 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8897 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8898 blocking lists should be done in a case-independent manner. Since most address
8899 lists in Exim are used for this kind of control, Exim attempts to do this by
8900 default.
8901
8902 The domain portion of an address is always lowercased before matching it to an
8903 address list. The local part is lowercased by default, and any string
8904 comparisons that take place are done caselessly. This means that the data in
8905 the address list itself, in files included as plain file names, and in any file
8906 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8907 keys in files that are looked up by a search type other than &(lsearch)& (which
8908 works caselessly) must be in lower case, because these lookups are not
8909 case-independent.
8910
8911 .cindex "&`+caseful`&"
8912 To allow for the possibility of caseful address list matching, if an item in
8913 an address list is the string &"+caseful"&, the original case of the local
8914 part is restored for any comparisons that follow, and string comparisons are no
8915 longer case-independent. This does not affect the domain, which remains in
8916 lower case. However, although independent matches on the domain alone are still
8917 performed caselessly, regular expressions that match against an entire address
8918 become case-sensitive after &"+caseful"& has been seen.
8919
8920
8921
8922 .section "Local part lists" "SECTlocparlis"
8923 .cindex "list" "local part list"
8924 .cindex "local part" "list"
8925 Case-sensitivity in local part lists is handled in the same way as for address
8926 lists, as just described. The &"+caseful"& item can be used if required. In a
8927 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8928 set false, the subject is lowercased and the matching is initially
8929 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8930 matching in the local part list, but not elsewhere in the router. If
8931 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8932 option is case-sensitive from the start.
8933
8934 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8935 comments are handled in the same way as address lists &-- they are recognized
8936 only if the # is preceded by white space or the start of the line.
8937 Otherwise, local part lists are matched in the same way as domain lists, except
8938 that the special items that refer to the local host (&`@`&, &`@[]`&,
8939 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8940 Refer to section &<<SECTdomainlist>>& for details of the other available item
8941 types.
8942 .ecindex IIDdohoadli
8943
8944
8945
8946
8947 . ////////////////////////////////////////////////////////////////////////////
8948 . ////////////////////////////////////////////////////////////////////////////
8949
8950 .chapter "String expansions" "CHAPexpand"
8951 .scindex IIDstrexp "expansion" "of strings"
8952 Many strings in Exim's run time configuration are expanded before use. Some of
8953 them are expanded every time they are used; others are expanded only once.
8954
8955 When a string is being expanded it is copied verbatim from left to right except
8956 when a dollar or backslash character is encountered. A dollar specifies the
8957 start of a portion of the string that is interpreted and replaced as described
8958 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8959 escape character, as described in the following section.
8960
8961 Whether a string is expanded depends upon the context.  Usually this is solely
8962 dependent upon the option for which a value is sought; in this documentation,
8963 options for which string expansion is performed are marked with &dagger; after
8964 the data type.  ACL rules always expand strings.  A couple of expansion
8965 conditions do not expand some of the brace-delimited branches, for security
8966 reasons.
8967
8968
8969
8970 .section "Literal text in expanded strings" "SECTlittext"
8971 .cindex "expansion" "including literal text"
8972 An uninterpreted dollar can be included in an expanded string by putting a
8973 backslash in front of it. A backslash can be used to prevent any special
8974 character being treated specially in an expansion, including backslash itself.
8975 If the string appears in quotes in the configuration file, two backslashes are
8976 required because the quotes themselves cause interpretation of backslashes when
8977 the string is read in (see section &<<SECTstrings>>&).
8978
8979 .cindex "expansion" "non-expandable substrings"
8980 A portion of the string can specified as non-expandable by placing it between
8981 two occurrences of &`\N`&. This is particularly useful for protecting regular
8982 expressions, which often contain backslashes and dollar signs. For example:
8983 .code
8984 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8985 .endd
8986 On encountering the first &`\N`&, the expander copies subsequent characters
8987 without interpretation until it reaches the next &`\N`& or the end of the
8988 string.
8989
8990
8991
8992 .section "Character escape sequences in expanded strings" "SECID82"
8993 .cindex "expansion" "escape sequences"
8994 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8995 expanded string is recognized as an escape sequence for the character newline,
8996 carriage return, or tab, respectively. A backslash followed by up to three
8997 octal digits is recognized as an octal encoding for a single character, and a
8998 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8999 encoding.
9000
9001 These escape sequences are also recognized in quoted strings when they are read
9002 in. Their interpretation in expansions as well is useful for unquoted strings,
9003 and for other cases such as looked-up strings that are then expanded.
9004
9005
9006 .section "Testing string expansions" "SECID83"
9007 .cindex "expansion" "testing"
9008 .cindex "testing" "string expansion"
9009 .oindex "&%-be%&"
9010 Many expansions can be tested by calling Exim with the &%-be%& option. This
9011 takes the command arguments, or lines from the standard input if there are no
9012 arguments, runs them through the string expansion code, and writes the results
9013 to the standard output. Variables based on configuration values are set up, but
9014 since no message is being processed, variables such as &$local_part$& have no
9015 value. Nevertheless the &%-be%& option can be useful for checking out file and
9016 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9017 and &%nhash%&.
9018
9019 Exim gives up its root privilege when it is called with the &%-be%& option, and
9020 instead runs under the uid and gid it was called with, to prevent users from
9021 using &%-be%& for reading files to which they do not have access.
9022
9023 .oindex "&%-bem%&"
9024 If you want to test expansions that include variables whose values are taken
9025 from a message, there are two other options that can be used. The &%-bem%&
9026 option is like &%-be%& except that it is followed by a file name. The file is
9027 read as a message before doing the test expansions. For example:
9028 .code
9029 exim -bem /tmp/test.message '$h_subject:'
9030 .endd
9031 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9032 Exim message identifier. For example:
9033 .code
9034 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9035 .endd
9036 This loads the message from Exim's spool before doing the test expansions, and
9037 is therefore restricted to admin users.
9038
9039
9040 .section "Forced expansion failure" "SECTforexpfai"
9041 .cindex "expansion" "forced failure"
9042 A number of expansions that are described in the following section have
9043 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9044 (which are sometimes called &"curly brackets"&). Which of the two strings is
9045 used depends on some condition that is evaluated as part of the expansion. If,
9046 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9047 the entire string expansion fails in a way that can be detected by the code
9048 that requested the expansion. This is called &"forced expansion failure"&, and
9049 its consequences depend on the circumstances. In some cases it is no different
9050 from any other expansion failure, but in others a different action may be
9051 taken. Such variations are mentioned in the documentation of the option that is
9052 being expanded.
9053
9054
9055
9056
9057 .section "Expansion items" "SECTexpansionitems"
9058 The following items are recognized in expanded strings. White space may be used
9059 between sub-items that are keywords or substrings enclosed in braces inside an
9060 outer set of braces, to improve readability. &*Warning*&: Within braces,
9061 white space is significant.
9062
9063 .vlist
9064 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9065 .cindex "expansion" "variables"
9066 Substitute the contents of the named variable, for example:
9067 .code
9068 $local_part
9069 ${domain}
9070 .endd
9071 The second form can be used to separate the name from subsequent alphanumeric
9072 characters. This form (using braces) is available only for variables; it does
9073 &'not'& apply to message headers. The names of the variables are given in
9074 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9075 given, the expansion fails.
9076
9077 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9078 .cindex "expansion" "operators"
9079 The string is first itself expanded, and then the operation specified by
9080 <&'op'&> is applied to it. For example:
9081 .code
9082 ${lc:$local_part}
9083 .endd
9084 The string starts with the first character after the colon, which may be
9085 leading white space. A list of operators is given in section &<<SECTexpop>>&
9086 below. The operator notation is used for simple expansion items that have just
9087 one argument, because it reduces the number of braces and therefore makes the
9088 string easier to understand.
9089
9090 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9091 This item inserts &"basic"& header lines. It is described with the &%header%&
9092 expansion item below.
9093
9094
9095 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9096 .cindex "expansion" "calling an acl"
9097 .cindex "&%acl%&" "call from expansion"
9098 The name and zero to nine argument strings are first expanded separately.  The expanded
9099 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9100 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9101 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9102 and may use the variables; if another acl expansion is used the values
9103 are restored after it returns.  If the ACL sets
9104 a value using a "message =" modifier and returns accept or deny, the value becomes
9105 the result of the expansion.
9106 If no message is set and the ACL returns accept or deny
9107 the expansion result is an empty string.
9108 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9109
9110
9111 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9112        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9113 .cindex "expansion" "extracting cerificate fields"
9114 .cindex "&%certextract%&" "certificate fields"
9115 .cindex "certificate" "extracting fields"
9116 The <&'certificate'&> must be a variable of type certificate.
9117 The field name is expanded and used to retrieve the relevant field from
9118 the certificate.  Supported fields are:
9119 .display
9120 &`version        `&
9121 &`serial_number  `&
9122 &`subject        `& RFC4514 DN
9123 &`issuer         `& RFC4514 DN
9124 &`notbefore      `& time
9125 &`notafter       `& time
9126 &`sig_algorithm  `&
9127 &`signature      `&
9128 &`subj_altname   `& tagged list
9129 &`ocsp_uri       `& list
9130 &`crl_uri        `& list
9131 .endd
9132 If the field is found,
9133 <&'string2'&> is expanded, and replaces the whole item;
9134 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9135 variable &$value$& contains the value that has been extracted. Afterwards, it
9136 is restored to any previous value it might have had.
9137
9138 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9139 key is not found. If {<&'string2'&>} is also omitted, the value that was
9140 extracted is used.
9141
9142 Some field names take optional modifiers, appended and separated by commas.
9143
9144 The field selectors marked as "RFC4514" above
9145 output a Distinguished Name string which is
9146 not quite
9147 parseable by Exim as a comma-separated tagged list
9148 (the exceptions being elements containing commas).
9149 RDN elements of a single type may be selected by
9150 a modifier of the type label; if so the expansion
9151 result is a list (newline-separated by default).
9152 The separator may be changed by another modifier of
9153 a right angle-bracket followed immediately by the new separator.
9154 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9155
9156 The field selectors marked as "time" above
9157 take an optional modifier of "int"
9158 for which the result is the number of seconds since epoch.
9159 Otherwise the result is a human-readable string
9160 in the timezone selected by the main "timezone" option.
9161
9162 The field selectors marked as "list" above return a list,
9163 newline-separated by default,
9164 (embedded separator characters in elements are doubled).
9165 The separator may be changed by a modifier of
9166 a right angle-bracket followed immediately by the new separator.
9167
9168 The field selectors marked as "tagged" above
9169 prefix each list element with a type string and an equals sign.
9170 Elements of only one type may be selected by a modifier
9171 which is one of "dns", "uri" or "mail";
9172 if so the element tags are omitted.
9173
9174 If not otherwise noted field values are presented in human-readable form.
9175
9176 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9177        {*&<&'arg'&>&*}...}*&"
9178 .cindex &%dlfunc%&
9179 This expansion dynamically loads and then calls a locally-written C function.
9180 This functionality is available only if Exim is compiled with
9181 .code
9182 EXPAND_DLFUNC=yes
9183 .endd
9184 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9185 object so that it doesn't reload the same object file in the same Exim process
9186 (but of course Exim does start new processes frequently).
9187
9188 There may be from zero to eight arguments to the function. When compiling
9189 a local function that is to be called in this way, &_local_scan.h_& should be
9190 included. The Exim variables and functions that are defined by that API
9191 are also available for dynamically loaded functions. The function itself
9192 must have the following type:
9193 .code
9194 int dlfunction(uschar **yield, int argc, uschar *argv[])
9195 .endd
9196 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9197 function should return one of the following values:
9198
9199 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9200 into the expanded string that is being built.
9201
9202 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9203 from &'yield'&, if it is set.
9204
9205 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9206 taken from &'yield'& if it is set.
9207
9208 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9209
9210 When compiling a function that is to be used in this way with gcc,
9211 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9212 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9213
9214
9215 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9216 .cindex "expansion" "extracting value from environment"
9217 .cindex "environment" "values from"
9218 The key is first expanded separately, and leading and trailing white space
9219 removed.
9220 This is then searched for as a name in the environment.
9221 If a variable is found then its value is placed in &$value$&
9222 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9223
9224 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9225 appear, for example:
9226 .code
9227 ${env{USER}{$value} fail }
9228 .endd
9229 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9230 {<&'string1'&>} must be present for &"fail"& to be recognized.
9231
9232 If {<&'string2'&>} is omitted an empty string is substituted on
9233 search failure.
9234 If {<&'string1'&>} is omitted the search result is substituted on
9235 search success.
9236
9237 The environment is adjusted by the &%keep_environment%& and
9238 &%add_environment%& main section options.
9239
9240
9241 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9242        {*&<&'string3'&>&*}}*&"
9243 .cindex "expansion" "extracting substrings by key"
9244 .cindex "&%extract%&" "substrings by key"
9245 The key and <&'string1'&> are first expanded separately. Leading and trailing
9246 white space is removed from the key (but not from any of the strings). The key
9247 must not be empty and must not consist entirely of digits.
9248 The expanded <&'string1'&> must be of the form:
9249 .display
9250 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9251 .endd
9252 .vindex "&$value$&"
9253 where the equals signs and spaces (but not both) are optional. If any of the
9254 values contain white space, they must be enclosed in double quotes, and any
9255 values that are enclosed in double quotes are subject to escape processing as
9256 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9257 for the value that corresponds to the key. The search is case-insensitive. If
9258 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9259 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9260 variable &$value$& contains the value that has been extracted. Afterwards, it
9261 is restored to any previous value it might have had.
9262
9263 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9264 key is not found. If {<&'string2'&>} is also omitted, the value that was
9265 extracted is used. Thus, for example, these two expansions are identical, and
9266 yield &"2001"&:
9267 .code
9268 ${extract{gid}{uid=1984 gid=2001}}
9269 ${extract{gid}{uid=1984 gid=2001}{$value}}
9270 .endd
9271 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9272 appear, for example:
9273 .code
9274 ${extract{Z}{A=... B=...}{$value} fail }
9275 .endd
9276 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9277 {<&'string2'&>} must be present for &"fail"& to be recognized.
9278
9279
9280 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9281         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9282 .cindex "expansion" "extracting substrings by number"
9283 .cindex "&%extract%&" "substrings by number"
9284 The <&'number'&> argument must consist entirely of decimal digits,
9285 apart from leading and trailing white space, which is ignored.
9286 This is what distinguishes this form of &%extract%& from the previous kind. It
9287 behaves in the same way, except that, instead of extracting a named field, it
9288 extracts from <&'string1'&> the field whose number is given as the first
9289 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9290 <&'string3'&> as before.
9291
9292 The fields in the string are separated by any one of the characters in the
9293 separator string. These may include space or tab characters.
9294 The first field is numbered one. If the number is negative, the fields are
9295 counted from the end of the string, with the rightmost one numbered -1. If the
9296 number given is zero, the entire string is returned. If the modulus of the
9297 number is greater than the number of fields in the string, the result is the
9298 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9299 provided. For example:
9300 .code
9301 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9302 .endd
9303 yields &"42"&, and
9304 .code
9305 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9306 .endd
9307 yields &"99"&. Two successive separators mean that the field between them is
9308 empty (for example, the fifth field above).
9309
9310
9311 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9312 .cindex "list" "selecting by condition"
9313 .cindex "expansion" "selecting from list by condition"
9314 .vindex "&$item$&"
9315 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9316 default, but the separator can be changed in the usual way. For each item
9317 in this list, its value is place in &$item$&, and then the condition is
9318 evaluated. If the condition is true, &$item$& is added to the output as an
9319 item in a new list; if the condition is false, the item is discarded. The
9320 separator used for the output list is the same as the one used for the
9321 input, but a separator setting is not included in the output. For example:
9322 .code
9323 ${filter{a:b:c}{!eq{$item}{b}}
9324 .endd
9325 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9326 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9327
9328
9329 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9330 .cindex "hash function" "textual"
9331 .cindex "expansion" "textual hash"
9332 This is a textual hashing function, and was the first to be implemented in
9333 early versions of Exim. In current releases, there are other hashing functions
9334 (numeric, MD5, and SHA-1), which are described below.
9335
9336 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9337 <&'n'&>. If you are using fixed values for these numbers, that is, if
9338 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9339 use the simpler operator notation that avoids some of the braces:
9340 .code
9341 ${hash_<n>_<m>:<string>}
9342 .endd
9343 The second number is optional (in both notations). If <&'n'&> is greater than
9344 or equal to the length of the string, the expansion item returns the string.
9345 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9346 function to the string. The new string consists of characters taken from the
9347 first <&'m'&> characters of the string
9348 .code
9349 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9350 .endd
9351 If <&'m'&> is not present the value 26 is used, so that only lower case
9352 letters appear. For example:
9353 .display
9354 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9355 &`$hash{5}{monty}}           `&   yields  &`monty`&
9356 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9357 .endd
9358
9359 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9360         &*$h_*&<&'header&~name'&>&*:*&" &&&
9361        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9362         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9363        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9364         &*$rh_*&<&'header&~name'&>&*:*&"
9365 .cindex "expansion" "header insertion"
9366 .vindex "&$header_$&"
9367 .vindex "&$bheader_$&"
9368 .vindex "&$rheader_$&"
9369 .cindex "header lines" "in expansion strings"
9370 .cindex "header lines" "character sets"
9371 .cindex "header lines" "decoding"
9372 Substitute the contents of the named message header line, for example
9373 .code
9374 $header_reply-to:
9375 .endd
9376 The newline that terminates a header line is not included in the expansion, but
9377 internal newlines (caused by splitting the header line over several physical
9378 lines) may be present.
9379
9380 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9381 the data in the header line is interpreted.
9382
9383 .ilist
9384 .cindex "white space" "in header lines"
9385 &%rheader%& gives the original &"raw"& content of the header line, with no
9386 processing at all, and without the removal of leading and trailing white space.
9387
9388 .next
9389 .cindex "base64 encoding" "in header lines"
9390 &%bheader%& removes leading and trailing white space, and then decodes base64
9391 or quoted-printable MIME &"words"& within the header text, but does no
9392 character set translation. If decoding of what looks superficially like a MIME
9393 &"word"& fails, the raw string is returned. If decoding
9394 .cindex "binary zero" "in header line"
9395 produces a binary zero character, it is replaced by a question mark &-- this is
9396 what Exim does for binary zeros that are actually received in header lines.
9397
9398 .next
9399 &%header%& tries to translate the string as decoded by &%bheader%& to a
9400 standard character set. This is an attempt to produce the same string as would
9401 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9402 returned. Translation is attempted only on operating systems that support the
9403 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9404 a system Makefile or in &_Local/Makefile_&.
9405 .endlist ilist
9406
9407 In a filter file, the target character set for &%header%& can be specified by a
9408 command of the following form:
9409 .code
9410 headers charset "UTF-8"
9411 .endd
9412 This command affects all references to &$h_$& (or &$header_$&) expansions in
9413 subsequently obeyed filter commands. In the absence of this command, the target
9414 character set in a filter is taken from the setting of the &%headers_charset%&
9415 option in the runtime configuration. The value of this option defaults to the
9416 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9417 ISO-8859-1.
9418
9419 Header names follow the syntax of RFC 2822, which states that they may contain
9420 any printing characters except space and colon. Consequently, curly brackets
9421 &'do not'& terminate header names, and should not be used to enclose them as
9422 if they were variables. Attempting to do so causes a syntax error.
9423
9424 Only header lines that are common to all copies of a message are visible to
9425 this mechanism. These are the original header lines that are received with the
9426 message, and any that are added by an ACL statement or by a system
9427 filter. Header lines that are added to a particular copy of a message by a
9428 router or transport are not accessible.
9429
9430 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9431 before the DATA ACL, because the header structure is not set up until the
9432 message is received. Header lines that are added in a RCPT ACL (for example)
9433 are saved until the message's incoming header lines are available, at which
9434 point they are added. When a DATA ACL is running, however, header lines added
9435 by earlier ACLs are visible.
9436
9437 Upper case and lower case letters are synonymous in header names. If the
9438 following character is white space, the terminating colon may be omitted, but
9439 this is not recommended, because you may then forget it when it is needed. When
9440 white space terminates the header name, this white space is included in the
9441 expanded string.  If the message does not contain the given header, the
9442 expansion item is replaced by an empty string. (See the &%def%& condition in
9443 section &<<SECTexpcond>>& for a means of testing for the existence of a
9444 header.)
9445
9446 If there is more than one header with the same name, they are all concatenated
9447 to form the substitution string, up to a maximum length of 64K. Unless
9448 &%rheader%& is being used, leading and trailing white space is removed from
9449 each header before concatenation, and a completely empty header is ignored. A
9450 newline character is then inserted between non-empty headers, but there is no
9451 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9452 those headers that contain lists of addresses, a comma is also inserted at the
9453 junctions between headers. This does not happen for the &%rheader%& expansion.
9454
9455
9456 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9457 .cindex "expansion" "hmac hashing"
9458 .cindex &%hmac%&
9459 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9460 shared secret and some text into a message authentication code, as specified in
9461 RFC 2104. This differs from &`${md5:secret_text...}`& or
9462 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9463 cryptographic hash, allowing for authentication that is not possible with MD5
9464 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9465 present. For example:
9466 .code
9467 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9468 .endd
9469 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9470 produces:
9471 .code
9472 dd97e3ba5d1a61b5006108f8c8252953
9473 .endd
9474 As an example of how this might be used, you might put in the main part of
9475 an Exim configuration:
9476 .code
9477 SPAMSCAN_SECRET=cohgheeLei2thahw
9478 .endd
9479 In a router or a transport you could then have:
9480 .code
9481 headers_add = \
9482   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9483   ${hmac{md5}{SPAMSCAN_SECRET}\
9484   {${primary_hostname},${message_exim_id},$h_message-id:}}
9485 .endd
9486 Then given a message, you can check where it was scanned by looking at the
9487 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9488 this header line is authentic by recomputing the authentication code from the
9489 host name, message ID and the &'Message-id:'& header line. This can be done
9490 using Exim's &%-be%& option, or by other means, for example by using the
9491 &'hmac_md5_hex()'& function in Perl.
9492
9493
9494 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9495 .cindex "expansion" "conditional"
9496 .cindex "&%if%&, expansion item"
9497 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9498 item; otherwise <&'string2'&> is used. The available conditions are described
9499 in section &<<SECTexpcond>>& below. For example:
9500 .code
9501 ${if eq {$local_part}{postmaster} {yes}{no} }
9502 .endd
9503 The second string need not be present; if it is not and the condition is not
9504 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9505 be present instead of the second string (without any curly brackets). In this
9506 case, the expansion is forced to fail if the condition is not true (see section
9507 &<<SECTforexpfai>>&).
9508
9509 If both strings are omitted, the result is the string &`true`& if the condition
9510 is true, and the empty string if the condition is false. This makes it less
9511 cumbersome to write custom ACL and router conditions. For example, instead of
9512 .code
9513 condition = ${if >{$acl_m4}{3}{true}{false}}
9514 .endd
9515 you can use
9516 .code
9517 condition = ${if >{$acl_m4}{3}}
9518 .endd
9519
9520
9521
9522 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9523 .cindex expansion "imap folder"
9524 .cindex "&%imapfolder%& expansion item"
9525 This item converts a (possibly multilevel, or with non-ASCII characters)
9526 folder specification to a Maildir name for filesystem use.
9527 For information on internationalisation support see &<<SECTi18nMDA>>&.
9528
9529
9530
9531 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9532 .cindex "expansion" "string truncation"
9533 .cindex "&%length%& expansion item"
9534 The &%length%& item is used to extract the initial portion of a string. Both
9535 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9536 you are using a fixed value for the number, that is, if <&'string1'&> does not
9537 change when expanded, you can use the simpler operator notation that avoids
9538 some of the braces:
9539 .code
9540 ${length_<n>:<string>}
9541 .endd
9542 The result of this item is either the first <&'n'&> characters or the whole
9543 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9544 &%strlen%&, which gives the length of a string.
9545
9546
9547 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9548         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9549 .cindex "expansion" "extracting list elements by number"
9550 .cindex "&%listextract%&" "extract list elements by number"
9551 .cindex "list" "extracting elements by number"
9552 The <&'number'&> argument must consist entirely of decimal digits,
9553 apart from an optional leading minus,
9554 and leading and trailing white space (which is ignored).
9555
9556 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9557 default, but the separator can be changed in the usual way.
9558
9559 The first field of the list is numbered one.
9560 If the number is negative, the fields are
9561 counted from the end of the list, with the rightmost one numbered -1.
9562 The numbered element of the list is extracted and placed in &$value$&,
9563 then <&'string2'&> is expanded as the result.
9564
9565 If the modulus of the
9566 number is zero or greater than the number of fields in the string,
9567 the result is the expansion of <&'string3'&>.
9568
9569 For example:
9570 .code
9571 ${listextract{2}{x:42:99}}
9572 .endd
9573 yields &"42"&, and
9574 .code
9575 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9576 .endd
9577 yields &"result: 42"&.
9578
9579 If {<&'string3'&>} is omitted, an empty string is used for string3.
9580 If {<&'string2'&>} is also omitted, the value that was
9581 extracted is used.
9582 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9583
9584
9585 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9586         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9587 This is the first of one of two different types of lookup item, which are both
9588 described in the next item.
9589
9590 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9591         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9592 .cindex "expansion" "lookup in"
9593 .cindex "file" "lookups"
9594 .cindex "lookup" "in expanded string"
9595 The two forms of lookup item specify data lookups in files and databases, as
9596 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9597 lookups, and the second is used for query-style lookups. The <&'key'&>,
9598 <&'file'&>, and <&'query'&> strings are expanded before use.
9599
9600 If there is any white space in a lookup item which is part of a filter command,
9601 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9602 other place where white space is significant, the lookup item must be enclosed
9603 in double quotes. The use of data lookups in users' filter files may be locked
9604 out by the system administrator.
9605
9606 .vindex "&$value$&"
9607 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9608 During its expansion, the variable &$value$& contains the data returned by the
9609 lookup. Afterwards it reverts to the value it had previously (at the outer
9610 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9611 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9612 string on failure. If <&'string2'&> is provided, it can itself be a nested
9613 lookup, thus providing a mechanism for looking up a default value when the
9614 original lookup fails.
9615
9616 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9617 data for the outer lookup while the parameters of the second lookup are
9618 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9619 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9620 appear, and in this case, if the lookup fails, the entire expansion is forced
9621 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9622 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9623 successful lookup, and nothing in the case of failure.
9624
9625 For single-key lookups, the string &"partial"& is permitted to precede the
9626 search type in order to do partial matching, and * or *@ may follow a search
9627 type to request default lookups if the key does not match (see sections
9628 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9629
9630 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9631 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9632 and non-wild parts of the key during the expansion of the replacement text.
9633 They return to their previous values at the end of the lookup item.
9634
9635 This example looks up the postmaster alias in the conventional alias file:
9636 .code
9637 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9638 .endd
9639 This example uses NIS+ to look up the full name of the user corresponding to
9640 the local part of an address, forcing the expansion to fail if it is not found:
9641 .code
9642 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9643   {$value}fail}
9644 .endd
9645
9646
9647 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9648 .cindex "expansion" "list creation"
9649 .vindex "&$item$&"
9650 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9651 default, but the separator can be changed in the usual way. For each item
9652 in this list, its value is place in &$item$&, and then <&'string2'&> is
9653 expanded and added to the output as an item in a new list. The separator used
9654 for the output list is the same as the one used for the input, but a separator
9655 setting is not included in the output. For example:
9656 .code
9657 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9658 .endd
9659 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9660 value of &$item$& is restored to what it was before. See also the &*filter*&
9661 and &*reduce*& expansion items.
9662
9663 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9664 .cindex "expansion" "numeric hash"
9665 .cindex "hash function" "numeric"
9666 The three strings are expanded; the first two must yield numbers. Call them
9667 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9668 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9669 can use the simpler operator notation that avoids some of the braces:
9670 .code
9671 ${nhash_<n>_<m>:<string>}
9672 .endd
9673 The second number is optional (in both notations). If there is only one number,
9674 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9675 processed by a div/mod hash function that returns two numbers, separated by a
9676 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9677 example,
9678 .code
9679 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9680 .endd
9681 returns the string &"6/33"&.
9682
9683
9684
9685 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9686 .cindex "Perl" "use in expanded string"
9687 .cindex "expansion" "calling Perl from"
9688 This item is available only if Exim has been built to include an embedded Perl
9689 interpreter. The subroutine name and the arguments are first separately
9690 expanded, and then the Perl subroutine is called with those arguments. No
9691 additional arguments need be given; the maximum number permitted, including the
9692 name of the subroutine, is nine.
9693
9694 The return value of the subroutine is inserted into the expanded string, unless
9695 the return value is &%undef%&. In that case, the expansion fails in the same
9696 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9697 Whatever you return is evaluated in a scalar context. For example, if you
9698 return the name of a Perl vector, the return value is the size of the vector,
9699 not its contents.
9700
9701 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9702 with the error message that was passed to &%die%&. More details of the embedded
9703 Perl facility are given in chapter &<<CHAPperl>>&.
9704
9705 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9706 out the use of this expansion item in filter files.
9707
9708
9709 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9710 .cindex "&%prvs%& expansion item"
9711 The first argument is a complete email address and the second is secret
9712 keystring. The third argument, specifying a key number, is optional. If absent,
9713 it defaults to 0. The result of the expansion is a prvs-signed email address,
9714 to be typically used with the &%return_path%& option on an &(smtp)& transport
9715 as part of a bounce address tag validation (BATV) scheme. For more discussion
9716 and an example, see section &<<SECTverifyPRVS>>&.
9717
9718 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9719         {*&<&'string'&>&*}}*&"
9720 .cindex "&%prvscheck%& expansion item"
9721 This expansion item is the complement of the &%prvs%& item. It is used for
9722 checking prvs-signed addresses. If the expansion of the first argument does not
9723 yield a syntactically valid prvs-signed address, the whole item expands to the
9724 empty string. When the first argument does expand to a syntactically valid
9725 prvs-signed address, the second argument is expanded, with the prvs-decoded
9726 version of the address and the key number extracted from the address in the
9727 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9728
9729 These two variables can be used in the expansion of the second argument to
9730 retrieve the secret. The validity of the prvs-signed address is then checked
9731 against the secret. The result is stored in the variable &$prvscheck_result$&,
9732 which is empty for failure or &"1"& for success.
9733
9734 The third argument is optional; if it is missing, it defaults to an empty
9735 string. This argument is now expanded. If the result is an empty string, the
9736 result of the expansion is the decoded version of the address. This is the case
9737 whether or not the signature was valid. Otherwise, the result of the expansion
9738 is the expansion of the third argument.
9739
9740 All three variables can be used in the expansion of the third argument.
9741 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9742 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9743
9744 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9745 .cindex "expansion" "inserting an entire file"
9746 .cindex "file" "inserting into expansion"
9747 .cindex "&%readfile%& expansion item"
9748 The file name and end-of-line string are first expanded separately. The file is
9749 then read, and its contents replace the entire item. All newline characters in
9750 the file are replaced by the end-of-line string if it is present. Otherwise,
9751 newlines are left in the string.
9752 String expansion is not applied to the contents of the file. If you want this,
9753 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9754 the string expansion fails.
9755
9756 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9757 locks out the use of this expansion item in filter files.
9758
9759
9760
9761 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9762         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9763 .cindex "expansion" "inserting from a socket"
9764 .cindex "socket, use of in expansion"
9765 .cindex "&%readsocket%& expansion item"
9766 This item inserts data from a Unix domain or TCP socket into the expanded
9767 string. The minimal way of using it uses just two arguments, as in these
9768 examples:
9769 .code
9770 ${readsocket{/socket/name}{request string}}
9771 ${readsocket{inet:some.host:1234}{request string}}
9772 .endd
9773 For a Unix domain socket, the first substring must be the path to the socket.
9774 For an Internet socket, the first substring must contain &`inet:`& followed by
9775 a host name or IP address, followed by a colon and a port, which can be a
9776 number or the name of a TCP port in &_/etc/services_&. An IP address may
9777 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9778 example:
9779 .code
9780 ${readsocket{inet:[::1]:1234}{request string}}
9781 .endd
9782 Only a single host name may be given, but if looking it up yields more than
9783 one IP address, they are each tried in turn until a connection is made. For
9784 both kinds of socket, Exim makes a connection, writes the request string
9785 unless it is an empty string; and no terminating NUL is ever sent)
9786 and reads from the socket until an end-of-file
9787 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9788 extend what can be done. Firstly, you can vary the timeout. For example:
9789 .code
9790 ${readsocket{/socket/name}{request string}{3s}}
9791 .endd
9792 A fourth argument allows you to change any newlines that are in the data
9793 that is read, in the same way as for &%readfile%& (see above). This example
9794 turns them into spaces:
9795 .code
9796 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9797 .endd
9798 As with all expansions, the substrings are expanded before the processing
9799 happens. Errors in these sub-expansions cause the expansion to fail. In
9800 addition, the following errors can occur:
9801
9802 .ilist
9803 Failure to create a socket file descriptor;
9804 .next
9805 Failure to connect the socket;
9806 .next
9807 Failure to write the request string;
9808 .next
9809 Timeout on reading from the socket.
9810 .endlist
9811
9812 By default, any of these errors causes the expansion to fail. However, if
9813 you supply a fifth substring, it is expanded and used when any of the above
9814 errors occurs. For example:
9815 .code
9816 ${readsocket{/socket/name}{request string}{3s}{\n}\
9817   {socket failure}}
9818 .endd
9819 You can test for the existence of a Unix domain socket by wrapping this
9820 expansion in &`${if exists`&, but there is a race condition between that test
9821 and the actual opening of the socket, so it is safer to use the fifth argument
9822 if you want to be absolutely sure of avoiding an expansion error for a
9823 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9824
9825 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9826 locks out the use of this expansion item in filter files.
9827
9828
9829 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9830 .cindex "expansion" "reducing a list to a scalar"
9831 .cindex "list" "reducing to a scalar"
9832 .vindex "&$value$&"
9833 .vindex "&$item$&"
9834 This operation reduces a list to a single, scalar string. After expansion,
9835 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9836 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9837 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9838 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9839 them. The result of that expansion is assigned to &$value$& before the next
9840 iteration. When the end of the list is reached, the final value of &$value$& is
9841 added to the expansion output. The &*reduce*& expansion item can be used in a
9842 number of ways. For example, to add up a list of numbers:
9843 .code
9844 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9845 .endd
9846 The result of that expansion would be &`6`&. The maximum of a list of numbers
9847 can be found:
9848 .code
9849 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9850 .endd
9851 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9852 restored to what they were before. See also the &*filter*& and &*map*&
9853 expansion items.
9854
9855 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9856 This item inserts &"raw"& header lines. It is described with the &%header%&
9857 expansion item above.
9858
9859 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9860         {*&<&'string2'&>&*}}*&"
9861 .cindex "expansion" "running a command"
9862 .cindex "&%run%& expansion item"
9863 The command and its arguments are first expanded as one string. The string is
9864 split apart into individual arguments by spaces, and then the command is run
9865 in a separate process, but under the same uid and gid.  As in other command
9866 executions from Exim, a shell is not used by default. If the command requires
9867 a shell, you must explicitly code it.
9868
9869 Since the arguments are split by spaces, when there is a variable expansion
9870 which has an empty result, it will cause the situation that the argument will
9871 simply be omitted when the program is actually executed by Exim. If the
9872 script/program requires a specific number of arguments and the expanded
9873 variable could possibly result in this empty expansion, the variable must be
9874 quoted. This is more difficult if the expanded variable itself could result
9875 in a string containing quotes, because it would interfere with the quotes
9876 around the command arguments. A possible guard against this is to wrap the
9877 variable in the &%sg%& operator to change any quote marks to some other
9878 character.
9879
9880 The standard input for the command exists, but is empty. The standard output
9881 and standard error are set to the same file descriptor.
9882 .cindex "return code" "from &%run%& expansion"
9883 .vindex "&$value$&"
9884 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9885 and replaces the entire item; during this expansion, the standard output/error
9886 from the command is in the variable &$value$&. If the command fails,
9887 <&'string2'&>, if present, is expanded and used. Once again, during the
9888 expansion, the standard output/error from the command is in the variable
9889 &$value$&.
9890
9891 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9892 can be the word &"fail"& (not in braces) to force expansion failure if the
9893 command does not succeed. If both strings are omitted, the result is contents
9894 of the standard output/error on success, and nothing on failure.
9895
9896 .vindex "&$run_in_acl$&"
9897 The standard output/error of the command is put in the variable &$value$&.
9898 In this ACL example, the output of a command is logged for the admin to
9899 troubleshoot:
9900 .code
9901 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9902       log_message  = Output of id: $value
9903 .endd
9904 If the command requires shell idioms, such as the > redirect operator, the
9905 shell must be invoked directly, such as with:
9906 .code
9907 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9908 .endd
9909
9910 .vindex "&$runrc$&"
9911 The return code from the command is put in the variable &$runrc$&, and this
9912 remains set afterwards, so in a filter file you can do things like this:
9913 .code
9914 if "${run{x y z}{}}$runrc" is 1 then ...
9915   elif $runrc is 2 then ...
9916   ...
9917 endif
9918 .endd
9919 If execution of the command fails (for example, the command does not exist),
9920 the return code is 127 &-- the same code that shells use for non-existent
9921 commands.
9922
9923 &*Warning*&: In a router or transport, you cannot assume the order in which
9924 option values are expanded, except for those preconditions whose order of
9925 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9926 by the expansion of one option, and use it in another.
9927
9928 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9929 out the use of this expansion item in filter files.
9930
9931
9932 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9933 .cindex "expansion" "string substitution"
9934 .cindex "&%sg%& expansion item"
9935 This item works like Perl's substitution operator (s) with the global (/g)
9936 option; hence its name. However, unlike the Perl equivalent, Exim does not
9937 modify the subject string; instead it returns the modified string for insertion
9938 into the overall expansion. The item takes three arguments: the subject string,
9939 a regular expression, and a substitution string. For example:
9940 .code
9941 ${sg{abcdefabcdef}{abc}{xyz}}
9942 .endd
9943 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9944 if any $ or \ characters are required in the regular expression or in the
9945 substitution string, they have to be escaped. For example:
9946 .code
9947 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9948 .endd
9949 yields &"defabc"&, and
9950 .code
9951 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9952 .endd
9953 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9954 the regular expression from string expansion.
9955
9956
9957
9958 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9959 .cindex sorting "a list"
9960 .cindex list sorting
9961 .cindex expansion "list sorting"
9962 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9963 default, but the separator can be changed in the usual way.
9964 The <&'comparator'&> argument is interpreted as the operator
9965 of a two-argument expansion condition.
9966 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9967 The comparison should return true when applied to two values
9968 if the first value should sort before the second value.
9969 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9970 the element being placed in &$item$&,
9971 to give values for comparison.
9972
9973 The item result is a sorted list,
9974 with the original list separator,
9975 of the list elements (in full) of the original.
9976
9977 Examples:
9978 .code
9979 ${sort{3:2:1:4}{<}{$item}}
9980 .endd
9981 sorts a list of numbers, and
9982 .code
9983 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9984 .endd
9985 will sort an MX lookup into priority order.
9986
9987
9988 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9989 .cindex "&%substr%& expansion item"
9990 .cindex "substring extraction"
9991 .cindex "expansion" "substring extraction"
9992 The three strings are expanded; the first two must yield numbers. Call them
9993 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9994 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9995 can use the simpler operator notation that avoids some of the braces:
9996 .code
9997 ${substr_<n>_<m>:<string>}
9998 .endd
9999 The second number is optional (in both notations).
10000 If it is absent in the simpler format, the preceding underscore must also be
10001 omitted.
10002
10003 The &%substr%& item can be used to extract more general substrings than
10004 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10005 length required. For example
10006 .code
10007 ${substr{3}{2}{$local_part}}
10008 .endd
10009 If the starting offset is greater than the string length the result is the
10010 null string; if the length plus starting offset is greater than the string
10011 length, the result is the right-hand part of the string, starting from the
10012 given offset. The first character in the string has offset zero.
10013
10014 The &%substr%& expansion item can take negative offset values to count
10015 from the right-hand end of its operand. The last character is offset -1, the
10016 second-last is offset -2, and so on. Thus, for example,
10017 .code
10018 ${substr{-5}{2}{1234567}}
10019 .endd
10020 yields &"34"&. If the absolute value of a negative offset is greater than the
10021 length of the string, the substring starts at the beginning of the string, and
10022 the length is reduced by the amount of overshoot. Thus, for example,
10023 .code
10024 ${substr{-5}{2}{12}}
10025 .endd
10026 yields an empty string, but
10027 .code
10028 ${substr{-3}{2}{12}}
10029 .endd
10030 yields &"1"&.
10031
10032 When the second number is omitted from &%substr%&, the remainder of the string
10033 is taken if the offset is positive. If it is negative, all characters in the
10034 string preceding the offset point are taken. For example, an offset of -1 and
10035 no length, as in these semantically identical examples:
10036 .code
10037 ${substr_-1:abcde}
10038 ${substr{-1}{abcde}}
10039 .endd
10040 yields all but the last character of the string, that is, &"abcd"&.
10041
10042
10043
10044 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10045         {*&<&'replacements'&>&*}}*&"
10046 .cindex "expansion" "character translation"
10047 .cindex "&%tr%& expansion item"
10048 This item does single-character translation on its subject string. The second
10049 argument is a list of characters to be translated in the subject string. Each
10050 matching character is replaced by the corresponding character from the
10051 replacement list. For example
10052 .code
10053 ${tr{abcdea}{ac}{13}}
10054 .endd
10055 yields &`1b3de1`&. If there are duplicates in the second character string, the
10056 last occurrence is used. If the third string is shorter than the second, its
10057 last character is replicated. However, if it is empty, no translation takes
10058 place.
10059 .endlist
10060
10061
10062
10063 .section "Expansion operators" "SECTexpop"
10064 .cindex "expansion" "operators"
10065 For expansion items that perform transformations on a single argument string,
10066 the &"operator"& notation is used because it is simpler and uses fewer braces.
10067 The substring is first expanded before the operation is applied to it. The
10068 following operations can be performed:
10069
10070 .vlist
10071 .vitem &*${address:*&<&'string'&>&*}*&
10072 .cindex "expansion" "RFC 2822 address handling"
10073 .cindex "&%address%& expansion item"
10074 The string is interpreted as an RFC 2822 address, as it might appear in a
10075 header line, and the effective address is extracted from it. If the string does
10076 not parse successfully, the result is empty.
10077
10078
10079 .vitem &*${addresses:*&<&'string'&>&*}*&
10080 .cindex "expansion" "RFC 2822 address handling"
10081 .cindex "&%addresses%& expansion item"
10082 The string (after expansion) is interpreted as a list of addresses in RFC
10083 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10084 operative address (&'local-part@domain'&) is extracted from each item, and the
10085 result of the expansion is a colon-separated list, with appropriate
10086 doubling of colons should any happen to be present in the email addresses.
10087 Syntactically invalid RFC2822 address items are omitted from the output.
10088
10089 It is possible to specify a character other than colon for the output
10090 separator by starting the string with > followed by the new separator
10091 character. For example:
10092 .code
10093 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10094 .endd
10095 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10096 expansion item, which extracts the working address from a single RFC2822
10097 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10098 processing lists.
10099
10100 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10101 a strict interpretation of header line formatting.  Exim parses the bare,
10102 unquoted portion of an email address and if it finds a comma, treats it as an
10103 email address separator. For the example header line:
10104 .code
10105 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10106 .endd
10107 The first example below demonstrates that Q-encoded email addresses are parsed
10108 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10109 It does not see the comma because it's still encoded as "=2C".  The second
10110 example below is passed the contents of &`$header_from:`&, meaning it gets
10111 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10112 The third example shows that the presence of a comma is skipped when it is
10113 quoted.
10114 .code
10115 # exim -be '${addresses:From: \
10116 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10117 user@example.com
10118 # exim -be '${addresses:From: Last, First <user@example.com>}'
10119 Last:user@example.com
10120 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10121 user@example.com
10122 .endd
10123
10124 .new
10125 .vitem &*${base32:*&<&'digits'&>&*}*&
10126 .cindex "&%base32%& expansion item"
10127 .cindex "expansion" "conversion to base 32"
10128 The string must consist entirely of decimal digits. The number is converted to
10129 base 32 and output as a (empty, for zero) string of characters.
10130 Only lowercase letters are used.
10131
10132 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10133 .cindex "&%base32d%& expansion item"
10134 .cindex "expansion" "conversion to base 32"
10135 The string must consist entirely of base-32 digits.
10136 The number is converted to decimal and output as a string.
10137 .wen
10138
10139 .vitem &*${base62:*&<&'digits'&>&*}*&
10140 .cindex "&%base62%& expansion item"
10141 .cindex "expansion" "conversion to base 62"
10142 The string must consist entirely of decimal digits. The number is converted to
10143 base 62 and output as a string of six characters, including leading zeros. In
10144 the few operating environments where Exim uses base 36 instead of base 62 for
10145 its message identifiers (because those systems do not have case-sensitive file
10146 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10147 be absolutely clear: this is &'not'& base64 encoding.
10148
10149 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10150 .cindex "&%base62d%& expansion item"
10151 .cindex "expansion" "conversion to base 62"
10152 The string must consist entirely of base-62 digits, or, in operating
10153 environments where Exim uses base 36 instead of base 62 for its message
10154 identifiers, base-36 digits. The number is converted to decimal and output as a
10155 string.
10156
10157 .vitem &*${base64:*&<&'string'&>&*}*&
10158 .cindex "expansion" "base64 encoding"
10159 .cindex "base64 encoding" "in string expansion"
10160 .cindex "&%base64%& expansion item"
10161 .cindex certificate "base64 of DER"
10162 This operator converts a string into one that is base64 encoded.
10163
10164 If the string is a single variable of type certificate,
10165 returns the base64 encoding of the DER form of the certificate.
10166
10167
10168 .vitem &*${base64d:*&<&'string'&>&*}*&
10169 .cindex "expansion" "base64 decoding"
10170 .cindex "base64 decoding" "in string expansion"
10171 .cindex "&%base64d%& expansion item"
10172 This operator converts a base64-encoded string into the un-coded form.
10173
10174
10175 .vitem &*${domain:*&<&'string'&>&*}*&
10176 .cindex "domain" "extraction"
10177 .cindex "expansion" "domain extraction"
10178 The string is interpreted as an RFC 2822 address and the domain is extracted
10179 from it. If the string does not parse successfully, the result is empty.
10180
10181
10182 .vitem &*${escape:*&<&'string'&>&*}*&
10183 .cindex "expansion" "escaping non-printing characters"
10184 .cindex "&%escape%& expansion item"
10185 If the string contains any non-printing characters, they are converted to
10186 escape sequences starting with a backslash. Whether characters with the most
10187 significant bit set (so-called &"8-bit characters"&) count as printing or not
10188 is controlled by the &%print_topbitchars%& option.
10189
10190 .new
10191 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10192 .cindex "expansion" "escaping 8-bit characters"
10193 .cindex "&%escape8bit%& expansion item"
10194 If the string contains and characters with the most significant bit set,
10195 they are converted to escape sequences starting with a backslash.
10196 Backslashes and DEL characters are also converted.
10197 .wen
10198
10199
10200 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10201 .cindex "expansion" "expression evaluation"
10202 .cindex "expansion" "arithmetic expression"
10203 .cindex "&%eval%& expansion item"
10204 These items supports simple arithmetic and bitwise logical operations in
10205 expansion strings. The string (after expansion) must be a conventional
10206 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10207 logical operators, and parentheses. All operations are carried out using
10208 integer arithmetic. The operator priorities are as follows (the same as in the
10209 C programming language):
10210 .table2 70pt 300pt
10211 .irow &'highest:'& "not (~), negate (-)"
10212 .irow ""   "multiply (*), divide (/), remainder (%)"
10213 .irow ""   "plus (+), minus (-)"
10214 .irow ""   "shift-left (<<), shift-right (>>)"
10215 .irow ""   "and (&&)"
10216 .irow ""   "xor (^)"
10217 .irow &'lowest:'&  "or (|)"
10218 .endtable
10219 Binary operators with the same priority are evaluated from left to right. White
10220 space is permitted before or after operators.
10221
10222 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10223 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10224 decimal, even if they start with a leading zero; hexadecimal numbers are not
10225 permitted. This can be useful when processing numbers extracted from dates or
10226 times, which often do have leading zeros.
10227
10228 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10229 or 1024*1024*1024,
10230 respectively. Negative numbers are supported. The result of the computation is
10231 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10232
10233 .display
10234 &`${eval:1+1}            `&  yields 2
10235 &`${eval:1+2*3}          `&  yields 7
10236 &`${eval:(1+2)*3}        `&  yields 9
10237 &`${eval:2+42%5}         `&  yields 4
10238 &`${eval:0xc&amp;5}          `&  yields 4
10239 &`${eval:0xc|5}          `&  yields 13
10240 &`${eval:0xc^5}          `&  yields 9
10241 &`${eval:0xc>>1}         `&  yields 6
10242 &`${eval:0xc<<1}         `&  yields 24
10243 &`${eval:~255&amp;0x1234}    `&  yields 4608
10244 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10245 .endd
10246
10247 As a more realistic example, in an ACL you might have
10248 .code
10249 deny   message = Too many bad recipients
10250        condition =                    \
10251          ${if and {                   \
10252            {>{$rcpt_count}{10}}       \
10253            {                          \
10254            <                          \
10255              {$recipients_count}      \
10256              {${eval:$rcpt_count/2}}  \
10257            }                          \
10258          }{yes}{no}}
10259 .endd
10260 The condition is true if there have been more than 10 RCPT commands and
10261 fewer than half of them have resulted in a valid recipient.
10262
10263
10264 .vitem &*${expand:*&<&'string'&>&*}*&
10265 .cindex "expansion" "re-expansion of substring"
10266 The &%expand%& operator causes a string to be expanded for a second time. For
10267 example,
10268 .code
10269 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10270 .endd
10271 first looks up a string in a file while expanding the operand for &%expand%&,
10272 and then re-expands what it has found.
10273
10274
10275 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10276 .cindex "Unicode"
10277 .cindex "UTF-8" "conversion from"
10278 .cindex "expansion" "UTF-8 conversion"
10279 .cindex "&%from_utf8%& expansion item"
10280 The world is slowly moving towards Unicode, although there are no standards for
10281 email yet. However, other applications (including some databases) are starting
10282 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10283 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10284 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10285 the result is an undefined sequence of bytes.
10286
10287 Unicode code points with values less than 256 are compatible with ASCII and
10288 ISO-8859-1 (also known as Latin-1).
10289 For example, character 169 is the copyright symbol in both cases, though the
10290 way it is encoded is different. In UTF-8, more than one byte is needed for
10291 characters with code values greater than 127, whereas ISO-8859-1 is a
10292 single-byte encoding (but thereby limited to 256 characters). This makes
10293 translation from UTF-8 to ISO-8859-1 straightforward.
10294
10295
10296 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10297 .cindex "hash function" "textual"
10298 .cindex "expansion" "textual hash"
10299 The &%hash%& operator is a simpler interface to the hashing function that can
10300 be used when the two parameters are fixed numbers (as opposed to strings that
10301 change when expanded). The effect is the same as
10302 .code
10303 ${hash{<n>}{<m>}{<string>}}
10304 .endd
10305 See the description of the general &%hash%& item above for details. The
10306 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10307
10308
10309
10310 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10311 .cindex "base64 encoding" "conversion from hex"
10312 .cindex "expansion" "hex to base64"
10313 .cindex "&%hex2b64%& expansion item"
10314 This operator converts a hex string into one that is base64 encoded. This can
10315 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10316
10317
10318
10319 .vitem &*${hexquote:*&<&'string'&>&*}*&
10320 .cindex "quoting" "hex-encoded unprintable characters"
10321 .cindex "&%hexquote%& expansion item"
10322 This operator converts non-printable characters in a string into a hex
10323 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10324 as is, and other byte values are converted to &`\xNN`&, for example a
10325 byte value 127 is converted to &`\x7f`&.
10326
10327
10328 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10329 .cindex "&%ipv6denorm%& expansion item"
10330 .cindex "IP address" normalisation
10331 This expands an IPv6 address to a full eight-element colon-separated set
10332 of hex digits including leading zeroes.
10333 A trailing ipv4-style dotted-decimal set is converted to hex.
10334 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10335
10336 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10337 .cindex "&%ipv6norm%& expansion item"
10338 .cindex "IP address" normalisation
10339 .cindex "IP address" "canonical form"
10340 This converts an IPv6 address to canonical form.
10341 Leading zeroes of groups are omitted, and the longest
10342 set of zero-valued groups is replaced with a double colon.
10343 A trailing ipv4-style dotted-decimal set is converted to hex.
10344 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10345
10346
10347 .vitem &*${lc:*&<&'string'&>&*}*&
10348 .cindex "case forcing in strings"
10349 .cindex "string" "case forcing"
10350 .cindex "lower casing"
10351 .cindex "expansion" "case forcing"
10352 .cindex "&%lc%& expansion item"
10353 This forces the letters in the string into lower-case, for example:
10354 .code
10355 ${lc:$local_part}
10356 .endd
10357
10358 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10359 .cindex "expansion" "string truncation"
10360 .cindex "&%length%& expansion item"
10361 The &%length%& operator is a simpler interface to the &%length%& function that
10362 can be used when the parameter is a fixed number (as opposed to a string that
10363 changes when expanded). The effect is the same as
10364 .code
10365 ${length{<number>}{<string>}}
10366 .endd
10367 See the description of the general &%length%& item above for details. Note that
10368 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10369 when &%length%& is used as an operator.
10370
10371
10372 .vitem &*${listcount:*&<&'string'&>&*}*&
10373 .cindex "expansion" "list item count"
10374 .cindex "list" "item count"
10375 .cindex "list" "count of items"
10376 .cindex "&%listcount%& expansion item"
10377 The string is interpreted as a list and the number of items is returned.
10378
10379
10380 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10381 .cindex "expansion" "named list"
10382 .cindex "&%listnamed%& expansion item"
10383 The name is interpreted as a named list and the content of the list is returned,
10384 expanding any referenced lists, re-quoting as needed for colon-separation.
10385 If the optional type is given it must be one of "a", "d", "h" or "l"
10386 and selects address-, domain-, host- or localpart- lists to search among respectively.
10387 Otherwise all types are searched in an undefined order and the first
10388 matching list is returned.
10389
10390
10391 .vitem &*${local_part:*&<&'string'&>&*}*&
10392 .cindex "expansion" "local part extraction"
10393 .cindex "&%local_part%& expansion item"
10394 The string is interpreted as an RFC 2822 address and the local part is
10395 extracted from it. If the string does not parse successfully, the result is
10396 empty.
10397
10398
10399 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10400 .cindex "masked IP address"
10401 .cindex "IP address" "masking"
10402 .cindex "CIDR notation"
10403 .cindex "expansion" "IP address masking"
10404 .cindex "&%mask%& expansion item"
10405 If the form of the string to be operated on is not an IP address followed by a
10406 slash and an integer (that is, a network address in CIDR notation), the
10407 expansion fails. Otherwise, this operator converts the IP address to binary,
10408 masks off the least significant bits according to the bit count, and converts
10409 the result back to text, with mask appended. For example,
10410 .code
10411 ${mask:10.111.131.206/28}
10412 .endd
10413 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10414 be mostly used for looking up masked addresses in files, the result for an IPv6
10415 address uses dots to separate components instead of colons, because colon
10416 terminates a key string in lsearch files. So, for example,
10417 .code
10418 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10419 .endd
10420 returns the string
10421 .code
10422 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10423 .endd
10424 Letters in IPv6 addresses are always output in lower case.
10425
10426
10427 .vitem &*${md5:*&<&'string'&>&*}*&
10428 .cindex "MD5 hash"
10429 .cindex "expansion" "MD5 hash"
10430 .cindex certificate fingerprint
10431 .cindex "&%md5%& expansion item"
10432 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10433 as a 32-digit hexadecimal number, in which any letters are in lower case.
10434
10435 If the string is a single variable of type certificate,
10436 returns the MD5 hash fingerprint of the certificate.
10437
10438
10439 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10440 .cindex "expansion" "numeric hash"
10441 .cindex "hash function" "numeric"
10442 The &%nhash%& operator is a simpler interface to the numeric hashing function
10443 that can be used when the two parameters are fixed numbers (as opposed to
10444 strings that change when expanded). The effect is the same as
10445 .code
10446 ${nhash{<n>}{<m>}{<string>}}
10447 .endd
10448 See the description of the general &%nhash%& item above for details.
10449
10450
10451 .vitem &*${quote:*&<&'string'&>&*}*&
10452 .cindex "quoting" "in string expansions"
10453 .cindex "expansion" "quoting"
10454 .cindex "&%quote%& expansion item"
10455 The &%quote%& operator puts its argument into double quotes if it
10456 is an empty string or
10457 contains anything other than letters, digits, underscores, dots, and hyphens.
10458 Any occurrences of double quotes and backslashes are escaped with a backslash.
10459 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10460 respectively For example,
10461 .code
10462 ${quote:ab"*"cd}
10463 .endd
10464 becomes
10465 .code
10466 "ab\"*\"cd"
10467 .endd
10468 The place where this is useful is when the argument is a substitution from a
10469 variable or a message header.
10470
10471 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10472 .cindex "&%quote_local_part%& expansion item"
10473 This operator is like &%quote%&, except that it quotes the string only if
10474 required to do so by the rules of RFC 2822 for quoting local parts. For
10475 example, a plus sign would not cause quoting (but it would for &%quote%&).
10476 If you are creating a new email address from the contents of &$local_part$&
10477 (or any other unknown data), you should always use this operator.
10478
10479
10480 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10481 .cindex "quoting" "lookup-specific"
10482 This operator applies lookup-specific quoting rules to the string. Each
10483 query-style lookup type has its own quoting rules which are described with
10484 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10485 .code
10486 ${quote_ldap:two * two}
10487 .endd
10488 returns
10489 .code
10490 two%20%5C2A%20two
10491 .endd
10492 For single-key lookup types, no quoting is ever necessary and this operator
10493 yields an unchanged string.
10494
10495
10496 .vitem &*${randint:*&<&'n'&>&*}*&
10497 .cindex "random number"
10498 This operator returns a somewhat random number which is less than the
10499 supplied number and is at least 0.  The quality of this randomness depends
10500 on how Exim was built; the values are not suitable for keying material.
10501 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10502 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10503 for versions of GnuTLS with that function.
10504 Otherwise, the implementation may be arc4random(), random() seeded by
10505 srandomdev() or srandom(), or a custom implementation even weaker than
10506 random().
10507
10508
10509 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10510 .cindex "expansion" "IP address"
10511 This operator reverses an IP address; for IPv4 addresses, the result is in
10512 dotted-quad decimal form, while for IPv6 addresses the result is in
10513 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10514 for DNS.  For example,
10515 .code
10516 ${reverse_ip:192.0.2.4}
10517 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10518 .endd
10519 returns
10520 .code
10521 4.2.0.192
10522 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
10523 .endd
10524
10525
10526 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10527 .cindex "expansion" "RFC 2047"
10528 .cindex "RFC 2047" "expansion operator"
10529 .cindex "&%rfc2047%& expansion item"
10530 This operator encodes text according to the rules of RFC 2047. This is an
10531 encoding that is used in header lines to encode non-ASCII characters. It is
10532 assumed that the input string is in the encoding specified by the
10533 &%headers_charset%& option, which gets its default at build time. If the string
10534 contains only characters in the range 33&--126, and no instances of the
10535 characters
10536 .code
10537 ? = ( ) < > @ , ; : \ " . [ ] _
10538 .endd
10539 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10540 string, using as many &"encoded words"& as necessary to encode all the
10541 characters.
10542
10543
10544 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10545 .cindex "expansion" "RFC 2047"
10546 .cindex "RFC 2047" "decoding"
10547 .cindex "&%rfc2047d%& expansion item"
10548 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10549 bytes are replaced by question marks. Characters are converted into the
10550 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10551 not recognized unless &%check_rfc2047_length%& is set false.
10552
10553 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10554 access a header line, RFC 2047 decoding is done automatically. You do not need
10555 to use this operator as well.
10556
10557
10558
10559 .vitem &*${rxquote:*&<&'string'&>&*}*&
10560 .cindex "quoting" "in regular expressions"
10561 .cindex "regular expressions" "quoting"
10562 .cindex "&%rxquote%& expansion item"
10563 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10564 characters in its argument. This is useful when substituting the values of
10565 variables or headers inside regular expressions.
10566
10567
10568 .vitem &*${sha1:*&<&'string'&>&*}*&
10569 .cindex "SHA-1 hash"
10570 .cindex "expansion" "SHA-1 hashing"
10571 .cindex certificate fingerprint
10572 .cindex "&%sha1%& expansion item"
10573 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10574 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10575
10576 If the string is a single variable of type certificate,
10577 returns the SHA-1 hash fingerprint of the certificate.
10578
10579
10580 .vitem &*${sha256:*&<&'string'&>&*}*&
10581 .cindex "SHA-256 hash"
10582 .cindex certificate fingerprint
10583 .cindex "expansion" "SHA-256 hashing"
10584 .cindex "&%sha256%& expansion item"
10585 .new
10586 The &%sha256%& operator computes the SHA-256 hash value of the string
10587 and returns
10588 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10589 .wen
10590
10591 If the string is a single variable of type certificate,
10592 returns the SHA-256 hash fingerprint of the certificate.
10593
10594
10595 .new
10596 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10597        &*${sha3_<n>:*&<&'string'&>&*}*&
10598 .cindex "SHA3 hash"
10599 .cindex "expansion" "SHA3 hashing"
10600 .cindex "&%sha3%& expansion item"
10601 The &%sha3%& operator computes the SHA3-256 hash value of the string
10602 and returns
10603 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10604
10605 If a number is appended, separated by an underbar, it specifies
10606 the output length.  Values of 224, 256, 384 and 512 are accepted;
10607 with 256 being the default.
10608
10609 The &%sha3%& expansion item is only supported if Exim has been
10610 compiled with GnuTLS 3.5.0 or later.
10611 .wen
10612
10613
10614 .vitem &*${stat:*&<&'string'&>&*}*&
10615 .cindex "expansion" "statting a file"
10616 .cindex "file" "extracting characteristics"
10617 .cindex "&%stat%& expansion item"
10618 The string, after expansion, must be a file path. A call to the &[stat()]&
10619 function is made for this path. If &[stat()]& fails, an error occurs and the
10620 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10621 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10622 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10623 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10624 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10625 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10626 can extract individual fields using the &%extract%& expansion item.
10627
10628 The use of the &%stat%& expansion in users' filter files can be locked out by
10629 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10630 systems for files larger than 2GB.
10631
10632 .vitem &*${str2b64:*&<&'string'&>&*}*&
10633 .cindex "&%str2b64%& expansion item"
10634 Now deprecated, a synonym for the &%base64%& expansion operator.
10635
10636
10637
10638 .vitem &*${strlen:*&<&'string'&>&*}*&
10639 .cindex "expansion" "string length"
10640 .cindex "string" "length in expansion"
10641 .cindex "&%strlen%& expansion item"
10642 The item is replace by the length of the expanded string, expressed as a
10643 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10644
10645
10646 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10647 .cindex "&%substr%& expansion item"
10648 .cindex "substring extraction"
10649 .cindex "expansion" "substring expansion"
10650 The &%substr%& operator is a simpler interface to the &%substr%& function that
10651 can be used when the two parameters are fixed numbers (as opposed to strings
10652 that change when expanded). The effect is the same as
10653 .code
10654 ${substr{<start>}{<length>}{<string>}}
10655 .endd
10656 See the description of the general &%substr%& item above for details. The
10657 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10658
10659 .vitem &*${time_eval:*&<&'string'&>&*}*&
10660 .cindex "&%time_eval%& expansion item"
10661 .cindex "time interval" "decoding"
10662 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10663 seconds.
10664
10665 .vitem &*${time_interval:*&<&'string'&>&*}*&
10666 .cindex "&%time_interval%& expansion item"
10667 .cindex "time interval" "formatting"
10668 The argument (after sub-expansion) must be a sequence of decimal digits that
10669 represents an interval of time as a number of seconds. It is converted into a
10670 number of larger units and output in Exim's normal time format, for example,
10671 &`1w3d4h2m6s`&.
10672
10673 .vitem &*${uc:*&<&'string'&>&*}*&
10674 .cindex "case forcing in strings"
10675 .cindex "string" "case forcing"
10676 .cindex "upper casing"
10677 .cindex "expansion" "case forcing"
10678 .cindex "&%uc%& expansion item"
10679 This forces the letters in the string into upper-case.
10680
10681 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10682 .cindex "correction of invalid utf-8 sequences in strings"
10683 .cindex "utf-8" "utf-8 sequences"
10684 .cindex "incorrect utf-8"
10685 .cindex "expansion" "utf-8 forcing"
10686 .cindex "&%utf8clean%& expansion item"
10687 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10688
10689 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10690        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10691        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10692        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10693 .cindex expansion UTF-8
10694 .cindex UTF-8 expansion
10695 .cindex EAI
10696 .cindex internationalisation
10697 .cindex "&%utf8_domain_to_alabel%& expansion item"
10698 .cindex "&%utf8_domain_from_alabel%& expansion item"
10699 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10700 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10701 These convert EAI mail name components between UTF-8 and a-label forms.
10702 For information on internationalisation support see &<<SECTi18nMTA>>&.
10703 .endlist
10704
10705
10706
10707
10708
10709
10710 .section "Expansion conditions" "SECTexpcond"
10711 .scindex IIDexpcond "expansion" "conditions"
10712 The following conditions are available for testing by the &%${if%& construct
10713 while expanding strings:
10714
10715 .vlist
10716 .vitem &*!*&<&'condition'&>
10717 .cindex "expansion" "negating a condition"
10718 .cindex "negation" "in expansion condition"
10719 Preceding any condition with an exclamation mark negates the result of the
10720 condition.
10721
10722 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10723 .cindex "numeric comparison"
10724 .cindex "expansion" "numeric comparison"
10725 There are a number of symbolic operators for doing numeric comparisons. They
10726 are:
10727 .display
10728 &`=   `&   equal
10729 &`==  `&   equal
10730 &`>   `&   greater
10731 &`>=  `&   greater or equal
10732 &`<   `&   less
10733 &`<=  `&   less or equal
10734 .endd
10735 For example:
10736 .code
10737 ${if >{$message_size}{10M} ...
10738 .endd
10739 Note that the general negation operator provides for inequality testing. The
10740 two strings must take the form of optionally signed decimal integers,
10741 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10742 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10743 As a special case, the numerical value of an empty string is taken as
10744 zero.
10745
10746 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10747 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10748 10M, not if 10M is larger than &$message_size$&.
10749
10750
10751 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10752         {*&<&'arg2'&>&*}...}*&
10753 .cindex "expansion" "calling an acl"
10754 .cindex "&%acl%&" "expansion condition"
10755 The name and zero to nine argument strings are first expanded separately.  The expanded
10756 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10757 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10758 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10759 and may use the variables; if another acl expansion is used the values
10760 are restored after it returns.  If the ACL sets
10761 a value using a "message =" modifier the variable $value becomes
10762 the result of the expansion, otherwise it is empty.
10763 If the ACL returns accept the condition is true; if deny, false.
10764 If the ACL returns defer the result is a forced-fail.
10765
10766 .vitem &*bool&~{*&<&'string'&>&*}*&
10767 .cindex "expansion" "boolean parsing"
10768 .cindex "&%bool%& expansion condition"
10769 This condition turns a string holding a true or false representation into
10770 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10771 (case-insensitively); also integer numbers map to true if non-zero,
10772 false if zero.
10773 An empty string is treated as false.
10774 Leading and trailing whitespace is ignored;
10775 thus a string consisting only of whitespace is false.
10776 All other string values will result in expansion failure.
10777
10778 When combined with ACL variables, this expansion condition will let you
10779 make decisions in one place and act on those decisions in another place.
10780 For example:
10781 .code
10782 ${if bool{$acl_m_privileged_sender} ...
10783 .endd
10784
10785
10786 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10787 .cindex "expansion" "boolean parsing"
10788 .cindex "&%bool_lax%& expansion condition"
10789 Like &%bool%&, this condition turns a string into a boolean state.  But
10790 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10791 loose definition that the Router &%condition%& option uses.  The empty string
10792 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10793 true.  Leading and trailing whitespace is ignored.
10794
10795 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10796
10797 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10798 .cindex "expansion" "encrypted comparison"
10799 .cindex "encrypted strings, comparing"
10800 .cindex "&%crypteq%& expansion condition"
10801 This condition is included in the Exim binary if it is built to support any
10802 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10803 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10804 included in the binary.
10805
10806 The &%crypteq%& condition has two arguments. The first is encrypted and
10807 compared against the second, which is already encrypted. The second string may
10808 be in the LDAP form for storing encrypted strings, which starts with the
10809 encryption type in curly brackets, followed by the data. If the second string
10810 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10811 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10812 Typically this will be a field from a password file. An example of an encrypted
10813 string in LDAP form is:
10814 .code
10815 {md5}CY9rzUYh03PK3k6DJie09g==
10816 .endd
10817 If such a string appears directly in an expansion, the curly brackets have to
10818 be quoted, because they are part of the expansion syntax. For example:
10819 .code
10820 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10821 .endd
10822 The following encryption types (whose names are matched case-independently) are
10823 supported:
10824
10825 .ilist
10826 .cindex "MD5 hash"
10827 .cindex "base64 encoding" "in encrypted password"
10828 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10829 printable characters to compare with the remainder of the second string. If the
10830 length of the comparison string is 24, Exim assumes that it is base64 encoded
10831 (as in the above example). If the length is 32, Exim assumes that it is a
10832 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10833 comparison fails.
10834
10835 .next
10836 .cindex "SHA-1 hash"
10837 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10838 printable characters to compare with the remainder of the second string. If the
10839 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10840 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10841 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10842
10843 .next
10844 .cindex "&[crypt()]&"
10845 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10846 only the first eight characters of the password. However, in modern operating
10847 systems this is no longer true, and in many cases the entire password is used,
10848 whatever its length.
10849
10850 .next
10851 .cindex "&[crypt16()]&"
10852 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10853 use up to 16 characters of the password in some operating systems. Again, in
10854 modern operating systems, more characters may be used.
10855 .endlist
10856 Exim has its own version of &[crypt16()]&, which is just a double call to
10857 &[crypt()]&. For operating systems that have their own version, setting
10858 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10859 operating system version instead of its own. This option is set by default in
10860 the OS-dependent &_Makefile_& for those operating systems that are known to
10861 support &[crypt16()]&.
10862
10863 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10864 it was not using the same algorithm as some operating systems' versions. It
10865 turns out that as well as &[crypt16()]& there is a function called
10866 &[bigcrypt()]& in some operating systems. This may or may not use the same
10867 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10868
10869 However, since there is now a move away from the traditional &[crypt()]&
10870 functions towards using SHA1 and other algorithms, tidying up this area of
10871 Exim is seen as very low priority.
10872
10873 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10874 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10875 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10876 default is &`{crypt}`&. Whatever the default, you can always use either
10877 function by specifying it explicitly in curly brackets.
10878
10879 .vitem &*def:*&<&'variable&~name'&>
10880 .cindex "expansion" "checking for empty variable"
10881 .cindex "&%def%& expansion condition"
10882 The &%def%& condition must be followed by the name of one of the expansion
10883 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10884 variable does not contain the empty string. For example:
10885 .code
10886 ${if def:sender_ident {from $sender_ident}}
10887 .endd
10888 Note that the variable name is given without a leading &%$%& character. If the
10889 variable does not exist, the expansion fails.
10890
10891 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10892         &~&*def:h_*&<&'header&~name'&>&*:*&"
10893 .cindex "expansion" "checking header line existence"
10894 This condition is true if a message is being processed and the named header
10895 exists in the message. For example,
10896 .code
10897 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10898 .endd
10899 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10900 the header name must be terminated by a colon if white space does not follow.
10901
10902 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10903        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10904 .cindex "string" "comparison"
10905 .cindex "expansion" "string comparison"
10906 .cindex "&%eq%& expansion condition"
10907 .cindex "&%eqi%& expansion condition"
10908 The two substrings are first expanded. The condition is true if the two
10909 resulting strings are identical. For &%eq%& the comparison includes the case of
10910 letters, whereas for &%eqi%& the comparison is case-independent.
10911
10912 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10913 .cindex "expansion" "file existence test"
10914 .cindex "file" "existence test"
10915 .cindex "&%exists%&, expansion condition"
10916 The substring is first expanded and then interpreted as an absolute path. The
10917 condition is true if the named file (or directory) exists. The existence test
10918 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10919 users' filter files may be locked out by the system administrator.
10920
10921 .vitem &*first_delivery*&
10922 .cindex "delivery" "first"
10923 .cindex "first delivery"
10924 .cindex "expansion" "first delivery test"
10925 .cindex "&%first_delivery%& expansion condition"
10926 This condition, which has no data, is true during a message's first delivery
10927 attempt. It is false during any subsequent delivery attempts.
10928
10929
10930 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10931        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10932 .cindex "list" "iterative conditions"
10933 .cindex "expansion" "&*forall*& condition"
10934 .cindex "expansion" "&*forany*& condition"
10935 .vindex "&$item$&"
10936 These conditions iterate over a list. The first argument is expanded to form
10937 the list. By default, the list separator is a colon, but it can be changed by
10938 the normal method. The second argument is interpreted as a condition that is to
10939 be applied to each item in the list in turn. During the interpretation of the
10940 condition, the current list item is placed in a variable called &$item$&.
10941 .ilist
10942 For &*forany*&, interpretation stops if the condition is true for any item, and
10943 the result of the whole condition is true. If the condition is false for all
10944 items in the list, the overall condition is false.
10945 .next
10946 For &*forall*&, interpretation stops if the condition is false for any item,
10947 and the result of the whole condition is false. If the condition is true for
10948 all items in the list, the overall condition is true.
10949 .endlist
10950 Note that negation of &*forany*& means that the condition must be false for all
10951 items for the overall condition to succeed, and negation of &*forall*& means
10952 that the condition must be false for at least one item. In this example, the
10953 list separator is changed to a comma:
10954 .code
10955 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10956 .endd
10957 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10958 being processed, to enable these expansion items to be nested.
10959
10960 To scan a named list, expand it with the &*listnamed*& operator.
10961
10962
10963 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10964        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10965 .cindex "string" "comparison"
10966 .cindex "expansion" "string comparison"
10967 .cindex "&%ge%& expansion condition"
10968 .cindex "&%gei%& expansion condition"
10969 The two substrings are first expanded. The condition is true if the first
10970 string is lexically greater than or equal to the second string. For &%ge%& the
10971 comparison includes the case of letters, whereas for &%gei%& the comparison is
10972 case-independent.
10973
10974 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10975        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10976 .cindex "string" "comparison"
10977 .cindex "expansion" "string comparison"
10978 .cindex "&%gt%& expansion condition"
10979 .cindex "&%gti%& expansion condition"
10980 The two substrings are first expanded. The condition is true if the first
10981 string is lexically greater than the second string. For &%gt%& the comparison
10982 includes the case of letters, whereas for &%gti%& the comparison is
10983 case-independent.
10984
10985 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10986        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10987 .cindex "string" "comparison"
10988 .cindex "list" "iterative conditions"
10989 Both strings are expanded; the second string is treated as a list of simple
10990 strings; if the first string is a member of the second, then the condition
10991 is true.
10992
10993 These are simpler to use versions of the more powerful &*forany*& condition.
10994 Examples, and the &*forany*& equivalents:
10995 .code
10996 ${if inlist{needle}{foo:needle:bar}}
10997   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10998 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10999   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11000 .endd
11001
11002 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11003        &*isip4&~{*&<&'string'&>&*}*& &&&
11004        &*isip6&~{*&<&'string'&>&*}*&
11005 .cindex "IP address" "testing string format"
11006 .cindex "string" "testing for IP address"
11007 .cindex "&%isip%& expansion condition"
11008 .cindex "&%isip4%& expansion condition"
11009 .cindex "&%isip6%& expansion condition"
11010 The substring is first expanded, and then tested to see if it has the form of
11011 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11012 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11013
11014 For an IPv4 address, the test is for four dot-separated components, each of
11015 which consists of from one to three digits. For an IPv6 address, up to eight
11016 colon-separated components are permitted, each containing from one to four
11017 hexadecimal digits. There may be fewer than eight components if an empty
11018 component (adjacent colons) is present. Only one empty component is permitted.
11019
11020 &*Note*&: The checks are just on the form of the address; actual numerical
11021 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
11022 check. The main use of these tests is to distinguish between IP addresses and
11023 host names, or between IPv4 and IPv6 addresses. For example, you could use
11024 .code
11025 ${if isip4{$sender_host_address}...
11026 .endd
11027 to test which IP version an incoming SMTP connection is using.
11028
11029 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11030 .cindex "LDAP" "use for authentication"
11031 .cindex "expansion" "LDAP authentication test"
11032 .cindex "&%ldapauth%& expansion condition"
11033 This condition supports user authentication using LDAP. See section
11034 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11035 queries. For this use, the query must contain a user name and password. The
11036 query itself is not used, and can be empty. The condition is true if the
11037 password is not empty, and the user name and password are accepted by the LDAP
11038 server. An empty password is rejected without calling LDAP because LDAP binds
11039 with an empty password are considered anonymous regardless of the username, and
11040 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11041 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11042 this can be used.
11043
11044
11045 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11046        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11047 .cindex "string" "comparison"
11048 .cindex "expansion" "string comparison"
11049 .cindex "&%le%& expansion condition"
11050 .cindex "&%lei%& expansion condition"
11051 The two substrings are first expanded. The condition is true if the first
11052 string is lexically less than or equal to the second string. For &%le%& the
11053 comparison includes the case of letters, whereas for &%lei%& the comparison is
11054 case-independent.
11055
11056 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11057        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11058 .cindex "string" "comparison"
11059 .cindex "expansion" "string comparison"
11060 .cindex "&%lt%& expansion condition"
11061 .cindex "&%lti%& expansion condition"
11062 The two substrings are first expanded. The condition is true if the first
11063 string is lexically less than the second string. For &%lt%& the comparison
11064 includes the case of letters, whereas for &%lti%& the comparison is
11065 case-independent.
11066
11067
11068 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11069 .cindex "expansion" "regular expression comparison"
11070 .cindex "regular expressions" "match in expanded string"
11071 .cindex "&%match%& expansion condition"
11072 The two substrings are first expanded. The second is then treated as a regular
11073 expression and applied to the first. Because of the pre-expansion, if the
11074 regular expression contains dollar, or backslash characters, they must be
11075 escaped. Care must also be taken if the regular expression contains braces
11076 (curly brackets). A closing brace must be escaped so that it is not taken as a
11077 premature termination of <&'string2'&>. The easiest approach is to use the
11078 &`\N`& feature to disable expansion of the regular expression.
11079 For example,
11080 .code
11081 ${if match {$local_part}{\N^\d{3}\N} ...
11082 .endd
11083 If the whole expansion string is in double quotes, further escaping of
11084 backslashes is also required.
11085
11086 The condition is true if the regular expression match succeeds.
11087 The regular expression is not required to begin with a circumflex
11088 metacharacter, but if there is no circumflex, the expression is not anchored,
11089 and it may match anywhere in the subject, not just at the start. If you want
11090 the pattern to match at the end of the subject, you must include the &`$`&
11091 metacharacter at an appropriate point.
11092
11093 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11094 At the start of an &%if%& expansion the values of the numeric variable
11095 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11096 succeeds causes them to be reset to the substrings of that condition and they
11097 will have these values during the expansion of the success string. At the end
11098 of the &%if%& expansion, the previous values are restored. After testing a
11099 combination of conditions using &%or%&, the subsequent values of the numeric
11100 variables are those of the condition that succeeded.
11101
11102 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11103 .cindex "&%match_address%& expansion condition"
11104 See &*match_local_part*&.
11105
11106 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11107 .cindex "&%match_domain%& expansion condition"
11108 See &*match_local_part*&.
11109
11110 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11111 .cindex "&%match_ip%& expansion condition"
11112 This condition matches an IP address to a list of IP address patterns. It must
11113 be followed by two argument strings. The first (after expansion) must be an IP
11114 address or an empty string. The second (not expanded) is a restricted host
11115 list that can match only an IP address, not a host name. For example:
11116 .code
11117 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11118 .endd
11119 The specific types of host list item that are permitted in the list are:
11120
11121 .ilist
11122 An IP address, optionally with a CIDR mask.
11123 .next
11124 A single asterisk, which matches any IP address.
11125 .next
11126 An empty item, which matches only if the IP address is empty. This could be
11127 useful for testing for a locally submitted message or one from specific hosts
11128 in a single test such as
11129 . ==== As this is a nested list, any displays it contains must be indented
11130 . ==== as otherwise they are too far to the left. This comment applies to
11131 . ==== the use of xmlto plus fop. There's no problem when formatting with
11132 . ==== sdop, with or without the extra indent.
11133 .code
11134   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11135 .endd
11136 where the first item in the list is the empty string.
11137 .next
11138 The item @[] matches any of the local host's interface addresses.
11139 .next
11140 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11141 even if &`net-`& is not specified. There is never any attempt to turn the IP
11142 address into a host name. The most common type of linear search for
11143 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11144 masks. For example:
11145 .code
11146   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11147 .endd
11148 It is of course possible to use other kinds of lookup, and in such a case, you
11149 do need to specify the &`net-`& prefix if you want to specify a specific
11150 address mask, for example:
11151 .code
11152   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11153 .endd
11154 However, unless you are combining a &%match_ip%& condition with others, it is
11155 just as easy to use the fact that a lookup is itself a condition, and write:
11156 .code
11157   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11158 .endd
11159 .endlist ilist
11160
11161 Note that <&'string2'&> is not itself subject to string expansion, unless
11162 Exim was built with the EXPAND_LISTMATCH_RHS option.
11163
11164 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11165
11166 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11167 .cindex "domain list" "in expansion condition"
11168 .cindex "address list" "in expansion condition"
11169 .cindex "local part" "list, in expansion condition"
11170 .cindex "&%match_local_part%& expansion condition"
11171 This condition, together with &%match_address%& and &%match_domain%&, make it
11172 possible to test domain, address, and local part lists within expansions. Each
11173 condition requires two arguments: an item and a list to match. A trivial
11174 example is:
11175 .code
11176 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11177 .endd
11178 In each case, the second argument may contain any of the allowable items for a
11179 list of the appropriate type. Also, because the second argument (after
11180 expansion) is a standard form of list, it is possible to refer to a named list.
11181 Thus, you can use conditions like this:
11182 .code
11183 ${if match_domain{$domain}{+local_domains}{...
11184 .endd
11185 .cindex "&`+caseful`&"
11186 For address lists, the matching starts off caselessly, but the &`+caseful`&
11187 item can be used, as in all address lists, to cause subsequent items to
11188 have their local parts matched casefully. Domains are always matched
11189 caselessly.
11190
11191 Note that <&'string2'&> is not itself subject to string expansion, unless
11192 Exim was built with the EXPAND_LISTMATCH_RHS option.
11193
11194 &*Note*&: Host lists are &'not'& supported in this way. This is because
11195 hosts have two identities: a name and an IP address, and it is not clear
11196 how to specify cleanly how such a test would work. However, IP addresses can be
11197 matched using &%match_ip%&.
11198
11199 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11200 .cindex "PAM authentication"
11201 .cindex "AUTH" "with PAM"
11202 .cindex "Solaris" "PAM support"
11203 .cindex "expansion" "PAM authentication test"
11204 .cindex "&%pam%& expansion condition"
11205 &'Pluggable Authentication Modules'&
11206 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11207 available in the latest releases of Solaris and in some GNU/Linux
11208 distributions. The Exim support, which is intended for use in conjunction with
11209 the SMTP AUTH command, is available only if Exim is compiled with
11210 .code
11211 SUPPORT_PAM=yes
11212 .endd
11213 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11214 in some releases of GNU/Linux &%-ldl%& is also needed.
11215
11216 The argument string is first expanded, and the result must be a
11217 colon-separated list of strings. Leading and trailing white space is ignored.
11218 The PAM module is initialized with the service name &"exim"& and the user name
11219 taken from the first item in the colon-separated data string (<&'string1'&>).
11220 The remaining items in the data string are passed over in response to requests
11221 from the authentication function. In the simple case there will only be one
11222 request, for a password, so the data consists of just two strings.
11223
11224 There can be problems if any of the strings are permitted to contain colon
11225 characters. In the usual way, these have to be doubled to avoid being taken as
11226 separators. If the data is being inserted from a variable, the &%sg%& expansion
11227 item can be used to double any existing colons. For example, the configuration
11228 of a LOGIN authenticator might contain this setting:
11229 .code
11230 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11231 .endd
11232 For a PLAIN authenticator you could use:
11233 .code
11234 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11235 .endd
11236 In some operating systems, PAM authentication can be done only from a process
11237 running as root. Since Exim is running as the Exim user when receiving
11238 messages, this means that PAM cannot be used directly in those systems.
11239 A patched version of the &'pam_unix'& module that comes with the
11240 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11241 The patched module allows one special uid/gid combination, in addition to root,
11242 to authenticate. If you build the patched module to allow the Exim user and
11243 group, PAM can then be used from an Exim authenticator.
11244
11245
11246 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11247 .cindex "&'pwcheck'& daemon"
11248 .cindex "Cyrus"
11249 .cindex "expansion" "&'pwcheck'& authentication test"
11250 .cindex "&%pwcheck%& expansion condition"
11251 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11252 This is one way of making it possible for passwords to be checked by a process
11253 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11254 deprecated. Its replacement is &'saslauthd'& (see below).
11255
11256 The pwcheck support is not included in Exim by default. You need to specify
11257 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11258 building Exim. For example:
11259 .code
11260 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11261 .endd
11262 You do not need to install the full Cyrus software suite in order to use
11263 the pwcheck daemon. You can compile and install just the daemon alone
11264 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11265 access to the &_/var/pwcheck_& directory.
11266
11267 The &%pwcheck%& condition takes one argument, which must be the user name and
11268 password, separated by a colon. For example, in a LOGIN authenticator
11269 configuration, you might have this:
11270 .code
11271 server_condition = ${if pwcheck{$auth1:$auth2}}
11272 .endd
11273 Again, for a PLAIN authenticator configuration, this would be:
11274 .code
11275 server_condition = ${if pwcheck{$auth2:$auth3}}
11276 .endd
11277 .vitem &*queue_running*&
11278 .cindex "queue runner" "detecting when delivering from"
11279 .cindex "expansion" "queue runner test"
11280 .cindex "&%queue_running%& expansion condition"
11281 This condition, which has no data, is true during delivery attempts that are
11282 initiated by queue runner processes, and false otherwise.
11283
11284
11285 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11286 .cindex "Radius"
11287 .cindex "expansion" "Radius authentication"
11288 .cindex "&%radius%& expansion condition"
11289 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11290 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11291 the Radius client configuration file in order to build Exim with Radius
11292 support.
11293
11294 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11295 library, using the original API. If you are using release 0.4.0 or later of
11296 this library, you need to set
11297 .code
11298 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11299 .endd
11300 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11301 &%libradius%& library that comes with FreeBSD. To do this, set
11302 .code
11303 RADIUS_LIB_TYPE=RADLIB
11304 .endd
11305 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11306 You may also have to supply a suitable setting in EXTRALIBS so that the
11307 Radius library can be found when Exim is linked.
11308
11309 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11310 Radius client library, which calls the Radius server. The condition is true if
11311 the authentication is successful. For example:
11312 .code
11313 server_condition = ${if radius{<arguments>}}
11314 .endd
11315
11316
11317 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11318         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11319 .cindex "&'saslauthd'& daemon"
11320 .cindex "Cyrus"
11321 .cindex "expansion" "&'saslauthd'& authentication test"
11322 .cindex "&%saslauthd%& expansion condition"
11323 This condition supports user authentication using the Cyrus &'saslauthd'&
11324 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11325 Using this daemon is one way of making it possible for passwords to be checked
11326 by a process that is not running as root.
11327
11328 The saslauthd support is not included in Exim by default. You need to specify
11329 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11330 building Exim. For example:
11331 .code
11332 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11333 .endd
11334 You do not need to install the full Cyrus software suite in order to use
11335 the saslauthd daemon. You can compile and install just the daemon alone
11336 from the Cyrus SASL library.
11337
11338 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11339 two are mandatory. For example:
11340 .code
11341 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11342 .endd
11343 The service and the realm are optional (which is why the arguments are enclosed
11344 in their own set of braces). For details of the meaning of the service and
11345 realm, and how to run the daemon, consult the Cyrus documentation.
11346 .endlist vlist
11347
11348
11349
11350 .section "Combining expansion conditions" "SECID84"
11351 .cindex "expansion" "combining conditions"
11352 Several conditions can be tested at once by combining them using the &%and%&
11353 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11354 conditions on their own, and precede their lists of sub-conditions. Each
11355 sub-condition must be enclosed in braces within the overall braces that contain
11356 the list. No repetition of &%if%& is used.
11357
11358
11359 .vlist
11360 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11361 .cindex "&""or""& expansion condition"
11362 .cindex "expansion" "&""or""& of conditions"
11363 The sub-conditions are evaluated from left to right. The condition is true if
11364 any one of the sub-conditions is true.
11365 For example,
11366 .code
11367 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11368 .endd
11369 When a true sub-condition is found, the following ones are parsed but not
11370 evaluated. If there are several &"match"& sub-conditions the values of the
11371 numeric variables afterwards are taken from the first one that succeeds.
11372
11373 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11374 .cindex "&""and""& expansion condition"
11375 .cindex "expansion" "&""and""& of conditions"
11376 The sub-conditions are evaluated from left to right. The condition is true if
11377 all of the sub-conditions are true. If there are several &"match"&
11378 sub-conditions, the values of the numeric variables afterwards are taken from
11379 the last one. When a false sub-condition is found, the following ones are
11380 parsed but not evaluated.
11381 .endlist
11382 .ecindex IIDexpcond
11383
11384
11385
11386
11387 .section "Expansion variables" "SECTexpvar"
11388 .cindex "expansion" "variables, list of"
11389 This section contains an alphabetical list of all the expansion variables. Some
11390 of them are available only when Exim is compiled with specific options such as
11391 support for TLS or the content scanning extension.
11392
11393 .vlist
11394 .vitem "&$0$&, &$1$&, etc"
11395 .cindex "numerical variables (&$1$& &$2$& etc)"
11396 When a &%match%& expansion condition succeeds, these variables contain the
11397 captured substrings identified by the regular expression during subsequent
11398 processing of the success string of the containing &%if%& expansion item.
11399 In the expansion condition case
11400 they do not retain their values afterwards; in fact, their previous
11401 values are restored at the end of processing an &%if%& item. The numerical
11402 variables may also be set externally by some other matching process which
11403 precedes the expansion of the string. For example, the commands available in
11404 Exim filter files include an &%if%& command with its own regular expression
11405 matching condition.
11406
11407 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11408 Within an acl condition, expansion condition or expansion item
11409 any arguments are copied to these variables,
11410 any unused variables being made empty.
11411
11412 .vitem "&$acl_c...$&"
11413 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11414 can be given any name that starts with &$acl_c$& and is at least six characters
11415 long, but the sixth character must be either a digit or an underscore. For
11416 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11417 variables persist throughout the lifetime of an SMTP connection. They can be
11418 used to pass information between ACLs and between different invocations of the
11419 same ACL. When a message is received, the values of these variables are saved
11420 with the message, and can be accessed by filters, routers, and transports
11421 during subsequent delivery.
11422
11423 .vitem "&$acl_m...$&"
11424 These variables are like the &$acl_c...$& variables, except that their values
11425 are reset after a message has been received. Thus, if several messages are
11426 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11427 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11428 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11429 message is received, the values of these variables are saved with the message,
11430 and can be accessed by filters, routers, and transports during subsequent
11431 delivery.
11432
11433 .vitem &$acl_narg$&
11434 Within an acl condition, expansion condition or expansion item
11435 this variable has the number of arguments.
11436
11437 .vitem &$acl_verify_message$&
11438 .vindex "&$acl_verify_message$&"
11439 After an address verification has failed, this variable contains the failure
11440 message. It retains its value for use in subsequent modifiers. The message can
11441 be preserved by coding like this:
11442 .code
11443 warn !verify = sender
11444      set acl_m0 = $acl_verify_message
11445 .endd
11446 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11447 &%log_message%& modifiers, to include information about the verification
11448 failure.
11449
11450 .vitem &$address_data$&
11451 .vindex "&$address_data$&"
11452 This variable is set by means of the &%address_data%& option in routers. The
11453 value then remains with the address while it is processed by subsequent routers
11454 and eventually a transport. If the transport is handling multiple addresses,
11455 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11456 for more details. &*Note*&: The contents of &$address_data$& are visible in
11457 user filter files.
11458
11459 If &$address_data$& is set when the routers are called from an ACL to verify
11460 a recipient address, the final value is still in the variable for subsequent
11461 conditions and modifiers of the ACL statement. If routing the address caused it
11462 to be redirected to just one address, the child address is also routed as part
11463 of the verification, and in this case the final value of &$address_data$& is
11464 from the child's routing.
11465
11466 If &$address_data$& is set when the routers are called from an ACL to verify a
11467 sender address, the final value is also preserved, but this time in
11468 &$sender_address_data$&, to distinguish it from data from a recipient
11469 address.
11470
11471 In both cases (recipient and sender verification), the value does not persist
11472 after the end of the current ACL statement. If you want to preserve
11473 these values for longer, you can save them in ACL variables.
11474
11475 .vitem &$address_file$&
11476 .vindex "&$address_file$&"
11477 When, as a result of aliasing, forwarding, or filtering, a message is directed
11478 to a specific file, this variable holds the name of the file when the transport
11479 is running. At other times, the variable is empty. For example, using the
11480 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11481 .code
11482 /home/r2d2/savemail
11483 .endd
11484 then when the &(address_file)& transport is running, &$address_file$&
11485 contains the text string &`/home/r2d2/savemail`&.
11486 .cindex "Sieve filter" "value of &$address_file$&"
11487 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11488 then up to the transport configuration to generate an appropriate absolute path
11489 to the relevant file.
11490
11491 .vitem &$address_pipe$&
11492 .vindex "&$address_pipe$&"
11493 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11494 this variable holds the pipe command when the transport is running.
11495
11496 .vitem "&$auth1$& &-- &$auth3$&"
11497 .vindex "&$auth1$&, &$auth2$&, etc"
11498 These variables are used in SMTP authenticators (see chapters
11499 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11500
11501 .vitem &$authenticated_id$&
11502 .cindex "authentication" "id"
11503 .vindex "&$authenticated_id$&"
11504 When a server successfully authenticates a client it may be configured to
11505 preserve some of the authentication information in the variable
11506 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11507 user/password authenticator configuration might preserve the user name for use
11508 in the routers. Note that this is not the same information that is saved in
11509 &$sender_host_authenticated$&.
11510 When a message is submitted locally (that is, not over a TCP connection)
11511 the value of &$authenticated_id$& is normally the login name of the calling
11512 process. However, a trusted user can override this by means of the &%-oMai%&
11513 command line option.
11514
11515 .vitem &$authenticated_fail_id$&
11516 .cindex "authentication" "fail" "id"
11517 .vindex "&$authenticated_fail_id$&"
11518 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11519 will contain the failed authentication id. If more than one authentication
11520 id is attempted, it will contain only the last one. The variable is
11521 available for processing in the ACL's, generally the quit or notquit ACL.
11522 A message to a local recipient could still be accepted without requiring
11523 authentication, which means this variable could also be visible in all of
11524 the ACL's as well.
11525
11526
11527 .vitem &$authenticated_sender$&
11528 .cindex "sender" "authenticated"
11529 .cindex "authentication" "sender"
11530 .cindex "AUTH" "on MAIL command"
11531 .vindex "&$authenticated_sender$&"
11532 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11533 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11534 described in section &<<SECTauthparamail>>&. Unless the data is the string
11535 &"<>"&, it is set as the authenticated sender of the message, and the value is
11536 available during delivery in the &$authenticated_sender$& variable. If the
11537 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11538
11539 .vindex "&$qualify_domain$&"
11540 When a message is submitted locally (that is, not over a TCP connection), the
11541 value of &$authenticated_sender$& is an address constructed from the login
11542 name of the calling process and &$qualify_domain$&, except that a trusted user
11543 can override this by means of the &%-oMas%& command line option.
11544
11545
11546 .vitem &$authentication_failed$&
11547 .cindex "authentication" "failure"
11548 .vindex "&$authentication_failed$&"
11549 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11550 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11551 possible to distinguish between &"did not try to authenticate"&
11552 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11553 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11554 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11555 negative response to an AUTH command, including (for example) an attempt to use
11556 an undefined mechanism.
11557
11558 .vitem &$av_failed$&
11559 .cindex "content scanning" "AV scanner failure"
11560 This variable is available when Exim is compiled with the content-scanning
11561 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11562 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11563 the ACL malware condition.
11564
11565 .vitem &$body_linecount$&
11566 .cindex "message body" "line count"
11567 .cindex "body of message" "line count"
11568 .vindex "&$body_linecount$&"
11569 When a message is being received or delivered, this variable contains the
11570 number of lines in the message's body. See also &$message_linecount$&.
11571
11572 .vitem &$body_zerocount$&
11573 .cindex "message body" "binary zero count"
11574 .cindex "body of message" "binary zero count"
11575 .cindex "binary zero" "in message body"
11576 .vindex "&$body_zerocount$&"
11577 When a message is being received or delivered, this variable contains the
11578 number of binary zero bytes (ASCII NULs) in the message's body.
11579
11580 .vitem &$bounce_recipient$&
11581 .vindex "&$bounce_recipient$&"
11582 This is set to the recipient address of a bounce message while Exim is creating
11583 it. It is useful if a customized bounce message text file is in use (see
11584 chapter &<<CHAPemsgcust>>&).
11585
11586 .vitem &$bounce_return_size_limit$&
11587 .vindex "&$bounce_return_size_limit$&"
11588 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11589 up to a multiple of 1000. It is useful when a customized error message text
11590 file is in use (see chapter &<<CHAPemsgcust>>&).
11591
11592 .vitem &$caller_gid$&
11593 .cindex "gid (group id)" "caller"
11594 .vindex "&$caller_gid$&"
11595 The real group id under which the process that called Exim was running. This is
11596 not the same as the group id of the originator of a message (see
11597 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11598 incarnation normally contains the Exim gid.
11599
11600 .vitem &$caller_uid$&
11601 .cindex "uid (user id)" "caller"
11602 .vindex "&$caller_uid$&"
11603 The real user id under which the process that called Exim was running. This is
11604 not the same as the user id of the originator of a message (see
11605 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11606 incarnation normally contains the Exim uid.
11607
11608 .vitem &$callout_address$&
11609 .vindex "&$callout_address$&"
11610 After a callout for verification, spamd or malware daemon service, the
11611 address that was connected to.
11612
11613 .vitem &$compile_number$&
11614 .vindex "&$compile_number$&"
11615 The building process for Exim keeps a count of the number
11616 of times it has been compiled. This serves to distinguish different
11617 compilations of the same version of the program.
11618
11619 .vitem &$config_dir$&
11620 .vindex "&$config_dir$&"
11621 The directory name of the main configuration file. That is, the content of
11622 &$config_file$& with the last component stripped. The value does not
11623 contain the trailing slash. If &$config_file$& does not contain a slash,
11624 &$config_dir$& is ".".
11625
11626 .vitem &$config_file$&
11627 .vindex "&$config_file$&"
11628 The name of the main configuration file Exim is using.
11629
11630 .vitem &$dkim_cur_signer$& &&&
11631        &$dkim_verify_status$& &&&
11632        &$dkim_verify_reason$& &&&
11633        &$dkim_domain$& &&&
11634        &$dkim_identity$& &&&
11635        &$dkim_selector$& &&&
11636        &$dkim_algo$& &&&
11637        &$dkim_canon_body$& &&&
11638        &$dkim_canon_headers$& &&&
11639        &$dkim_copiedheaders$& &&&
11640        &$dkim_bodylength$& &&&
11641        &$dkim_created$& &&&
11642        &$dkim_expires$& &&&
11643        &$dkim_headernames$& &&&
11644        &$dkim_key_testing$& &&&
11645        &$dkim_key_nosubdomains$& &&&
11646        &$dkim_key_srvtype$& &&&
11647        &$dkim_key_granularity$& &&&
11648        &$dkim_key_notes$& &&&
11649        &$dkim_key_length$&
11650 These variables are only available within the DKIM ACL.
11651 For details see chapter &<<CHAPdkim>>&.
11652
11653 .vitem &$dkim_signers$&
11654 .vindex &$dkim_signers$&
11655 When a message has been received this variable contains
11656 a colon-separated list of signer domains and identities for the message.
11657 For details see chapter &<<CHAPdkim>>&.
11658
11659 .vitem &$dnslist_domain$& &&&
11660        &$dnslist_matched$& &&&
11661        &$dnslist_text$& &&&
11662        &$dnslist_value$&
11663 .vindex "&$dnslist_domain$&"
11664 .vindex "&$dnslist_matched$&"
11665 .vindex "&$dnslist_text$&"
11666 .vindex "&$dnslist_value$&"
11667 .cindex "black list (DNS)"
11668 When a DNS (black) list lookup succeeds, these variables are set to contain
11669 the following data from the lookup: the list's domain name, the key that was
11670 looked up, the contents of any associated TXT record, and the value from the
11671 main A record. See section &<<SECID204>>& for more details.
11672
11673 .vitem &$domain$&
11674 .vindex "&$domain$&"
11675 When an address is being routed, or delivered on its own, this variable
11676 contains the domain. Uppercase letters in the domain are converted into lower
11677 case for &$domain$&.
11678
11679 Global address rewriting happens when a message is received, so the value of
11680 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11681 is set during user filtering, but not during system filtering, because a
11682 message may have many recipients and the system filter is called just once.
11683
11684 When more than one address is being delivered at once (for example, several
11685 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11686 have the same domain. Transports can be restricted to handling only one domain
11687 at a time if the value of &$domain$& is required at transport time &-- this is
11688 the default for local transports. For further details of the environment in
11689 which local transports are run, see chapter &<<CHAPenvironment>>&.
11690
11691 .oindex "&%delay_warning_condition%&"
11692 At the end of a delivery, if all deferred addresses have the same domain, it is
11693 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11694
11695 The &$domain$& variable is also used in some other circumstances:
11696
11697 .ilist
11698 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11699 the recipient address. The domain of the &'sender'& address is in
11700 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11701 normally set during the running of the MAIL ACL. However, if the sender address
11702 is verified with a callout during the MAIL ACL, the sender domain is placed in
11703 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11704 the &(smtp)& transport.
11705
11706 .next
11707 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11708 &$domain$& contains the domain portion of the address that is being rewritten;
11709 it can be used in the expansion of the replacement address, for example, to
11710 rewrite domains by file lookup.
11711
11712 .next
11713 With one important exception, whenever a domain list is being scanned,
11714 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11715 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11716 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11717 that, in a RCPT ACL, the sender domain list can be dependent on the
11718 recipient domain (which is what is in &$domain$& at this time).
11719
11720 .next
11721 .cindex "ETRN" "value of &$domain$&"
11722 .oindex "&%smtp_etrn_command%&"
11723 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11724 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11725 .endlist
11726
11727
11728 .vitem &$domain_data$&
11729 .vindex "&$domain_data$&"
11730 When the &%domains%& option on a router matches a domain by
11731 means of a lookup, the data read by the lookup is available during the running
11732 of the router as &$domain_data$&. In addition, if the driver routes the
11733 address to a transport, the value is available in that transport. If the
11734 transport is handling multiple addresses, the value from the first address is
11735 used.
11736
11737 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11738 domain by means of a lookup. The data read by the lookup is available during
11739 the rest of the ACL statement. In all other situations, this variable expands
11740 to nothing.
11741
11742 .vitem &$exim_gid$&
11743 .vindex "&$exim_gid$&"
11744 This variable contains the numerical value of the Exim group id.
11745
11746 .vitem &$exim_path$&
11747 .vindex "&$exim_path$&"
11748 This variable contains the path to the Exim binary.
11749
11750 .vitem &$exim_uid$&
11751 .vindex "&$exim_uid$&"
11752 This variable contains the numerical value of the Exim user id.
11753
11754 .vitem &$exim_version$&
11755 .vindex "&$exim_version$&"
11756 This variable contains the version string of the Exim build.
11757 The first character is a major version number, currently 4.
11758 Then after a dot, the next group of digits is a minor version number.
11759 There may be other characters following the minor version.
11760
11761 .vitem &$header_$&<&'name'&>
11762 This is not strictly an expansion variable. It is expansion syntax for
11763 inserting the message header line with the given name. Note that the name must
11764 be terminated by colon or white space, because it may contain a wide variety of
11765 characters. Note also that braces must &'not'& be used.
11766
11767 .vitem &$headers_added$&
11768 .vindex "&$headers_added$&"
11769 Within an ACL this variable contains the headers added so far by
11770 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11771 The headers are a newline-separated list.
11772
11773 .vitem &$home$&
11774 .vindex "&$home$&"
11775 When the &%check_local_user%& option is set for a router, the user's home
11776 directory is placed in &$home$& when the check succeeds. In particular, this
11777 means it is set during the running of users' filter files. A router may also
11778 explicitly set a home directory for use by a transport; this can be overridden
11779 by a setting on the transport itself.
11780
11781 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11782 of the environment variable HOME, which is subject to the
11783 &%keep_environment%& and &%add_environment%& main config options.
11784
11785 .vitem &$host$&
11786 .vindex "&$host$&"
11787 If a router assigns an address to a transport (any transport), and passes a
11788 list of hosts with the address, the value of &$host$& when the transport starts
11789 to run is the name of the first host on the list. Note that this applies both
11790 to local and remote transports.
11791
11792 .cindex "transport" "filter"
11793 .cindex "filter" "transport filter"
11794 For the &(smtp)& transport, if there is more than one host, the value of
11795 &$host$& changes as the transport works its way through the list. In
11796 particular, when the &(smtp)& transport is expanding its options for encryption
11797 using TLS, or for specifying a transport filter (see chapter
11798 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11799 is connected.
11800
11801 When used in the client part of an authenticator configuration (see chapter
11802 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11803 client is connected.
11804
11805
11806 .vitem &$host_address$&
11807 .vindex "&$host_address$&"
11808 This variable is set to the remote host's IP address whenever &$host$& is set
11809 for a remote connection. It is also set to the IP address that is being checked
11810 when the &%ignore_target_hosts%& option is being processed.
11811
11812 .vitem &$host_data$&
11813 .vindex "&$host_data$&"
11814 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11815 result of the lookup is made available in the &$host_data$& variable. This
11816 allows you, for example, to do things like this:
11817 .code
11818 deny  hosts = net-lsearch;/some/file
11819 message = $host_data
11820 .endd
11821 .vitem &$host_lookup_deferred$&
11822 .cindex "host name" "lookup, failure of"
11823 .vindex "&$host_lookup_deferred$&"
11824 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11825 message comes from a remote host and there is an attempt to look up the host's
11826 name from its IP address, and the attempt is not successful, one of these
11827 variables is set to &"1"&.
11828
11829 .ilist
11830 If the lookup receives a definite negative response (for example, a DNS lookup
11831 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11832
11833 .next
11834 If there is any kind of problem during the lookup, such that Exim cannot
11835 tell whether or not the host name is defined (for example, a timeout for a DNS
11836 lookup), &$host_lookup_deferred$& is set to &"1"&.
11837 .endlist ilist
11838
11839 Looking up a host's name from its IP address consists of more than just a
11840 single reverse lookup. Exim checks that a forward lookup of at least one of the
11841 names it receives from a reverse lookup yields the original IP address. If this
11842 is not the case, Exim does not accept the looked up name(s), and
11843 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11844 IP address (for example, the existence of a PTR record in the DNS) is not
11845 sufficient on its own for the success of a host name lookup. If the reverse
11846 lookup succeeds, but there is a lookup problem such as a timeout when checking
11847 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11848 &"1"&. See also &$sender_host_name$&.
11849
11850 .vitem &$host_lookup_failed$&
11851 .vindex "&$host_lookup_failed$&"
11852 See &$host_lookup_deferred$&.
11853
11854 .vitem &$host_port$&
11855 .vindex "&$host_port$&"
11856 This variable is set to the remote host's TCP port whenever &$host$& is set
11857 for an outbound connection.
11858
11859 .vitem &$initial_cwd$&
11860 .vindex "&$initial_cwd$&
11861 This variable contains the full path name of the initial working
11862 directory of the current Exim process. This may differ from the current
11863 working directory, as Exim changes this to "/" during early startup, and
11864 to &$spool_directory$& later.
11865
11866 .vitem &$inode$&
11867 .vindex "&$inode$&"
11868 The only time this variable is set is while expanding the &%directory_file%&
11869 option in the &(appendfile)& transport. The variable contains the inode number
11870 of the temporary file which is about to be renamed. It can be used to construct
11871 a unique name for the file.
11872
11873 .vitem &$interface_address$&
11874 .vindex "&$interface_address$&"
11875 This is an obsolete name for &$received_ip_address$&.
11876
11877 .vitem &$interface_port$&
11878 .vindex "&$interface_port$&"
11879 This is an obsolete name for &$received_port$&.
11880
11881 .vitem &$item$&
11882 .vindex "&$item$&"
11883 This variable is used during the expansion of &*forall*& and &*forany*&
11884 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11885 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11886 empty.
11887
11888 .vitem &$ldap_dn$&
11889 .vindex "&$ldap_dn$&"
11890 This variable, which is available only when Exim is compiled with LDAP support,
11891 contains the DN from the last entry in the most recently successful LDAP
11892 lookup.
11893
11894 .vitem &$load_average$&
11895 .vindex "&$load_average$&"
11896 This variable contains the system load average, multiplied by 1000 so that it
11897 is an integer. For example, if the load average is 0.21, the value of the
11898 variable is 210. The value is recomputed every time the variable is referenced.
11899
11900 .vitem &$local_part$&
11901 .vindex "&$local_part$&"
11902 When an address is being routed, or delivered on its own, this
11903 variable contains the local part. When a number of addresses are being
11904 delivered together (for example, multiple RCPT commands in an SMTP
11905 session), &$local_part$& is not set.
11906
11907 Global address rewriting happens when a message is received, so the value of
11908 &$local_part$& during routing and delivery is the value after rewriting.
11909 &$local_part$& is set during user filtering, but not during system filtering,
11910 because a message may have many recipients and the system filter is called just
11911 once.
11912
11913 .vindex "&$local_part_prefix$&"
11914 .vindex "&$local_part_suffix$&"
11915 If a local part prefix or suffix has been recognized, it is not included in the
11916 value of &$local_part$& during routing and subsequent delivery. The values of
11917 any prefix or suffix are in &$local_part_prefix$& and
11918 &$local_part_suffix$&, respectively.
11919
11920 When a message is being delivered to a file, pipe, or autoreply transport as a
11921 result of aliasing or forwarding, &$local_part$& is set to the local part of
11922 the parent address, not to the file name or command (see &$address_file$& and
11923 &$address_pipe$&).
11924
11925 When an ACL is running for a RCPT command, &$local_part$& contains the
11926 local part of the recipient address.
11927
11928 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11929 &$local_part$& contains the local part of the address that is being rewritten;
11930 it can be used in the expansion of the replacement address, for example.
11931
11932 In all cases, all quoting is removed from the local part. For example, for both
11933 the addresses
11934 .code
11935 "abc:xyz"@test.example
11936 abc\:xyz@test.example
11937 .endd
11938 the value of &$local_part$& is
11939 .code
11940 abc:xyz
11941 .endd
11942 If you use &$local_part$& to create another address, you should always wrap it
11943 inside a quoting operator. For example, in a &(redirect)& router you could
11944 have:
11945 .code
11946 data = ${quote_local_part:$local_part}@new.domain.example
11947 .endd
11948 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11949 to process local parts in a case-dependent manner in a router, you can set the
11950 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11951
11952 .vitem &$local_part_data$&
11953 .vindex "&$local_part_data$&"
11954 When the &%local_parts%& option on a router matches a local part by means of a
11955 lookup, the data read by the lookup is available during the running of the
11956 router as &$local_part_data$&. In addition, if the driver routes the address
11957 to a transport, the value is available in that transport. If the transport is
11958 handling multiple addresses, the value from the first address is used.
11959
11960 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11961 matches a local part by means of a lookup. The data read by the lookup is
11962 available during the rest of the ACL statement. In all other situations, this
11963 variable expands to nothing.
11964
11965 .vitem &$local_part_prefix$&
11966 .vindex "&$local_part_prefix$&"
11967 When an address is being routed or delivered, and a
11968 specific prefix for the local part was recognized, it is available in this
11969 variable, having been removed from &$local_part$&.
11970
11971 .vitem &$local_part_suffix$&
11972 .vindex "&$local_part_suffix$&"
11973 When an address is being routed or delivered, and a
11974 specific suffix for the local part was recognized, it is available in this
11975 variable, having been removed from &$local_part$&.
11976
11977 .vitem &$local_scan_data$&
11978 .vindex "&$local_scan_data$&"
11979 This variable contains the text returned by the &[local_scan()]& function when
11980 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11981
11982 .vitem &$local_user_gid$&
11983 .vindex "&$local_user_gid$&"
11984 See &$local_user_uid$&.
11985
11986 .vitem &$local_user_uid$&
11987 .vindex "&$local_user_uid$&"
11988 This variable and &$local_user_gid$& are set to the uid and gid after the
11989 &%check_local_user%& router precondition succeeds. This means that their values
11990 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11991 and &%condition%&), for the &%address_data%& expansion, and for any
11992 router-specific expansions. At all other times, the values in these variables
11993 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11994
11995 .vitem &$localhost_number$&
11996 .vindex "&$localhost_number$&"
11997 This contains the expanded value of the
11998 &%localhost_number%& option. The expansion happens after the main options have
11999 been read.
12000
12001 .vitem &$log_inodes$&
12002 .vindex "&$log_inodes$&"
12003 The number of free inodes in the disk partition where Exim's
12004 log files are being written. The value is recalculated whenever the variable is
12005 referenced. If the relevant file system does not have the concept of inodes,
12006 the value of is -1. See also the &%check_log_inodes%& option.
12007
12008 .vitem &$log_space$&
12009 .vindex "&$log_space$&"
12010 The amount of free space (as a number of kilobytes) in the disk
12011 partition where Exim's log files are being written. The value is recalculated
12012 whenever the variable is referenced. If the operating system does not have the
12013 ability to find the amount of free space (only true for experimental systems),
12014 the space value is -1. See also the &%check_log_space%& option.
12015
12016
12017 .vitem &$lookup_dnssec_authenticated$&
12018 .vindex "&$lookup_dnssec_authenticated$&"
12019 This variable is set after a DNS lookup done by
12020 a dnsdb lookup expansion, dnslookup router or smtp transport.
12021 .cindex "DNS" "DNSSEC"
12022 It will be empty if &(DNSSEC)& was not requested,
12023 &"no"& if the result was not labelled as authenticated data
12024 and &"yes"& if it was.
12025 Results that are labelled as authoritative answer that match
12026 the &%dns_trust_aa%& configuration variable count also
12027 as authenticated data.
12028
12029 .vitem &$mailstore_basename$&
12030 .vindex "&$mailstore_basename$&"
12031 This variable is set only when doing deliveries in &"mailstore"& format in the
12032 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12033 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12034 contains the basename of the files that are being written, that is, the name
12035 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12036 variable is empty.
12037
12038 .vitem &$malware_name$&
12039 .vindex "&$malware_name$&"
12040 This variable is available when Exim is compiled with the
12041 content-scanning extension. It is set to the name of the virus that was found
12042 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12043
12044 .vitem &$max_received_linelength$&
12045 .vindex "&$max_received_linelength$&"
12046 .cindex "maximum" "line length"
12047 .cindex "line length" "maximum"
12048 This variable contains the number of bytes in the longest line that was
12049 received as part of the message, not counting the line termination
12050 character(s).
12051
12052 .vitem &$message_age$&
12053 .cindex "message" "age of"
12054 .vindex "&$message_age$&"
12055 This variable is set at the start of a delivery attempt to contain the number
12056 of seconds since the message was received. It does not change during a single
12057 delivery attempt.
12058
12059 .vitem &$message_body$&
12060 .cindex "body of message" "expansion variable"
12061 .cindex "message body" "in expansion"
12062 .cindex "binary zero" "in message body"
12063 .vindex "&$message_body$&"
12064 .oindex "&%message_body_visible%&"
12065 This variable contains the initial portion of a message's body while it is
12066 being delivered, and is intended mainly for use in filter files. The maximum
12067 number of characters of the body that are put into the variable is set by the
12068 &%message_body_visible%& configuration option; the default is 500.
12069
12070 .oindex "&%message_body_newlines%&"
12071 By default, newlines are converted into spaces in &$message_body$&, to make it
12072 easier to search for phrases that might be split over a line break. However,
12073 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12074 zeros are always converted into spaces.
12075
12076 .vitem &$message_body_end$&
12077 .cindex "body of message" "expansion variable"
12078 .cindex "message body" "in expansion"
12079 .vindex "&$message_body_end$&"
12080 This variable contains the final portion of a message's
12081 body while it is being delivered. The format and maximum size are as for
12082 &$message_body$&.
12083
12084 .vitem &$message_body_size$&
12085 .cindex "body of message" "size"
12086 .cindex "message body" "size"
12087 .vindex "&$message_body_size$&"
12088 When a message is being delivered, this variable contains the size of the body
12089 in bytes. The count starts from the character after the blank line that
12090 separates the body from the header. Newlines are included in the count. See
12091 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12092
12093 .vitem &$message_exim_id$&
12094 .vindex "&$message_exim_id$&"
12095 When a message is being received or delivered, this variable contains the
12096 unique message id that is generated and used by Exim to identify the message.
12097 An id is not created for a message until after its header has been successfully
12098 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12099 line; it is the local id that Exim assigns to the message, for example:
12100 &`1BXTIK-0001yO-VA`&.
12101
12102 .vitem &$message_headers$&
12103 .vindex &$message_headers$&
12104 This variable contains a concatenation of all the header lines when a message
12105 is being processed, except for lines added by routers or transports. The header
12106 lines are separated by newline characters. Their contents are decoded in the
12107 same way as a header line that is inserted by &%bheader%&.
12108
12109 .vitem &$message_headers_raw$&
12110 .vindex &$message_headers_raw$&
12111 This variable is like &$message_headers$& except that no processing of the
12112 contents of header lines is done.
12113
12114 .vitem &$message_id$&
12115 This is an old name for &$message_exim_id$&. It is now deprecated.
12116
12117 .vitem &$message_linecount$&
12118 .vindex "&$message_linecount$&"
12119 This variable contains the total number of lines in the header and body of the
12120 message. Compare &$body_linecount$&, which is the count for the body only.
12121 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12122 number of lines received. Before delivery happens (that is, before filters,
12123 routers, and transports run) the count is increased to include the
12124 &'Received:'& header line that Exim standardly adds, and also any other header
12125 lines that are added by ACLs. The blank line that separates the message header
12126 from the body is not counted.
12127
12128 As with the special case of &$message_size$&, during the expansion of the
12129 appendfile transport's maildir_tag option in maildir format, the value of
12130 &$message_linecount$& is the precise size of the number of newlines in the
12131 file that has been written (minus one for the blank line between the
12132 header and the body).
12133
12134 Here is an example of the use of this variable in a DATA ACL:
12135 .code
12136 deny message   = Too many lines in message header
12137      condition = \
12138       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12139 .endd
12140 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12141 message has not yet been received.
12142
12143 .vitem &$message_size$&
12144 .cindex "size" "of message"
12145 .cindex "message" "size"
12146 .vindex "&$message_size$&"
12147 When a message is being processed, this variable contains its size in bytes. In
12148 most cases, the size includes those headers that were received with the
12149 message, but not those (such as &'Envelope-to:'&) that are added to individual
12150 deliveries as they are written. However, there is one special case: during the
12151 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12152 doing a delivery in maildir format, the value of &$message_size$& is the
12153 precise size of the file that has been written. See also
12154 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12155
12156 .cindex "RCPT" "value of &$message_size$&"
12157 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12158 contains the size supplied on the MAIL command, or -1 if no size was given. The
12159 value may not, of course, be truthful.
12160
12161 .vitem &$mime_$&&'xxx'&
12162 A number of variables whose names start with &$mime$& are
12163 available when Exim is compiled with the content-scanning extension. For
12164 details, see section &<<SECTscanmimepart>>&.
12165
12166 .vitem "&$n0$& &-- &$n9$&"
12167 These variables are counters that can be incremented by means
12168 of the &%add%& command in filter files.
12169
12170 .vitem &$original_domain$&
12171 .vindex "&$domain$&"
12172 .vindex "&$original_domain$&"
12173 When a top-level address is being processed for delivery, this contains the
12174 same value as &$domain$&. However, if a &"child"& address (for example,
12175 generated by an alias, forward, or filter file) is being processed, this
12176 variable contains the domain of the original address (lower cased). This
12177 differs from &$parent_domain$& only when there is more than one level of
12178 aliasing or forwarding. When more than one address is being delivered in a
12179 single transport run, &$original_domain$& is not set.
12180
12181 If a new address is created by means of a &%deliver%& command in a system
12182 filter, it is set up with an artificial &"parent"& address. This has the local
12183 part &'system-filter'& and the default qualify domain.
12184
12185 .vitem &$original_local_part$&
12186 .vindex "&$local_part$&"
12187 .vindex "&$original_local_part$&"
12188 When a top-level address is being processed for delivery, this contains the
12189 same value as &$local_part$&, unless a prefix or suffix was removed from the
12190 local part, because &$original_local_part$& always contains the full local
12191 part. When a &"child"& address (for example, generated by an alias, forward, or
12192 filter file) is being processed, this variable contains the full local part of
12193 the original address.
12194
12195 If the router that did the redirection processed the local part
12196 case-insensitively, the value in &$original_local_part$& is in lower case.
12197 This variable differs from &$parent_local_part$& only when there is more than
12198 one level of aliasing or forwarding. When more than one address is being
12199 delivered in a single transport run, &$original_local_part$& is not set.
12200
12201 If a new address is created by means of a &%deliver%& command in a system
12202 filter, it is set up with an artificial &"parent"& address. This has the local
12203 part &'system-filter'& and the default qualify domain.
12204
12205 .vitem &$originator_gid$&
12206 .cindex "gid (group id)" "of originating user"
12207 .cindex "sender" "gid"
12208 .vindex "&$caller_gid$&"
12209 .vindex "&$originator_gid$&"
12210 This variable contains the value of &$caller_gid$& that was set when the
12211 message was received. For messages received via the command line, this is the
12212 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12213 normally the gid of the Exim user.
12214
12215 .vitem &$originator_uid$&
12216 .cindex "uid (user id)" "of originating user"
12217 .cindex "sender" "uid"
12218 .vindex "&$caller_uid$&"
12219 .vindex "&$originaltor_uid$&"
12220 The value of &$caller_uid$& that was set when the message was received. For
12221 messages received via the command line, this is the uid of the sending user.
12222 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12223 user.
12224
12225 .vitem &$parent_domain$&
12226 .vindex "&$parent_domain$&"
12227 This variable is similar to &$original_domain$& (see
12228 above), except that it refers to the immediately preceding parent address.
12229
12230 .vitem &$parent_local_part$&
12231 .vindex "&$parent_local_part$&"
12232 This variable is similar to &$original_local_part$&
12233 (see above), except that it refers to the immediately preceding parent address.
12234
12235 .vitem &$pid$&
12236 .cindex "pid (process id)" "of current process"
12237 .vindex "&$pid$&"
12238 This variable contains the current process id.
12239
12240 .vitem &$pipe_addresses$&
12241 .cindex "filter" "transport filter"
12242 .cindex "transport" "filter"
12243 .vindex "&$pipe_addresses$&"
12244 This is not an expansion variable, but is mentioned here because the string
12245 &`$pipe_addresses`& is handled specially in the command specification for the
12246 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12247 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12248 It cannot be used in general expansion strings, and provokes an &"unknown
12249 variable"& error if encountered.
12250
12251 .vitem &$primary_hostname$&
12252 .vindex "&$primary_hostname$&"
12253 This variable contains the value set by &%primary_hostname%& in the
12254 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12255 a single-component name, Exim calls &[gethostbyname()]& (or
12256 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12257 qualified host name. See also &$smtp_active_hostname$&.
12258
12259
12260 .new
12261 .vitem &$proxy_external_address$& &&&
12262        &$proxy_external_port$& &&&
12263        &$proxy_local_address$& &&&
12264        &$proxy_local_port$& &&&
12265        &$proxy_session$&
12266 These variables are only available when built with Proxy Protocol
12267 or Socks5 support
12268 For details see chapter &<<SECTproxyInbound>>&.
12269 .wen
12270
12271 .vitem &$prdr_requested$&
12272 .cindex "PRDR" "variable for"
12273 This variable is set to &"yes"& if PRDR was requested by the client for the
12274 current message, otherwise &"no"&.
12275
12276 .vitem &$prvscheck_address$&
12277 This variable is used in conjunction with the &%prvscheck%& expansion item,
12278 which is described in sections &<<SECTexpansionitems>>& and
12279 &<<SECTverifyPRVS>>&.
12280
12281 .vitem &$prvscheck_keynum$&
12282 This variable is used in conjunction with the &%prvscheck%& expansion item,
12283 which is described in sections &<<SECTexpansionitems>>& and
12284 &<<SECTverifyPRVS>>&.
12285
12286 .vitem &$prvscheck_result$&
12287 This variable is used in conjunction with the &%prvscheck%& expansion item,
12288 which is described in sections &<<SECTexpansionitems>>& and
12289 &<<SECTverifyPRVS>>&.
12290
12291 .vitem &$qualify_domain$&
12292 .vindex "&$qualify_domain$&"
12293 The value set for the &%qualify_domain%& option in the configuration file.
12294
12295 .vitem &$qualify_recipient$&
12296 .vindex "&$qualify_recipient$&"
12297 The value set for the &%qualify_recipient%& option in the configuration file,
12298 or if not set, the value of &$qualify_domain$&.
12299
12300 .new
12301 .vitem &$queue_name$&
12302 .vindex &$queue_name$&
12303 .cindex "named queues"
12304 .cindex queues named
12305 The name of the spool queue in use; empty for the default queue.
12306 .wen
12307
12308 .vitem &$rcpt_count$&
12309 .vindex "&$rcpt_count$&"
12310 When a message is being received by SMTP, this variable contains the number of
12311 RCPT commands received for the current message. If this variable is used in a
12312 RCPT ACL, its value includes the current command.
12313
12314 .vitem &$rcpt_defer_count$&
12315 .vindex "&$rcpt_defer_count$&"
12316 .cindex "4&'xx'& responses" "count of"
12317 When a message is being received by SMTP, this variable contains the number of
12318 RCPT commands in the current message that have previously been rejected with a
12319 temporary (4&'xx'&) response.
12320
12321 .vitem &$rcpt_fail_count$&
12322 .vindex "&$rcpt_fail_count$&"
12323 When a message is being received by SMTP, this variable contains the number of
12324 RCPT commands in the current message that have previously been rejected with a
12325 permanent (5&'xx'&) response.
12326
12327 .vitem &$received_count$&
12328 .vindex "&$received_count$&"
12329 This variable contains the number of &'Received:'& header lines in the message,
12330 including the one added by Exim (so its value is always greater than zero). It
12331 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12332 delivering.
12333
12334 .vitem &$received_for$&
12335 .vindex "&$received_for$&"
12336 If there is only a single recipient address in an incoming message, this
12337 variable contains that address when the &'Received:'& header line is being
12338 built. The value is copied after recipient rewriting has happened, but before
12339 the &[local_scan()]& function is run.
12340
12341 .vitem &$received_ip_address$&
12342 .vindex "&$received_ip_address$&"
12343 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12344 variable is set to the address of the local IP interface, and &$received_port$&
12345 is set to the local port number. (The remote IP address and port are in
12346 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12347 the port value is -1 unless it has been set using the &%-oMi%& command line
12348 option.
12349
12350 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12351 could be used, for example, to make the file name for a TLS certificate depend
12352 on which interface and/or port is being used for the incoming connection. The
12353 values of &$received_ip_address$& and &$received_port$& are saved with any
12354 messages that are received, thus making these variables available at delivery
12355 time.
12356 For outbound connections see &$sending_ip_address$&.
12357
12358 .vitem &$received_port$&
12359 .vindex "&$received_port$&"
12360 See &$received_ip_address$&.
12361
12362 .vitem &$received_protocol$&
12363 .vindex "&$received_protocol$&"
12364 When a message is being processed, this variable contains the name of the
12365 protocol by which it was received. Most of the names used by Exim are defined
12366 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12367 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12368 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12369 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12370 connection and the client was successfully authenticated.
12371
12372 Exim uses the protocol name &"smtps"& for the case when encryption is
12373 automatically set up on connection without the use of STARTTLS (see
12374 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12375 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12376 where the client initially uses EHLO, sets up an encrypted connection using
12377 STARTTLS, and then uses HELO afterwards.
12378
12379 The &%-oMr%& option provides a way of specifying a custom protocol name for
12380 messages that are injected locally by trusted callers. This is commonly used to
12381 identify messages that are being re-injected after some kind of scanning.
12382
12383 .vitem &$received_time$&
12384 .vindex "&$received_time$&"
12385 This variable contains the date and time when the current message was received,
12386 as a number of seconds since the start of the Unix epoch.
12387
12388 .vitem &$recipient_data$&
12389 .vindex "&$recipient_data$&"
12390 This variable is set after an indexing lookup success in an ACL &%recipients%&
12391 condition. It contains the data from the lookup, and the value remains set
12392 until the next &%recipients%& test. Thus, you can do things like this:
12393 .display
12394 &`require recipients  = cdb*@;/some/file`&
12395 &`deny    `&&'some further test involving'& &`$recipient_data`&
12396 .endd
12397 &*Warning*&: This variable is set only when a lookup is used as an indexing
12398 method in the address list, using the semicolon syntax as in the example above.
12399 The variable is not set for a lookup that is used as part of the string
12400 expansion that all such lists undergo before being interpreted.
12401
12402 .vitem &$recipient_verify_failure$&
12403 .vindex "&$recipient_verify_failure$&"
12404 In an ACL, when a recipient verification fails, this variable contains
12405 information about the failure. It is set to one of the following words:
12406
12407 .ilist
12408 &"qualify"&: The address was unqualified (no domain), and the message
12409 was neither local nor came from an exempted host.
12410
12411 .next
12412 &"route"&: Routing failed.
12413
12414 .next
12415 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12416 or before the MAIL command (that is, on initial connection, HELO, or
12417 MAIL).
12418
12419 .next
12420 &"recipient"&: The RCPT command in a callout was rejected.
12421 .next
12422
12423 &"postmaster"&: The postmaster check in a callout was rejected.
12424 .endlist
12425
12426 The main use of this variable is expected to be to distinguish between
12427 rejections of MAIL and rejections of RCPT.
12428
12429 .vitem &$recipients$&
12430 .vindex "&$recipients$&"
12431 This variable contains a list of envelope recipients for a message. A comma and
12432 a space separate the addresses in the replacement text. However, the variable
12433 is not generally available, to prevent exposure of Bcc recipients in
12434 unprivileged users' filter files. You can use &$recipients$& only in these
12435 cases:
12436
12437 .olist
12438 In a system filter file.
12439 .next
12440 In the ACLs associated with the DATA command and with non-SMTP messages, that
12441 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12442 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12443 &%acl_not_smtp_mime%&.
12444 .next
12445 From within a &[local_scan()]& function.
12446 .endlist
12447
12448
12449 .vitem &$recipients_count$&
12450 .vindex "&$recipients_count$&"
12451 When a message is being processed, this variable contains the number of
12452 envelope recipients that came with the message. Duplicates are not excluded
12453 from the count. While a message is being received over SMTP, the number
12454 increases for each accepted recipient. It can be referenced in an ACL.
12455
12456
12457 .vitem &$regex_match_string$&
12458 .vindex "&$regex_match_string$&"
12459 This variable is set to contain the matching regular expression after a
12460 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12461
12462 .vitem "&$regex1$&, &$regex2$&, etc"
12463 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12464 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12465 these variables contain the
12466 captured substrings identified by the regular expression.
12467
12468
12469 .vitem &$reply_address$&
12470 .vindex "&$reply_address$&"
12471 When a message is being processed, this variable contains the contents of the
12472 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12473 contents of the &'From:'& header line. Apart from the removal of leading
12474 white space, the value is not processed in any way. In particular, no RFC 2047
12475 decoding or character code translation takes place.
12476
12477 .vitem &$return_path$&
12478 .vindex "&$return_path$&"
12479 When a message is being delivered, this variable contains the return path &--
12480 the sender field that will be sent as part of the envelope. It is not enclosed
12481 in <> characters. At the start of routing an address, &$return_path$& has the
12482 same value as &$sender_address$&, but if, for example, an incoming message to a
12483 mailing list has been expanded by a router which specifies a different address
12484 for bounce messages, &$return_path$& subsequently contains the new bounce
12485 address, whereas &$sender_address$& always contains the original sender address
12486 that was received with the message. In other words, &$sender_address$& contains
12487 the incoming envelope sender, and &$return_path$& contains the outgoing
12488 envelope sender.
12489
12490 .vitem &$return_size_limit$&
12491 .vindex "&$return_size_limit$&"
12492 This is an obsolete name for &$bounce_return_size_limit$&.
12493
12494 .vitem &$router_name$&
12495 .cindex "router" "name"
12496 .cindex "name" "of router"
12497 .vindex "&$router_name$&"
12498 During the running of a router this variable contains its name.
12499
12500 .vitem &$runrc$&
12501 .cindex "return code" "from &%run%& expansion"
12502 .vindex "&$runrc$&"
12503 This variable contains the return code from a command that is run by the
12504 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12505 assume the order in which option values are expanded, except for those
12506 preconditions whose order of testing is documented. Therefore, you cannot
12507 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12508 another.
12509
12510 .vitem &$self_hostname$&
12511 .oindex "&%self%&" "value of host name"
12512 .vindex "&$self_hostname$&"
12513 When an address is routed to a supposedly remote host that turns out to be the
12514 local host, what happens is controlled by the &%self%& generic router option.
12515 One of its values causes the address to be passed to another router. When this
12516 happens, &$self_hostname$& is set to the name of the local host that the
12517 original router encountered. In other circumstances its contents are null.
12518
12519 .vitem &$sender_address$&
12520 .vindex "&$sender_address$&"
12521 When a message is being processed, this variable contains the sender's address
12522 that was received in the message's envelope. The case of letters in the address
12523 is retained, in both the local part and the domain. For bounce messages, the
12524 value of this variable is the empty string. See also &$return_path$&.
12525
12526 .vitem &$sender_address_data$&
12527 .vindex "&$address_data$&"
12528 .vindex "&$sender_address_data$&"
12529 If &$address_data$& is set when the routers are called from an ACL to verify a
12530 sender address, the final value is preserved in &$sender_address_data$&, to
12531 distinguish it from data from a recipient address. The value does not persist
12532 after the end of the current ACL statement. If you want to preserve it for
12533 longer, you can save it in an ACL variable.
12534
12535 .vitem &$sender_address_domain$&
12536 .vindex "&$sender_address_domain$&"
12537 The domain portion of &$sender_address$&.
12538
12539 .vitem &$sender_address_local_part$&
12540 .vindex "&$sender_address_local_part$&"
12541 The local part portion of &$sender_address$&.
12542
12543 .vitem &$sender_data$&
12544 .vindex "&$sender_data$&"
12545 This variable is set after a lookup success in an ACL &%senders%& condition or
12546 in a router &%senders%& option. It contains the data from the lookup, and the
12547 value remains set until the next &%senders%& test. Thus, you can do things like
12548 this:
12549 .display
12550 &`require senders      = cdb*@;/some/file`&
12551 &`deny    `&&'some further test involving'& &`$sender_data`&
12552 .endd
12553 &*Warning*&: This variable is set only when a lookup is used as an indexing
12554 method in the address list, using the semicolon syntax as in the example above.
12555 The variable is not set for a lookup that is used as part of the string
12556 expansion that all such lists undergo before being interpreted.
12557
12558 .vitem &$sender_fullhost$&
12559 .vindex "&$sender_fullhost$&"
12560 When a message is received from a remote host, this variable contains the host
12561 name and IP address in a single string. It ends with the IP address in square
12562 brackets, followed by a colon and a port number if the logging of ports is
12563 enabled. The format of the rest of the string depends on whether the host
12564 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12565 looking up its IP address. (Looking up the IP address can be forced by the
12566 &%host_lookup%& option, independent of verification.) A plain host name at the
12567 start of the string is a verified host name; if this is not present,
12568 verification either failed or was not requested. A host name in parentheses is
12569 the argument of a HELO or EHLO command. This is omitted if it is identical to
12570 the verified host name or to the host's IP address in square brackets.
12571
12572 .vitem &$sender_helo_dnssec$&
12573 .vindex "&$sender_helo_dnssec$&"
12574 This boolean variable is true if a successful HELO verification was
12575 .cindex "DNS" "DNSSEC"
12576 done using DNS information the resolver library stated was authenticated data.
12577
12578 .vitem &$sender_helo_name$&
12579 .vindex "&$sender_helo_name$&"
12580 When a message is received from a remote host that has issued a HELO or EHLO
12581 command, the argument of that command is placed in this variable. It is also
12582 set if HELO or EHLO is used when a message is received using SMTP locally via
12583 the &%-bs%& or &%-bS%& options.
12584
12585 .vitem &$sender_host_address$&
12586 .vindex "&$sender_host_address$&"
12587 When a message is received from a remote host using SMTP,
12588 this variable contains that
12589 host's IP address. For locally non-SMTP submitted messages, it is empty.
12590
12591 .vitem &$sender_host_authenticated$&
12592 .vindex "&$sender_host_authenticated$&"
12593 This variable contains the name (not the public name) of the authenticator
12594 driver that successfully authenticated the client from which the message was
12595 received. It is empty if there was no successful authentication. See also
12596 &$authenticated_id$&.
12597
12598 .vitem &$sender_host_dnssec$&
12599 .vindex "&$sender_host_dnssec$&"
12600 If an attempt to populate &$sender_host_name$& has been made
12601 (by reference, &%hosts_lookup%& or
12602 otherwise) then this boolean will have been set true if, and only if, the
12603 resolver library states that both
12604 the reverse and forward DNS were authenticated data.  At all
12605 other times, this variable is false.
12606
12607 .cindex "DNS" "DNSSEC"
12608 It is likely that you will need to coerce DNSSEC support on in the resolver
12609 library, by setting:
12610 .code
12611 dns_dnssec_ok = 1
12612 .endd
12613
12614 Exim does not perform DNSSEC validation itself, instead leaving that to a
12615 validating resolver (e.g. unbound, or bind with suitable configuration).
12616
12617 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12618 mechanism in the list, then this variable will be false.
12619
12620
12621 .vitem &$sender_host_name$&
12622 .vindex "&$sender_host_name$&"
12623 When a message is received from a remote host, this variable contains the
12624 host's name as obtained by looking up its IP address. For messages received by
12625 other means, this variable is empty.
12626
12627 .vindex "&$host_lookup_failed$&"
12628 If the host name has not previously been looked up, a reference to
12629 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12630 A looked up name is accepted only if it leads back to the original IP address
12631 via a forward lookup. If either the reverse or the forward lookup fails to find
12632 any data, or if the forward lookup does not yield the original IP address,
12633 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12634
12635 .vindex "&$host_lookup_deferred$&"
12636 However, if either of the lookups cannot be completed (for example, there is a
12637 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12638 &$host_lookup_failed$& remains set to &"0"&.
12639
12640 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12641 host name again if there is a subsequent reference to &$sender_host_name$&
12642 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12643 is set to &"1"&.
12644
12645 Exim does not automatically look up every calling host's name. If you want
12646 maximum efficiency, you should arrange your configuration so that it avoids
12647 these lookups altogether. The lookup happens only if one or more of the
12648 following are true:
12649
12650 .ilist
12651 A string containing &$sender_host_name$& is expanded.
12652 .next
12653 The calling host matches the list in &%host_lookup%&. In the default
12654 configuration, this option is set to *, so it must be changed if lookups are
12655 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12656 .next
12657 Exim needs the host name in order to test an item in a host list. The items
12658 that require this are described in sections &<<SECThoslispatnam>>& and
12659 &<<SECThoslispatnamsk>>&.
12660 .next
12661 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12662 In this case, the host name is required to compare with the name quoted in any
12663 EHLO or HELO commands that the client issues.
12664 .next
12665 The remote host issues a EHLO or HELO command that quotes one of the
12666 domains in &%helo_lookup_domains%&. The default value of this option is
12667 . ==== As this is a nested list, any displays it contains must be indented
12668 . ==== as otherwise they are too far to the left.
12669 .code
12670   helo_lookup_domains = @ : @[]
12671 .endd
12672 which causes a lookup if a remote host (incorrectly) gives the server's name or
12673 IP address in an EHLO or HELO command.
12674 .endlist
12675
12676
12677 .vitem &$sender_host_port$&
12678 .vindex "&$sender_host_port$&"
12679 When a message is received from a remote host, this variable contains the port
12680 number that was used on the remote host.
12681
12682 .vitem &$sender_ident$&
12683 .vindex "&$sender_ident$&"
12684 When a message is received from a remote host, this variable contains the
12685 identification received in response to an RFC 1413 request. When a message has
12686 been received locally, this variable contains the login name of the user that
12687 called Exim.
12688
12689 .vitem &$sender_rate_$&&'xxx'&
12690 A number of variables whose names begin &$sender_rate_$& are set as part of the
12691 &%ratelimit%& ACL condition. Details are given in section
12692 &<<SECTratelimiting>>&.
12693
12694 .vitem &$sender_rcvhost$&
12695 .cindex "DNS" "reverse lookup"
12696 .cindex "reverse DNS lookup"
12697 .vindex "&$sender_rcvhost$&"
12698 This is provided specifically for use in &'Received:'& headers. It starts with
12699 either the verified host name (as obtained from a reverse DNS lookup) or, if
12700 there is no verified host name, the IP address in square brackets. After that
12701 there may be text in parentheses. When the first item is a verified host name,
12702 the first thing in the parentheses is the IP address in square brackets,
12703 followed by a colon and a port number if port logging is enabled. When the
12704 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12705 the parentheses.
12706
12707 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12708 was used and its argument was not identical to the real host name or IP
12709 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12710 all three items are present in the parentheses, a newline and tab are inserted
12711 into the string, to improve the formatting of the &'Received:'& header.
12712
12713 .vitem &$sender_verify_failure$&
12714 .vindex "&$sender_verify_failure$&"
12715 In an ACL, when a sender verification fails, this variable contains information
12716 about the failure. The details are the same as for
12717 &$recipient_verify_failure$&.
12718
12719 .vitem &$sending_ip_address$&
12720 .vindex "&$sending_ip_address$&"
12721 This variable is set whenever an outgoing SMTP connection to another host has
12722 been set up. It contains the IP address of the local interface that is being
12723 used. This is useful if a host that has more than one IP address wants to take
12724 on different personalities depending on which one is being used. For incoming
12725 connections, see &$received_ip_address$&.
12726
12727 .vitem &$sending_port$&
12728 .vindex "&$sending_port$&"
12729 This variable is set whenever an outgoing SMTP connection to another host has
12730 been set up. It contains the local port that is being used. For incoming
12731 connections, see &$received_port$&.
12732
12733 .vitem &$smtp_active_hostname$&
12734 .vindex "&$smtp_active_hostname$&"
12735 During an incoming SMTP session, this variable contains the value of the active
12736 host name, as specified by the &%smtp_active_hostname%& option. The value of
12737 &$smtp_active_hostname$& is saved with any message that is received, so its
12738 value can be consulted during routing and delivery.
12739
12740 .vitem &$smtp_command$&
12741 .vindex "&$smtp_command$&"
12742 During the processing of an incoming SMTP command, this variable contains the
12743 entire command. This makes it possible to distinguish between HELO and EHLO in
12744 the HELO ACL, and also to distinguish between commands such as these:
12745 .code
12746 MAIL FROM:<>
12747 MAIL FROM: <>
12748 .endd
12749 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12750 command, the address in &$smtp_command$& is the original address before any
12751 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12752 the address after SMTP-time rewriting.
12753
12754 .vitem &$smtp_command_argument$&
12755 .cindex "SMTP" "command, argument for"
12756 .vindex "&$smtp_command_argument$&"
12757 While an ACL is running to check an SMTP command, this variable contains the
12758 argument, that is, the text that follows the command name, with leading white
12759 space removed. Following the introduction of &$smtp_command$&, this variable is
12760 somewhat redundant, but is retained for backwards compatibility.
12761
12762 .vitem &$smtp_count_at_connection_start$&
12763 .vindex "&$smtp_count_at_connection_start$&"
12764 This variable is set greater than zero only in processes spawned by the Exim
12765 daemon for handling incoming SMTP connections. The name is deliberately long,
12766 in order to emphasize what the contents are. When the daemon accepts a new
12767 connection, it increments this variable. A copy of the variable is passed to
12768 the child process that handles the connection, but its value is fixed, and
12769 never changes. It is only an approximation of how many incoming connections
12770 there actually are, because many other connections may come and go while a
12771 single connection is being processed. When a child process terminates, the
12772 daemon decrements its copy of the variable.
12773
12774 .vitem "&$sn0$& &-- &$sn9$&"
12775 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12776 that were current at the end of the system filter file. This allows a system
12777 filter file to set values that can be tested in users' filter files. For
12778 example, a system filter could set a value indicating how likely it is that a
12779 message is junk mail.
12780
12781 .vitem &$spam_$&&'xxx'&
12782 A number of variables whose names start with &$spam$& are available when Exim
12783 is compiled with the content-scanning extension. For details, see section
12784 &<<SECTscanspamass>>&.
12785
12786
12787 .vitem &$spool_directory$&
12788 .vindex "&$spool_directory$&"
12789 The name of Exim's spool directory.
12790
12791 .vitem &$spool_inodes$&
12792 .vindex "&$spool_inodes$&"
12793 The number of free inodes in the disk partition where Exim's spool files are
12794 being written. The value is recalculated whenever the variable is referenced.
12795 If the relevant file system does not have the concept of inodes, the value of
12796 is -1. See also the &%check_spool_inodes%& option.
12797
12798 .vitem &$spool_space$&
12799 .vindex "&$spool_space$&"
12800 The amount of free space (as a number of kilobytes) in the disk partition where
12801 Exim's spool files are being written. The value is recalculated whenever the
12802 variable is referenced. If the operating system does not have the ability to
12803 find the amount of free space (only true for experimental systems), the space
12804 value is -1. For example, to check in an ACL that there is at least 50
12805 megabytes free on the spool, you could write:
12806 .code
12807 condition = ${if > {$spool_space}{50000}}
12808 .endd
12809 See also the &%check_spool_space%& option.
12810
12811
12812 .vitem &$thisaddress$&
12813 .vindex "&$thisaddress$&"
12814 This variable is set only during the processing of the &%foranyaddress%&
12815 command in a filter file. Its use is explained in the description of that
12816 command, which can be found in the separate document entitled &'Exim's
12817 interfaces to mail filtering'&.
12818
12819 .vitem &$tls_in_bits$&
12820 .vindex "&$tls_in_bits$&"
12821 Contains an approximation of the TLS cipher's bit-strength
12822 on the inbound connection; the meaning of
12823 this depends upon the TLS implementation used.
12824 If TLS has not been negotiated, the value will be 0.
12825 The value of this is automatically fed into the Cyrus SASL authenticator
12826 when acting as a server, to specify the "external SSF" (a SASL term).
12827
12828 The deprecated &$tls_bits$& variable refers to the inbound side
12829 except when used in the context of an outbound SMTP delivery, when it refers to
12830 the outbound.
12831
12832 .vitem &$tls_out_bits$&
12833 .vindex "&$tls_out_bits$&"
12834 Contains an approximation of the TLS cipher's bit-strength
12835 on an outbound SMTP connection; the meaning of
12836 this depends upon the TLS implementation used.
12837 If TLS has not been negotiated, the value will be 0.
12838
12839 .vitem &$tls_in_ourcert$&
12840 .vindex "&$tls_in_ourcert$&"
12841 .cindex certificate veriables
12842 This variable refers to the certificate presented to the peer of an
12843 inbound connection when the message was received.
12844 It is only useful as the argument of a
12845 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12846 or a &%def%& condition.
12847
12848 .vitem &$tls_in_peercert$&
12849 .vindex "&$tls_in_peercert$&"
12850 This variable refers to the certificate presented by the peer of an
12851 inbound connection when the message was received.
12852 It is only useful as the argument of a
12853 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12854 or a &%def%& condition.
12855 If certificate verification fails it may refer to a failing chain element
12856 which is not the leaf.
12857
12858 .vitem &$tls_out_ourcert$&
12859 .vindex "&$tls_out_ourcert$&"
12860 This variable refers to the certificate presented to the peer of an
12861 outbound connection.  It is only useful as the argument of a
12862 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12863 or a &%def%& condition.
12864
12865 .vitem &$tls_out_peercert$&
12866 .vindex "&$tls_out_peercert$&"
12867 This variable refers to the certificate presented by the peer of an
12868 outbound connection.  It is only useful as the argument of a
12869 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12870 or a &%def%& condition.
12871 If certificate verification fails it may refer to a failing chain element
12872 which is not the leaf.
12873
12874 .vitem &$tls_in_certificate_verified$&
12875 .vindex "&$tls_in_certificate_verified$&"
12876 This variable is set to &"1"& if a TLS certificate was verified when the
12877 message was received, and &"0"& otherwise.
12878
12879 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12880 except when used in the context of an outbound SMTP delivery, when it refers to
12881 the outbound.
12882
12883 .vitem &$tls_out_certificate_verified$&
12884 .vindex "&$tls_out_certificate_verified$&"
12885 This variable is set to &"1"& if a TLS certificate was verified when an
12886 outbound SMTP connection was made,
12887 and &"0"& otherwise.
12888
12889 .vitem &$tls_in_cipher$&
12890 .vindex "&$tls_in_cipher$&"
12891 .vindex "&$tls_cipher$&"
12892 When a message is received from a remote host over an encrypted SMTP
12893 connection, this variable is set to the cipher suite that was negotiated, for
12894 example DES-CBC3-SHA. In other circumstances, in particular, for message
12895 received over unencrypted connections, the variable is empty. Testing
12896 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12897 non-encrypted connections during ACL processing.
12898
12899 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12900 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12901 becomes the same as &$tls_out_cipher$&.
12902
12903 .vitem &$tls_out_cipher$&
12904 .vindex "&$tls_out_cipher$&"
12905 This variable is
12906 cleared before any outgoing SMTP connection is made,
12907 and then set to the outgoing cipher suite if one is negotiated. See chapter
12908 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12909 details of the &(smtp)& transport.
12910
12911 .vitem &$tls_in_ocsp$&
12912 .vindex "&$tls_in_ocsp$&"
12913 When a message is received from a remote client connection
12914 the result of any OCSP request from the client is encoded in this variable:
12915 .code
12916 0 OCSP proof was not requested (default value)
12917 1 No response to request
12918 2 Response not verified
12919 3 Verification failed
12920 4 Verification succeeded
12921 .endd
12922
12923 .vitem &$tls_out_ocsp$&
12924 .vindex "&$tls_out_ocsp$&"
12925 When a message is sent to a remote host connection
12926 the result of any OCSP request made is encoded in this variable.
12927 See &$tls_in_ocsp$& for values.
12928
12929 .vitem &$tls_in_peerdn$&
12930 .vindex "&$tls_in_peerdn$&"
12931 .vindex "&$tls_peerdn$&"
12932 .cindex certificate "extracting fields"
12933 When a message is received from a remote host over an encrypted SMTP
12934 connection, and Exim is configured to request a certificate from the client,
12935 the value of the Distinguished Name of the certificate is made available in the
12936 &$tls_in_peerdn$& during subsequent processing.
12937 If certificate verification fails it may refer to a failing chain element
12938 which is not the leaf.
12939
12940 The deprecated &$tls_peerdn$& variable refers to the inbound side
12941 except when used in the context of an outbound SMTP delivery, when it refers to
12942 the outbound.
12943
12944 .vitem &$tls_out_peerdn$&
12945 .vindex "&$tls_out_peerdn$&"
12946 When a message is being delivered to a remote host over an encrypted SMTP
12947 connection, and Exim is configured to request a certificate from the server,
12948 the value of the Distinguished Name of the certificate is made available in the
12949 &$tls_out_peerdn$& during subsequent processing.
12950 If certificate verification fails it may refer to a failing chain element
12951 which is not the leaf.
12952
12953 .vitem &$tls_in_sni$&
12954 .vindex "&$tls_in_sni$&"
12955 .vindex "&$tls_sni$&"
12956 .cindex "TLS" "Server Name Indication"
12957 When a TLS session is being established, if the client sends the Server
12958 Name Indication extension, the value will be placed in this variable.
12959 If the variable appears in &%tls_certificate%& then this option and
12960 some others, described in &<<SECTtlssni>>&,
12961 will be re-expanded early in the TLS session, to permit
12962 a different certificate to be presented (and optionally a different key to be
12963 used) to the client, based upon the value of the SNI extension.
12964
12965 The deprecated &$tls_sni$& variable refers to the inbound side
12966 except when used in the context of an outbound SMTP delivery, when it refers to
12967 the outbound.
12968
12969 .vitem &$tls_out_sni$&
12970 .vindex "&$tls_out_sni$&"
12971 .cindex "TLS" "Server Name Indication"
12972 During outbound
12973 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12974 the transport.
12975
12976 .vitem &$tod_bsdinbox$&
12977 .vindex "&$tod_bsdinbox$&"
12978 The time of day and the date, in the format required for BSD-style mailbox
12979 files, for example: Thu Oct 17 17:14:09 1995.
12980
12981 .vitem &$tod_epoch$&
12982 .vindex "&$tod_epoch$&"
12983 The time and date as a number of seconds since the start of the Unix epoch.
12984
12985 .vitem &$tod_epoch_l$&
12986 .vindex "&$tod_epoch_l$&"
12987 The time and date as a number of microseconds since the start of the Unix epoch.
12988
12989 .vitem &$tod_full$&
12990 .vindex "&$tod_full$&"
12991 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12992 +0100. The timezone is always given as a numerical offset from UTC, with
12993 positive values used for timezones that are ahead (east) of UTC, and negative
12994 values for those that are behind (west).
12995
12996 .vitem &$tod_log$&
12997 .vindex "&$tod_log$&"
12998 The time and date in the format used for writing Exim's log files, for example:
12999 1995-10-12 15:32:29, but without a timezone.
13000
13001 .vitem &$tod_logfile$&
13002 .vindex "&$tod_logfile$&"
13003 This variable contains the date in the format yyyymmdd. This is the format that
13004 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13005 flag.
13006
13007 .vitem &$tod_zone$&
13008 .vindex "&$tod_zone$&"
13009 This variable contains the numerical value of the local timezone, for example:
13010 -0500.
13011
13012 .vitem &$tod_zulu$&
13013 .vindex "&$tod_zulu$&"
13014 This variable contains the UTC date and time in &"Zulu"& format, as specified
13015 by ISO 8601, for example: 20030221154023Z.
13016
13017 .vitem &$transport_name$&
13018 .cindex "transport" "name"
13019 .cindex "name" "of transport"
13020 .vindex "&$transport_name$&"
13021 During the running of a transport, this variable contains its name.
13022
13023 .vitem &$value$&
13024 .vindex "&$value$&"
13025 This variable contains the result of an expansion lookup, extraction operation,
13026 or external command, as described above. It is also used during a
13027 &*reduce*& expansion.
13028
13029 .vitem &$verify_mode$&
13030 .vindex "&$verify_mode$&"
13031 While a router or transport is being run in verify mode or for cutthrough delivery,
13032 contains "S" for sender-verification or "R" for recipient-verification.
13033 Otherwise, empty.
13034
13035 .vitem &$version_number$&
13036 .vindex "&$version_number$&"
13037 The version number of Exim.
13038
13039 .vitem &$warn_message_delay$&
13040 .vindex "&$warn_message_delay$&"
13041 This variable is set only during the creation of a message warning about a
13042 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13043
13044 .vitem &$warn_message_recipients$&
13045 .vindex "&$warn_message_recipients$&"
13046 This variable is set only during the creation of a message warning about a
13047 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13048 .endlist
13049 .ecindex IIDstrexp
13050
13051
13052
13053 . ////////////////////////////////////////////////////////////////////////////
13054 . ////////////////////////////////////////////////////////////////////////////
13055
13056 .chapter "Embedded Perl" "CHAPperl"
13057 .scindex IIDperl "Perl" "calling from Exim"
13058 Exim can be built to include an embedded Perl interpreter. When this is done,
13059 Perl subroutines can be called as part of the string expansion process. To make
13060 use of the Perl support, you need version 5.004 or later of Perl installed on
13061 your system. To include the embedded interpreter in the Exim binary, include
13062 the line
13063 .code
13064 EXIM_PERL = perl.o
13065 .endd
13066 in your &_Local/Makefile_& and then build Exim in the normal way.
13067
13068
13069 .section "Setting up so Perl can be used" "SECID85"
13070 .oindex "&%perl_startup%&"
13071 Access to Perl subroutines is via a global configuration option called
13072 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13073 no &%perl_startup%& option in the Exim configuration file then no Perl
13074 interpreter is started and there is almost no overhead for Exim (since none of
13075 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13076 option then the associated value is taken to be Perl code which is executed in
13077 a newly created Perl interpreter.
13078
13079 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13080 need backslashes before any characters to escape special meanings. The option
13081 should usually be something like
13082 .code
13083 perl_startup = do '/etc/exim.pl'
13084 .endd
13085 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13086 use from Exim. Exim can be configured either to start up a Perl interpreter as
13087 soon as it is entered, or to wait until the first time it is needed. Starting
13088 the interpreter at the beginning ensures that it is done while Exim still has
13089 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13090 fact used in a particular run. Also, note that this does not mean that Exim is
13091 necessarily running as root when Perl is called at a later time. By default,
13092 the interpreter is started only when it is needed, but this can be changed in
13093 two ways:
13094
13095 .ilist
13096 .oindex "&%perl_at_start%&"
13097 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13098 a startup when Exim is entered.
13099 .next
13100 The command line option &%-ps%& also requests a startup when Exim is entered,
13101 overriding the setting of &%perl_at_start%&.
13102 .endlist
13103
13104 There is also a command line option &%-pd%& (for delay) which suppresses the
13105 initial startup, even if &%perl_at_start%& is set.
13106
13107 .new
13108 .ilist
13109 .oindex "&%perl_taintmode%&"
13110 .cindex "Perl" "taintmode"
13111 To provide more security executing Perl code via the embedded Perl
13112 interpeter, the &%perl_taintmode%& option can be set. This enables the
13113 taint mode of the Perl interpreter. You are encouraged to set this
13114 option to a true value. To avoid breaking existing installations, it
13115 defaults to false.
13116 .wen
13117
13118
13119 .section "Calling Perl subroutines" "SECID86"
13120 When the configuration file includes a &%perl_startup%& option you can make use
13121 of the string expansion item to call the Perl subroutines that are defined
13122 by the &%perl_startup%& code. The operator is used in any of the following
13123 forms:
13124 .code
13125 ${perl{foo}}
13126 ${perl{foo}{argument}}
13127 ${perl{foo}{argument1}{argument2} ... }
13128 .endd
13129 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13130 arguments may be passed. Passing more than this results in an expansion failure
13131 with an error message of the form
13132 .code
13133 Too many arguments passed to Perl subroutine "foo" (max is 8)
13134 .endd
13135 The return value of the Perl subroutine is evaluated in a scalar context before
13136 it is passed back to Exim to be inserted into the expanded string. If the
13137 return value is &'undef'&, the expansion is forced to fail in the same way as
13138 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13139 by obeying Perl's &%die%& function, the expansion fails with the error message
13140 that was passed to &%die%&.
13141
13142
13143 .section "Calling Exim functions from Perl" "SECID87"
13144 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13145 is available to call back into Exim's string expansion function. For example,
13146 the Perl code
13147 .code
13148 my $lp = Exim::expand_string('$local_part');
13149 .endd
13150 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13151 Note those are single quotes and not double quotes to protect against
13152 &$local_part$& being interpolated as a Perl variable.
13153
13154 If the string expansion is forced to fail by a &"fail"& item, the result of
13155 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13156 expansion string, the Perl call from the original expansion string fails with
13157 an appropriate error message, in the same way as if &%die%& were used.
13158
13159 .cindex "debugging" "from embedded Perl"
13160 .cindex "log" "writing from embedded Perl"
13161 Two other Exim functions are available for use from within Perl code.
13162 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13163 debugging is enabled. If you want a newline at the end, you must supply it.
13164 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13165 timestamp. In this case, you should not supply a terminating newline.
13166
13167
13168 .section "Use of standard output and error by Perl" "SECID88"
13169 .cindex "Perl" "standard output and error"
13170 You should not write to the standard error or output streams from within your
13171 Perl code, as it is not defined how these are set up. In versions of Exim
13172 before 4.50, it is possible for the standard output or error to refer to the
13173 SMTP connection during message reception via the daemon. Writing to this stream
13174 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13175 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13176 avoided, but the output is lost.
13177
13178 .cindex "Perl" "use of &%warn%&"
13179 The Perl &%warn%& statement writes to the standard error stream by default.
13180 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13181 you have no control. When Exim starts up the Perl interpreter, it arranges for
13182 output from the &%warn%& statement to be written to the Exim main log. You can
13183 change this by including appropriate Perl magic somewhere in your Perl code.
13184 For example, to discard &%warn%& output completely, you need this:
13185 .code
13186 $SIG{__WARN__} = sub { };
13187 .endd
13188 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13189 example, the code for the subroutine is empty, so it does nothing, but you can
13190 include any Perl code that you like. The text of the &%warn%& message is passed
13191 as the first subroutine argument.
13192 .ecindex IIDperl
13193
13194
13195 . ////////////////////////////////////////////////////////////////////////////
13196 . ////////////////////////////////////////////////////////////////////////////
13197
13198 .chapter "Starting the daemon and the use of network interfaces" &&&
13199          "CHAPinterfaces" &&&
13200          "Starting the daemon"
13201 .cindex "daemon" "starting"
13202 .cindex "interface" "listening"
13203 .cindex "network interface"
13204 .cindex "interface" "network"
13205 .cindex "IP address" "for listening"
13206 .cindex "daemon" "listening IP addresses"
13207 .cindex "TCP/IP" "setting listening interfaces"
13208 .cindex "TCP/IP" "setting listening ports"
13209 A host that is connected to a TCP/IP network may have one or more physical
13210 hardware network interfaces. Each of these interfaces may be configured as one
13211 or more &"logical"& interfaces, which are the entities that a program actually
13212 works with. Each of these logical interfaces is associated with an IP address.
13213 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13214 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13215 knowledge about the host's interfaces for use in three different circumstances:
13216
13217 .olist
13218 When a listening daemon is started, Exim needs to know which interfaces
13219 and ports to listen on.
13220 .next
13221 When Exim is routing an address, it needs to know which IP addresses
13222 are associated with local interfaces. This is required for the correct
13223 processing of MX lists by removing the local host and others with the
13224 same or higher priority values. Also, Exim needs to detect cases
13225 when an address is routed to an IP address that in fact belongs to the
13226 local host. Unless the &%self%& router option or the &%allow_localhost%&
13227 option of the smtp transport is set (as appropriate), this is treated
13228 as an error situation.
13229 .next
13230 When Exim connects to a remote host, it may need to know which interface to use
13231 for the outgoing connection.
13232 .endlist
13233
13234
13235 Exim's default behaviour is likely to be appropriate in the vast majority
13236 of cases. If your host has only one interface, and you want all its IP
13237 addresses to be treated in the same way, and you are using only the
13238 standard SMTP port, you should not need to take any special action. The
13239 rest of this chapter does not apply to you.
13240
13241 In a more complicated situation you may want to listen only on certain
13242 interfaces, or on different ports, and for this reason there are a number of
13243 options that can be used to influence Exim's behaviour. The rest of this
13244 chapter describes how they operate.
13245
13246 When a message is received over TCP/IP, the interface and port that were
13247 actually used are set in &$received_ip_address$& and &$received_port$&.
13248
13249
13250
13251 .section "Starting a listening daemon" "SECID89"
13252 When a listening daemon is started (by means of the &%-bd%& command line
13253 option), the interfaces and ports on which it listens are controlled by the
13254 following options:
13255
13256 .ilist
13257 &%daemon_smtp_ports%& contains a list of default ports
13258 or service names.
13259 (For backward compatibility, this option can also be specified in the singular.)
13260 .next
13261 &%local_interfaces%& contains list of interface IP addresses on which to
13262 listen. Each item may optionally also specify a port.
13263 .endlist
13264
13265 The default list separator in both cases is a colon, but this can be changed as
13266 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13267 it is usually best to change the separator to avoid having to double all the
13268 colons. For example:
13269 .code
13270 local_interfaces = <; 127.0.0.1 ; \
13271                       192.168.23.65 ; \
13272                       ::1 ; \
13273                       3ffe:ffff:836f::fe86:a061
13274 .endd
13275 There are two different formats for specifying a port along with an IP address
13276 in &%local_interfaces%&:
13277
13278 .olist
13279 The port is added onto the address with a dot separator. For example, to listen
13280 on port 1234 on two different IP addresses:
13281 .code
13282 local_interfaces = <; 192.168.23.65.1234 ; \
13283                       3ffe:ffff:836f::fe86:a061.1234
13284 .endd
13285 .next
13286 The IP address is enclosed in square brackets, and the port is added
13287 with a colon separator, for example:
13288 .code
13289 local_interfaces = <; [192.168.23.65]:1234 ; \
13290                       [3ffe:ffff:836f::fe86:a061]:1234
13291 .endd
13292 .endlist
13293
13294 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13295 default setting contains just one port:
13296 .code
13297 daemon_smtp_ports = smtp
13298 .endd
13299 If more than one port is listed, each interface that does not have its own port
13300 specified listens on all of them. Ports that are listed in
13301 &%daemon_smtp_ports%& can be identified either by name (defined in
13302 &_/etc/services_&) or by number. However, when ports are given with individual
13303 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13304
13305
13306
13307 .section "Special IP listening addresses" "SECID90"
13308 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13309 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13310 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13311 instead of setting up separate listening sockets for each interface. The
13312 default value of &%local_interfaces%& is
13313 .code
13314 local_interfaces = 0.0.0.0
13315 .endd
13316 when Exim is built without IPv6 support; otherwise it is:
13317 .code
13318 local_interfaces = <; ::0 ; 0.0.0.0
13319 .endd
13320 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13321
13322
13323
13324 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13325 The &%-oX%& command line option can be used to override the values of
13326 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13327 instance. Another way of doing this would be to use macros and the &%-D%&
13328 option. However, &%-oX%& can be used by any admin user, whereas modification of
13329 the runtime configuration by &%-D%& is allowed only when the caller is root or
13330 exim.
13331
13332 The value of &%-oX%& is a list of items. The default colon separator can be
13333 changed in the usual way if required. If there are any items that do not
13334 contain dots or colons (that is, are not IP addresses), the value of
13335 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13336 items that do contain dots or colons, the value of &%local_interfaces%& is
13337 replaced by those items. Thus, for example,
13338 .code
13339 -oX 1225
13340 .endd
13341 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13342 whereas
13343 .code
13344 -oX 192.168.34.5.1125
13345 .endd
13346 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13347 (However, since &%local_interfaces%& now contains no items without ports, the
13348 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13349
13350
13351
13352 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13353 .cindex "ssmtp protocol"
13354 .cindex "smtps protocol"
13355 .cindex "SMTP" "ssmtp protocol"
13356 .cindex "SMTP" "smtps protocol"
13357 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13358 before the STARTTLS command was standardized for SMTP. Some legacy clients
13359 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13360 list of port numbers or service names,
13361 connections to those ports must use SSMTP. The most
13362 common use of this option is expected to be
13363 .code
13364 tls_on_connect_ports = 465
13365 .endd
13366 because 465 is the usual port number used by the legacy clients. There is also
13367 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13368 this way when a daemon is started.
13369
13370 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13371 daemon to listen on those ports. You must still specify them in
13372 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13373 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13374 connections via the daemon.)
13375
13376
13377
13378
13379 .section "IPv6 address scopes" "SECID92"
13380 .cindex "IPv6" "address scopes"
13381 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13382 can, in principle, have the same link-local IPv6 address on different
13383 interfaces. Thus, additional information is needed, over and above the IP
13384 address, to distinguish individual interfaces. A convention of using a
13385 percent sign followed by something (often the interface name) has been
13386 adopted in some cases, leading to addresses like this:
13387 .code
13388 fe80::202:b3ff:fe03:45c1%eth0
13389 .endd
13390 To accommodate this usage, a percent sign followed by an arbitrary string is
13391 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13392 to convert a textual IPv6 address for actual use. This function recognizes the
13393 percent convention in operating systems that support it, and it processes the
13394 address appropriately. Unfortunately, some older libraries have problems with
13395 &[getaddrinfo()]&. If
13396 .code
13397 IPV6_USE_INET_PTON=yes
13398 .endd
13399 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13400 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13401 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13402 function.) Of course, this means that the additional functionality of
13403 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13404
13405 .section "Disabling IPv6" "SECID93"
13406 .cindex "IPv6" "disabling"
13407 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13408 run on a host whose kernel does not support IPv6. The binary will fall back to
13409 using IPv4, but it may waste resources looking up AAAA records, and trying to
13410 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13411 .oindex "&%disable_ipv6%&"
13412 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13413 activities take place. AAAA records are never looked up, and any IPv6 addresses
13414 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13415 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13416 to handle IPv6 literal addresses.
13417
13418 On the other hand, when IPv6 is in use, there may be times when you want to
13419 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13420 option to globally suppress the lookup of AAAA records for specified domains,
13421 and you can use the &%ignore_target_hosts%& generic router option to ignore
13422 IPv6 addresses in an individual router.
13423
13424
13425
13426 .section "Examples of starting a listening daemon" "SECID94"
13427 The default case in an IPv6 environment is
13428 .code
13429 daemon_smtp_ports = smtp
13430 local_interfaces = <; ::0 ; 0.0.0.0
13431 .endd
13432 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13433 Either one or two sockets may be used, depending on the characteristics of
13434 the TCP/IP stack. (This is complicated and messy; for more information,
13435 read the comments in the &_daemon.c_& source file.)
13436
13437 To specify listening on ports 25 and 26 on all interfaces:
13438 .code
13439 daemon_smtp_ports = 25 : 26
13440 .endd
13441 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13442 .code
13443 local_interfaces = <; ::0.25     ; ::0.26 \
13444                       0.0.0.0.25 ; 0.0.0.0.26
13445 .endd
13446 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13447 IPv4 loopback address only:
13448 .code
13449 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13450 .endd
13451 To specify listening on the default port on specific interfaces only:
13452 .code
13453 local_interfaces = 10.0.0.67 : 192.168.34.67
13454 .endd
13455 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13456
13457
13458
13459 .section "Recognizing the local host" "SECTreclocipadd"
13460 The &%local_interfaces%& option is also used when Exim needs to determine
13461 whether or not an IP address refers to the local host. That is, the IP
13462 addresses of all the interfaces on which a daemon is listening are always
13463 treated as local.
13464
13465 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13466 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13467 available interfaces from the operating system, and extracts the relevant
13468 (that is, IPv4 or IPv6) addresses to use for checking.
13469
13470 Some systems set up large numbers of virtual interfaces in order to provide
13471 many virtual web servers. In this situation, you may want to listen for
13472 email on only a few of the available interfaces, but nevertheless treat all
13473 interfaces as local when routing. You can do this by setting
13474 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13475 &"all"& wildcard values. These addresses are recognized as local, but are not
13476 used for listening. Consider this example:
13477 .code
13478 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13479                       192.168.53.235 ; \
13480                       3ffe:2101:12:1:a00:20ff:fe86:a061
13481
13482 extra_local_interfaces = <; ::0 ; 0.0.0.0
13483 .endd
13484 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13485 address, but all available interface addresses are treated as local when
13486 Exim is routing.
13487
13488 In some environments the local host name may be in an MX list, but with an IP
13489 address that is not assigned to any local interface. In other cases it may be
13490 desirable to treat other host names as if they referred to the local host. Both
13491 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13492 This contains host names rather than IP addresses. When a host is referenced
13493 during routing, either via an MX record or directly, it is treated as the local
13494 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13495 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13496
13497
13498
13499 .section "Delivering to a remote host" "SECID95"
13500 Delivery to a remote host is handled by the smtp transport. By default, it
13501 allows the system's TCP/IP functions to choose which interface to use (if
13502 there is more than one) when connecting to a remote host. However, the
13503 &%interface%& option can be set to specify which interface is used. See the
13504 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13505 details.
13506
13507
13508
13509
13510 . ////////////////////////////////////////////////////////////////////////////
13511 . ////////////////////////////////////////////////////////////////////////////
13512
13513 .chapter "Main configuration" "CHAPmainconfig"
13514 .scindex IIDconfima "configuration file" "main section"
13515 .scindex IIDmaiconf "main configuration"
13516 The first part of the run time configuration file contains three types of item:
13517
13518 .ilist
13519 Macro definitions: These lines start with an upper case letter. See section
13520 &<<SECTmacrodefs>>& for details of macro processing.
13521 .next
13522 Named list definitions: These lines start with one of the words &"domainlist"&,
13523 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13524 section &<<SECTnamedlists>>&.
13525 .next
13526 Main configuration settings: Each setting occupies one line of the file
13527 (with possible continuations). If any setting is preceded by the word
13528 &"hide"&, the &%-bP%& command line option displays its value to admin users
13529 only. See section &<<SECTcos>>& for a description of the syntax of these option
13530 settings.
13531 .endlist
13532
13533 This chapter specifies all the main configuration options, along with their
13534 types and default values. For ease of finding a particular option, they appear
13535 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13536 are now so many options, they are first listed briefly in functional groups, as
13537 an aid to finding the name of the option you are looking for. Some options are
13538 listed in more than one group.
13539
13540 .section "Miscellaneous" "SECID96"
13541 .table2
13542 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13543 .row &%disable_ipv6%&                "do no IPv6 processing"
13544 .row &%keep_malformed%&              "for broken files &-- should not happen"
13545 .row &%localhost_number%&            "for unique message ids in clusters"
13546 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13547 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13548 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13549 .row &%print_topbitchars%&           "top-bit characters are printing"
13550 .row &%timezone%&                    "force time zone"
13551 .endtable
13552
13553
13554 .section "Exim parameters" "SECID97"
13555 .table2
13556 .row &%exim_group%&                  "override compiled-in value"
13557 .row &%exim_path%&                   "override compiled-in value"
13558 .row &%exim_user%&                   "override compiled-in value"
13559 .row &%primary_hostname%&            "default from &[uname()]&"
13560 .row &%split_spool_directory%&       "use multiple directories"
13561 .row &%spool_directory%&             "override compiled-in value"
13562 .endtable
13563
13564
13565
13566 .section "Privilege controls" "SECID98"
13567 .table2
13568 .row &%admin_groups%&                "groups that are Exim admin users"
13569 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13570 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13571 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13572 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13573 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13574 .row &%never_users%&                 "do not run deliveries as these"
13575 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13576 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13577 .row &%trusted_groups%&              "groups that are trusted"
13578 .row &%trusted_users%&               "users that are trusted"
13579 .endtable
13580
13581
13582
13583 .section "Logging" "SECID99"
13584 .table2
13585 .row &%event_action%&                "custom logging"
13586 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13587 .row &%log_file_path%&               "override compiled-in value"
13588 .row &%log_selector%&                "set/unset optional logging"
13589 .row &%log_timezone%&                "add timezone to log lines"
13590 .row &%message_logs%&                "create per-message logs"
13591 .row &%preserve_message_logs%&       "after message completion"
13592 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13593 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13594 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13595 .row &%syslog_facility%&             "set syslog &""facility""& field"
13596 .row &%syslog_processname%&          "set syslog &""ident""& field"
13597 .row &%syslog_timestamp%&            "timestamp syslog lines"
13598 .row &%write_rejectlog%&             "control use of message log"
13599 .endtable
13600
13601
13602
13603 .section "Frozen messages" "SECID100"
13604 .table2
13605 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13606 .row &%freeze_tell%&                 "send message when freezing"
13607 .row &%move_frozen_messages%&        "to another directory"
13608 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13609 .endtable
13610
13611
13612
13613 .section "Data lookups" "SECID101"
13614 .table2
13615 .row &%ibase_servers%&               "InterBase servers"
13616 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13617 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13618 .row &%ldap_cert_file%&              "client cert file for LDAP"
13619 .row &%ldap_cert_key%&               "client key file for LDAP"
13620 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13621 .row &%ldap_default_servers%&        "used if no server in query"
13622 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13623 .row &%ldap_start_tls%&              "require TLS within LDAP"
13624 .row &%ldap_version%&                "set protocol version"
13625 .row &%lookup_open_max%&             "lookup files held open"
13626 .row &%mysql_servers%&               "default MySQL servers"
13627 .row &%oracle_servers%&              "Oracle servers"
13628 .row &%pgsql_servers%&               "default PostgreSQL servers"
13629 .row &%sqlite_lock_timeout%&         "as it says"
13630 .endtable
13631
13632
13633
13634 .section "Message ids" "SECID102"
13635 .table2
13636 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13637 .row &%message_id_header_text%&      "ditto"
13638 .endtable
13639
13640
13641
13642 .section "Embedded Perl Startup" "SECID103"
13643 .table2
13644 .row &%perl_at_start%&               "always start the interpreter"
13645 .row &%perl_startup%&                "code to obey when starting Perl"
13646 .row &%perl_taintmode%&              "enable taint mode in Perl"
13647 .endtable
13648
13649
13650
13651 .section "Daemon" "SECID104"
13652 .table2
13653 .row &%daemon_smtp_ports%&           "default ports"
13654 .row &%daemon_startup_retries%&      "number of times to retry"
13655 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13656 .row &%extra_local_interfaces%&      "not necessarily listened on"
13657 .row &%local_interfaces%&            "on which to listen, with optional ports"
13658 .row &%pid_file_path%&               "override compiled-in value"
13659 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13660 .endtable
13661
13662
13663
13664 .section "Resource control" "SECID105"
13665 .table2
13666 .row &%check_log_inodes%&            "before accepting a message"
13667 .row &%check_log_space%&             "before accepting a message"
13668 .row &%check_spool_inodes%&          "before accepting a message"
13669 .row &%check_spool_space%&           "before accepting a message"
13670 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13671 .row &%queue_only_load%&             "queue incoming if load high"
13672 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13673 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13674 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13675 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13676 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13677 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13678 .row &%smtp_accept_max_per_connection%& "messages per connection"
13679 .row &%smtp_accept_max_per_host%&    "connections from one host"
13680 .row &%smtp_accept_queue%&           "queue mail if more connections"
13681 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13682                                            connection"
13683 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13684 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13685 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13686 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13687 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13688 .endtable
13689
13690
13691
13692 .section "Policy controls" "SECID106"
13693 .table2
13694 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13695 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13696 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13697 .row &%acl_smtp_auth%&               "ACL for AUTH"
13698 .row &%acl_smtp_connect%&            "ACL for connection"
13699 .row &%acl_smtp_data%&               "ACL for DATA"
13700 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13701 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13702 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13703 .row &%acl_smtp_expn%&               "ACL for EXPN"
13704 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13705 .row &%acl_smtp_mail%&               "ACL for MAIL"
13706 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13707 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13708 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13709 .row &%acl_smtp_predata%&            "ACL for start of data"
13710 .row &%acl_smtp_quit%&               "ACL for QUIT"
13711 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13712 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13713 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13714 .row &%av_scanner%&                  "specify virus scanner"
13715 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13716                                       words""&"
13717 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13718 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13719 .row &%header_maxsize%&              "total size of message header"
13720 .row &%header_line_maxsize%&         "individual header line limit"
13721 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13722 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13723 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13724 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13725 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13726 .row &%host_lookup%&                 "host name looked up for these hosts"
13727 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13728 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13729 .row &%host_reject_connection%&      "reject connection from these hosts"
13730 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13731 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13732 .row &%message_size_limit%&          "for all messages"
13733 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13734 .row &%spamd_address%&               "set interface to SpamAssassin"
13735 .row &%strict_acl_vars%&             "object to unset ACL variables"
13736 .endtable
13737
13738
13739
13740 .section "Callout cache" "SECID107"
13741 .table2
13742 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13743                                          item"
13744 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13745                                          item"
13746 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13747 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13748 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13749 .endtable
13750
13751
13752
13753 .section "TLS" "SECID108"
13754 .table2
13755 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13756 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13757 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13758 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13759 .row &%tls_certificate%&             "location of server certificate"
13760 .row &%tls_crl%&                     "certificate revocation list"
13761 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13762 .row &%tls_dhparam%&                 "DH parameters for server"
13763 .row &%tls_eccurve%&                 "EC curve selection for server"
13764 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13765 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13766 .row &%tls_privatekey%&              "location of server private key"
13767 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13768 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13769 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13770 .row &%tls_verify_certificates%&     "expected client certificates"
13771 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13772 .endtable
13773
13774
13775
13776 .section "Local user handling" "SECID109"
13777 .table2
13778 .row &%finduser_retries%&            "useful in NIS environments"
13779 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13780 .row &%gecos_pattern%&               "ditto"
13781 .row &%max_username_length%&         "for systems that truncate"
13782 .row &%unknown_login%&               "used when no login name found"
13783 .row &%unknown_username%&            "ditto"
13784 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13785 .row &%uucp_from_sender%&            "ditto"
13786 .endtable
13787
13788
13789
13790 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13791 .table2
13792 .row &%header_maxsize%&              "total size of message header"
13793 .row &%header_line_maxsize%&         "individual header line limit"
13794 .row &%message_size_limit%&          "applies to all messages"
13795 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13796 .row &%received_header_text%&        "expanded to make &'Received:'&"
13797 .row &%received_headers_max%&        "for mail loop detection"
13798 .row &%recipients_max%&              "limit per message"
13799 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13800 .endtable
13801
13802
13803
13804
13805 .section "Non-SMTP incoming messages" "SECID111"
13806 .table2
13807 .row &%receive_timeout%&             "for non-SMTP messages"
13808 .endtable
13809
13810
13811
13812
13813
13814 .section "Incoming SMTP messages" "SECID112"
13815 See also the &'Policy controls'& section above.
13816
13817 .table2
13818 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13819 .row &%host_lookup%&                 "host name looked up for these hosts"
13820 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13821 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13822 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13823 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13824 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13825 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13826 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13827 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13828 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13829 .row &%smtp_accept_max_per_connection%& "messages per connection"
13830 .row &%smtp_accept_max_per_host%&    "connections from one host"
13831 .row &%smtp_accept_queue%&           "queue mail if more connections"
13832 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13833                                            connection"
13834 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13835 .row &%smtp_active_hostname%&        "host name to use in messages"
13836 .row &%smtp_banner%&                 "text for welcome banner"
13837 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13838 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13839 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13840 .row &%smtp_etrn_command%&           "what to run for ETRN"
13841 .row &%smtp_etrn_serialize%&         "only one at once"
13842 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13843 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13844 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13845 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13846 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13847 .row &%smtp_receive_timeout%&        "per command or data line"
13848 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13849 .row &%smtp_return_error_details%&   "give detail on rejections"
13850 .endtable
13851
13852
13853
13854 .section "SMTP extensions" "SECID113"
13855 .table2
13856 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13857 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13858 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13859 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13860 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13861 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13862 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13863 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13864 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13865 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13866 .endtable
13867
13868
13869
13870 .section "Processing messages" "SECID114"
13871 .table2
13872 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13873 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13874 .row &%allow_utf8_domains%&          "in addresses"
13875 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13876                                       words""&"
13877 .row &%delivery_date_remove%&        "from incoming messages"
13878 .row &%envelope_to_remove%&          "from incoming messages"
13879 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13880 .row &%headers_charset%&             "default for translations"
13881 .row &%qualify_domain%&              "default for senders"
13882 .row &%qualify_recipient%&           "default for recipients"
13883 .row &%return_path_remove%&          "from incoming messages"
13884 .row &%strip_excess_angle_brackets%& "in addresses"
13885 .row &%strip_trailing_dot%&          "at end of addresses"
13886 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13887 .endtable
13888
13889
13890
13891 .section "System filter" "SECID115"
13892 .table2
13893 .row &%system_filter%&               "locate system filter"
13894 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13895                                             directory"
13896 .row &%system_filter_file_transport%& "transport for delivery to a file"
13897 .row &%system_filter_group%&         "group for filter running"
13898 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13899 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13900 .row &%system_filter_user%&          "user for filter running"
13901 .endtable
13902
13903
13904
13905 .section "Routing and delivery" "SECID116"
13906 .table2
13907 .row &%disable_ipv6%&                "do no IPv6 processing"
13908 .row &%dns_again_means_nonexist%&    "for broken domains"
13909 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13910 .row &%dns_dnssec_ok%&               "parameter for resolver"
13911 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13912 .row &%dns_retrans%&                 "parameter for resolver"
13913 .row &%dns_retry%&                   "parameter for resolver"
13914 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13915 .row &%dns_use_edns0%&               "parameter for resolver"
13916 .row &%hold_domains%&                "hold delivery for these domains"
13917 .row &%local_interfaces%&            "for routing checks"
13918 .row &%queue_domains%&               "no immediate delivery for these"
13919 .row &%queue_only%&                  "no immediate delivery at all"
13920 .row &%queue_only_file%&             "no immediate delivery if file exists"
13921 .row &%queue_only_load%&             "no immediate delivery if load is high"
13922 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13923 .row &%queue_only_override%&         "allow command line to override"
13924 .row &%queue_run_in_order%&          "order of arrival"
13925 .row &%queue_run_max%&               "of simultaneous queue runners"
13926 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13927 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13928 .row &%remote_sort_domains%&         "order of remote deliveries"
13929 .row &%retry_data_expire%&           "timeout for retry data"
13930 .row &%retry_interval_max%&          "safety net for retry rules"
13931 .endtable
13932
13933
13934
13935 .section "Bounce and warning messages" "SECID117"
13936 .table2
13937 .row &%bounce_message_file%&         "content of bounce"
13938 .row &%bounce_message_text%&         "content of bounce"
13939 .row &%bounce_return_body%&          "include body if returning message"
13940 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13941 .row &%bounce_return_message%&       "include original message in bounce"
13942 .row &%bounce_return_size_limit%&    "limit on returned message"
13943 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13944 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13945 .row &%errors_copy%&                 "copy bounce messages"
13946 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13947 .row &%delay_warning%&               "time schedule"
13948 .row &%delay_warning_condition%&     "condition for warning messages"
13949 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13950 .row &%smtp_return_error_details%&   "give detail on rejections"
13951 .row &%warn_message_file%&           "content of warning message"
13952 .endtable
13953
13954
13955
13956 .section "Alphabetical list of main options" "SECTalomo"
13957 Those options that undergo string expansion before use are marked with
13958 &dagger;.
13959
13960 .option accept_8bitmime main boolean true
13961 .cindex "8BITMIME"
13962 .cindex "8-bit characters"
13963 .cindex "log" "selectors"
13964 .cindex "log" "8BITMIME"
13965 This option causes Exim to send 8BITMIME in its response to an SMTP
13966 EHLO command, and to accept the BODY= parameter on MAIL commands.
13967 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13968 takes no steps to do anything special with messages received by this route.
13969
13970 Historically Exim kept this option off by default, but the maintainers
13971 feel that in today's Internet, this causes more problems than it solves.
13972 It now defaults to true.
13973 A more detailed analysis of the issues is provided by Dan Bernstein:
13974 .display
13975 &url(http://cr.yp.to/smtp/8bitmime.html)
13976 .endd
13977
13978 To log received 8BITMIME status use
13979 .code
13980 log_selector = +8bitmime
13981 .endd
13982
13983 .option acl_not_smtp main string&!! unset
13984 .cindex "&ACL;" "for non-SMTP messages"
13985 .cindex "non-SMTP messages" "ACLs for"
13986 This option defines the ACL that is run when a non-SMTP message has been
13987 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13988 further details.
13989
13990 .option acl_not_smtp_mime main string&!! unset
13991 This option defines the ACL that is run for individual MIME parts of non-SMTP
13992 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13993 SMTP messages.
13994
13995 .option acl_not_smtp_start main string&!! unset
13996 .cindex "&ACL;" "at start of non-SMTP message"
13997 .cindex "non-SMTP messages" "ACLs for"
13998 This option defines the ACL that is run before Exim starts reading a
13999 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14000
14001 .option acl_smtp_auth main string&!! unset
14002 .cindex "&ACL;" "setting up for SMTP commands"
14003 .cindex "AUTH" "ACL for"
14004 This option defines the ACL that is run when an SMTP AUTH command is
14005 received. See chapter &<<CHAPACL>>& for further details.
14006
14007 .option acl_smtp_connect main string&!! unset
14008 .cindex "&ACL;" "on SMTP connection"
14009 This option defines the ACL that is run when an SMTP connection is received.
14010 See chapter &<<CHAPACL>>& for further details.
14011
14012 .option acl_smtp_data main string&!! unset
14013 .cindex "DATA" "ACL for"
14014 This option defines the ACL that is run after an SMTP DATA command has been
14015 processed and the message itself has been received, but before the final
14016 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14017
14018 .option acl_smtp_data_prdr main string&!! accept
14019 .cindex "PRDR" "ACL for"
14020 .cindex "DATA" "PRDR ACL for"
14021 .cindex "&ACL;" "PRDR-related"
14022 .cindex "&ACL;" "per-user data processing"
14023 This option defines the ACL that,
14024 if the PRDR feature has been negotiated,
14025 is run for each recipient after an SMTP DATA command has been
14026 processed and the message itself has been received, but before the
14027 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14028
14029 .option acl_smtp_dkim main string&!! unset
14030 .cindex DKIM "ACL for"
14031 This option defines the ACL that is run for each DKIM signature
14032 of a received message.
14033 See chapter &<<CHAPdkim>>& for further details.
14034
14035 .option acl_smtp_etrn main string&!! unset
14036 .cindex "ETRN" "ACL for"
14037 This option defines the ACL that is run when an SMTP ETRN command is
14038 received. See chapter &<<CHAPACL>>& for further details.
14039
14040 .option acl_smtp_expn main string&!! unset
14041 .cindex "EXPN" "ACL for"
14042 This option defines the ACL that is run when an SMTP EXPN command is
14043 received. See chapter &<<CHAPACL>>& for further details.
14044
14045 .option acl_smtp_helo main string&!! unset
14046 .cindex "EHLO" "ACL for"
14047 .cindex "HELO" "ACL for"
14048 This option defines the ACL that is run when an SMTP EHLO or HELO
14049 command is received. See chapter &<<CHAPACL>>& for further details.
14050
14051
14052 .option acl_smtp_mail main string&!! unset
14053 .cindex "MAIL" "ACL for"
14054 This option defines the ACL that is run when an SMTP MAIL command is
14055 received. See chapter &<<CHAPACL>>& for further details.
14056
14057 .option acl_smtp_mailauth main string&!! unset
14058 .cindex "AUTH" "on MAIL command"
14059 This option defines the ACL that is run when there is an AUTH parameter on
14060 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14061 &<<CHAPSMTPAUTH>>& for details of authentication.
14062
14063 .option acl_smtp_mime main string&!! unset
14064 .cindex "MIME content scanning" "ACL for"
14065 This option is available when Exim is built with the content-scanning
14066 extension. It defines the ACL that is run for each MIME part in a message. See
14067 section &<<SECTscanmimepart>>& for details.
14068
14069 .option acl_smtp_notquit main string&!! unset
14070 .cindex "not-QUIT, ACL for"
14071 This option defines the ACL that is run when an SMTP session
14072 ends without a QUIT command being received.
14073 See chapter &<<CHAPACL>>& for further details.
14074
14075 .option acl_smtp_predata main string&!! unset
14076 This option defines the ACL that is run when an SMTP DATA command is
14077 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14078 further details.
14079
14080 .option acl_smtp_quit main string&!! unset
14081 .cindex "QUIT, ACL for"
14082 This option defines the ACL that is run when an SMTP QUIT command is
14083 received. See chapter &<<CHAPACL>>& for further details.
14084
14085 .option acl_smtp_rcpt main string&!! unset
14086 .cindex "RCPT" "ACL for"
14087 This option defines the ACL that is run when an SMTP RCPT command is
14088 received. See chapter &<<CHAPACL>>& for further details.
14089
14090 .option acl_smtp_starttls main string&!! unset
14091 .cindex "STARTTLS, ACL for"
14092 This option defines the ACL that is run when an SMTP STARTTLS command is
14093 received. See chapter &<<CHAPACL>>& for further details.
14094
14095 .option acl_smtp_vrfy main string&!! unset
14096 .cindex "VRFY" "ACL for"
14097 This option defines the ACL that is run when an SMTP VRFY command is
14098 received. See chapter &<<CHAPACL>>& for further details.
14099
14100 .option add_environment main "string list" empty
14101 .cindex "environment" "set values"
14102 This option allows to set individual environment variables that the
14103 currently linked libraries and programs in child processes use.
14104 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14105
14106 .option admin_groups main "string list&!!" unset
14107 .cindex "admin user"
14108 This option is expanded just once, at the start of Exim's processing. If the
14109 current group or any of the supplementary groups of an Exim caller is in this
14110 colon-separated list, the caller has admin privileges. If all your system
14111 programmers are in a specific group, for example, you can give them all Exim
14112 admin privileges by putting that group in &%admin_groups%&. However, this does
14113 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14114 To permit this, you have to add individuals to the Exim group.
14115
14116 .option allow_domain_literals main boolean false
14117 .cindex "domain literal"
14118 If this option is set, the RFC 2822 domain literal format is permitted in
14119 email addresses. The option is not set by default, because the domain literal
14120 format is not normally required these days, and few people know about it. It
14121 has, however, been exploited by mail abusers.
14122
14123 Unfortunately, it seems that some DNS black list maintainers are using this
14124 format to report black listing to postmasters. If you want to accept messages
14125 addressed to your hosts by IP address, you need to set
14126 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14127 domains (defined in the named domain list &%local_domains%& in the default
14128 configuration). This &"magic string"& matches the domain literal form of all
14129 the local host's IP addresses.
14130
14131
14132 .option allow_mx_to_ip main boolean false
14133 .cindex "MX record" "pointing to IP address"
14134 It appears that more and more DNS zone administrators are breaking the rules
14135 and putting domain names that look like IP addresses on the right hand side of
14136 MX records. Exim follows the rules and rejects this, giving an error message
14137 that explains the misconfiguration. However, some other MTAs support this
14138 practice, so to avoid &"Why can't Exim do this?"& complaints,
14139 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14140 recommended, except when you have no other choice.
14141
14142 .option allow_utf8_domains main boolean false
14143 .cindex "domain" "UTF-8 characters in"
14144 .cindex "UTF-8" "in domain name"
14145 Lots of discussion is going on about internationalized domain names. One
14146 camp is strongly in favour of just using UTF-8 characters, and it seems
14147 that at least two other MTAs permit this. This option allows Exim users to
14148 experiment if they wish.
14149
14150 If it is set true, Exim's domain parsing function allows valid
14151 UTF-8 multicharacters to appear in domain name components, in addition to
14152 letters, digits, and hyphens. However, just setting this option is not
14153 enough; if you want to look up these domain names in the DNS, you must also
14154 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14155 suitable setting is:
14156 .code
14157 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14158   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14159 .endd
14160 Alternatively, you can just disable this feature by setting
14161 .code
14162 dns_check_names_pattern =
14163 .endd
14164 That is, set the option to an empty string so that no check is done.
14165
14166
14167 .option auth_advertise_hosts main "host list&!!" *
14168 .cindex "authentication" "advertising"
14169 .cindex "AUTH" "advertising"
14170 If any server authentication mechanisms are configured, Exim advertises them in
14171 response to an EHLO command only if the calling host matches this list.
14172 Otherwise, Exim does not advertise AUTH.
14173 Exim does not accept AUTH commands from clients to which it has not
14174 advertised the availability of AUTH. The advertising of individual
14175 authentication mechanisms can be controlled by the use of the
14176 &%server_advertise_condition%& generic authenticator option on the individual
14177 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14178
14179 Certain mail clients (for example, Netscape) require the user to provide a name
14180 and password for authentication if AUTH is advertised, even though it may
14181 not be needed (the host may accept messages from hosts on its local LAN without
14182 authentication, for example). The &%auth_advertise_hosts%& option can be used
14183 to make these clients more friendly by excluding them from the set of hosts to
14184 which Exim advertises AUTH.
14185
14186 .cindex "AUTH" "advertising when encrypted"
14187 If you want to advertise the availability of AUTH only when the connection
14188 is encrypted using TLS, you can make use of the fact that the value of this
14189 option is expanded, with a setting like this:
14190 .code
14191 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14192 .endd
14193 .vindex "&$tls_in_cipher$&"
14194 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14195 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14196 expansion is *, which matches all hosts.
14197
14198
14199 .option auto_thaw main time 0s
14200 .cindex "thawing messages"
14201 .cindex "unfreezing messages"
14202 If this option is set to a time greater than zero, a queue runner will try a
14203 new delivery attempt on any frozen message, other than a bounce message, if
14204 this much time has passed since it was frozen. This may result in the message
14205 being re-frozen if nothing has changed since the last attempt. It is a way of
14206 saying &"keep on trying, even though there are big problems"&.
14207
14208 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14209 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14210 thought to be very useful any more, and its use should probably be avoided.
14211
14212
14213 .option av_scanner main string "see below"
14214 This option is available if Exim is built with the content-scanning extension.
14215 It specifies which anti-virus scanner to use. The default value is:
14216 .code
14217 sophie:/var/run/sophie
14218 .endd
14219 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14220 before use. See section &<<SECTscanvirus>>& for further details.
14221
14222
14223 .option bi_command main string unset
14224 .oindex "&%-bi%&"
14225 This option supplies the name of a command that is run when Exim is called with
14226 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14227 just the command name, it is not a complete command line. If an argument is
14228 required, it must come from the &%-oA%& command line option.
14229
14230
14231 .option bounce_message_file main string unset
14232 .cindex "bounce message" "customizing"
14233 .cindex "customizing" "bounce message"
14234 This option defines a template file containing paragraphs of text to be used
14235 for constructing bounce messages.  Details of the file's contents are given in
14236 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14237
14238
14239 .option bounce_message_text main string unset
14240 When this option is set, its contents are included in the default bounce
14241 message immediately after &"This message was created automatically by mail
14242 delivery software."& It is not used if &%bounce_message_file%& is set.
14243
14244 .option bounce_return_body main boolean true
14245 .cindex "bounce message" "including body"
14246 This option controls whether the body of an incoming message is included in a
14247 bounce message when &%bounce_return_message%& is true. The default setting
14248 causes the entire message, both header and body, to be returned (subject to the
14249 value of &%bounce_return_size_limit%&). If this option is false, only the
14250 message header is included. In the case of a non-SMTP message containing an
14251 error that is detected during reception, only those header lines preceding the
14252 point at which the error was detected are returned.
14253 .cindex "bounce message" "including original"
14254
14255 .option bounce_return_linesize_limit main integer 998
14256 .cindex "size" "of bounce lines, limit"
14257 .cindex "bounce message" "line length limit"
14258 .cindex "limit" "bounce message line length"
14259 This option sets a limit in bytes on the line length of messages
14260 that are returned to senders due to delivery problems,
14261 when &%bounce_return_message%& is true.
14262 The default value corresponds to RFC limits.
14263 If the message being returned has lines longer than this value it is
14264 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14265
14266 The option also applies to bounces returned when an error is detected
14267 during reception of a message.
14268 In this case lines from the original are truncated.
14269
14270 The option does not apply to messages generated by an &(autoreply)& transport.
14271
14272
14273 .option bounce_return_message main boolean true
14274 If this option is set false, none of the original message is included in
14275 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14276 &%bounce_return_body%&.
14277
14278
14279 .option bounce_return_size_limit main integer 100K
14280 .cindex "size" "of bounce, limit"
14281 .cindex "bounce message" "size limit"
14282 .cindex "limit" "bounce message size"
14283 This option sets a limit in bytes on the size of messages that are returned to
14284 senders as part of bounce messages when &%bounce_return_message%& is true. The
14285 limit should be less than the value of the global &%message_size_limit%& and of
14286 any &%message_size_limit%& settings on transports, to allow for the bounce text
14287 that Exim generates. If this option is set to zero there is no limit.
14288
14289 When the body of any message that is to be included in a bounce message is
14290 greater than the limit, it is truncated, and a comment pointing this out is
14291 added at the top. The actual cutoff may be greater than the value given, owing
14292 to the use of buffering for transferring the message in chunks (typically 8K in
14293 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14294 messages.
14295
14296 .option bounce_sender_authentication main string unset
14297 .cindex "bounce message" "sender authentication"
14298 .cindex "authentication" "bounce message"
14299 .cindex "AUTH" "on bounce message"
14300 This option provides an authenticated sender address that is sent with any
14301 bounce messages generated by Exim that are sent over an authenticated SMTP
14302 connection. A typical setting might be:
14303 .code
14304 bounce_sender_authentication = mailer-daemon@my.domain.example
14305 .endd
14306 which would cause bounce messages to be sent using the SMTP command:
14307 .code
14308 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14309 .endd
14310 The value of &%bounce_sender_authentication%& must always be a complete email
14311 address.
14312
14313 .option callout_domain_negative_expire main time 3h
14314 .cindex "caching" "callout timeouts"
14315 .cindex "callout" "caching timeouts"
14316 This option specifies the expiry time for negative callout cache data for a
14317 domain. See section &<<SECTcallver>>& for details of callout verification, and
14318 section &<<SECTcallvercache>>& for details of the caching.
14319
14320
14321 .option callout_domain_positive_expire main time 7d
14322 This option specifies the expiry time for positive callout cache data for a
14323 domain. See section &<<SECTcallver>>& for details of callout verification, and
14324 section &<<SECTcallvercache>>& for details of the caching.
14325
14326
14327 .option callout_negative_expire main time 2h
14328 This option specifies the expiry time for negative callout cache data for an
14329 address. See section &<<SECTcallver>>& for details of callout verification, and
14330 section &<<SECTcallvercache>>& for details of the caching.
14331
14332
14333 .option callout_positive_expire main time 24h
14334 This option specifies the expiry time for positive callout cache data for an
14335 address. See section &<<SECTcallver>>& for details of callout verification, and
14336 section &<<SECTcallvercache>>& for details of the caching.
14337
14338
14339 .option callout_random_local_part main string&!! "see below"
14340 This option defines the &"random"& local part that can be used as part of
14341 callout verification. The default value is
14342 .code
14343 $primary_hostname-$tod_epoch-testing
14344 .endd
14345 See section &<<CALLaddparcall>>& for details of how this value is used.
14346
14347
14348 .new
14349 .option check_log_inodes main integer 100
14350 .wen
14351 See &%check_spool_space%& below.
14352
14353
14354 .new
14355 .option check_log_space main integer 10M
14356 .wen
14357 See &%check_spool_space%& below.
14358
14359 .oindex "&%check_rfc2047_length%&"
14360 .cindex "RFC 2047" "disabling length check"
14361 .option check_rfc2047_length main boolean true
14362 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14363 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14364 word; strings to be encoded that exceed this length are supposed to use
14365 multiple encoded words. By default, Exim does not recognize encoded words that
14366 exceed the maximum length. However, it seems that some software, in violation
14367 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14368 set false, Exim recognizes encoded words of any length.
14369
14370
14371 .new
14372 .option check_spool_inodes main integer 100
14373 .wen
14374 See &%check_spool_space%& below.
14375
14376
14377 .new
14378 .option check_spool_space main integer 10M
14379 .wen
14380 .cindex "checking disk space"
14381 .cindex "disk space, checking"
14382 .cindex "spool directory" "checking space"
14383 The four &%check_...%& options allow for checking of disk resources before a
14384 message is accepted.
14385
14386 .vindex "&$log_inodes$&"
14387 .vindex "&$log_space$&"
14388 .vindex "&$spool_inodes$&"
14389 .vindex "&$spool_space$&"
14390 When any of these options are nonzero, they apply to all incoming messages. If you
14391 want to apply different checks to different kinds of message, you can do so by
14392 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14393 &$spool_space$& in an ACL with appropriate additional conditions.
14394
14395
14396 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14397 either value is greater than zero, for example:
14398 .code
14399 check_spool_space = 100M
14400 check_spool_inodes = 100
14401 .endd
14402 The spool partition is the one that contains the directory defined by
14403 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14404 transit.
14405
14406 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14407 files are written if either is greater than zero. These should be set only if
14408 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14409
14410 If there is less space or fewer inodes than requested, Exim refuses to accept
14411 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14412 error response to the MAIL command. If ESMTP is in use and there was a
14413 SIZE parameter on the MAIL command, its value is added to the
14414 &%check_spool_space%& value, and the check is performed even if
14415 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14416
14417 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14418 number of kilobytes (though specified in bytes).
14419 If a non-multiple of 1024 is specified, it is rounded up.
14420
14421 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14422 failure a message is written to stderr and Exim exits with a non-zero code, as
14423 it obviously cannot send an error message of any kind.
14424
14425 .new
14426 There is a slight performance penalty for these checks.
14427 Versions of Exim preceding 4.88 had these disabled by default;
14428 high-rate intallations confident they will never run out of resources
14429 may wish to deliberately disable them.
14430 .wen
14431
14432 .new
14433 .option chunking_advertise_hosts main "host list&!!" *
14434 .cindex CHUNKING advertisement
14435 .cindex "RFC 3030" "CHUNKING"
14436 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14437 these hosts.
14438 Hosts may use the BDAT command as an alternate to DATA.
14439 .wen
14440
14441 .option daemon_smtp_ports main string &`smtp`&
14442 .cindex "port" "for daemon"
14443 .cindex "TCP/IP" "setting listening ports"
14444 This option specifies one or more default SMTP ports on which the Exim daemon
14445 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14446 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14447
14448 .option daemon_startup_retries main integer 9
14449 .cindex "daemon startup, retrying"
14450 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14451 the daemon at startup when it cannot immediately bind a listening socket
14452 (typically because the socket is already in use): &%daemon_startup_retries%&
14453 defines the number of retries after the first failure, and
14454 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14455
14456 .option daemon_startup_sleep main time 30s
14457 See &%daemon_startup_retries%&.
14458
14459 .option delay_warning main "time list" 24h
14460 .cindex "warning of delay"
14461 .cindex "delay warning, specifying"
14462 .cindex "queue" "delay warning"
14463 When a message is delayed, Exim sends a warning message to the sender at
14464 intervals specified by this option. The data is a colon-separated list of times
14465 after which to send warning messages. If the value of the option is an empty
14466 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14467 message has been on the queue for longer than the last time, the last interval
14468 between the times is used to compute subsequent warning times. For example,
14469 with
14470 .code
14471 delay_warning = 4h:8h:24h
14472 .endd
14473 the first message is sent after 4 hours, the second after 8 hours, and
14474 the third one after 24 hours. After that, messages are sent every 16 hours,
14475 because that is the interval between the last two times on the list. If you set
14476 just one time, it specifies the repeat interval. For example, with:
14477 .code
14478 delay_warning = 6h
14479 .endd
14480 messages are repeated every six hours. To stop warnings after a given time, set
14481 a very large time at the end of the list. For example:
14482 .code
14483 delay_warning = 2h:12h:99d
14484 .endd
14485 Note that the option is only evaluated at the time a delivery attempt fails,
14486 which depends on retry and queue-runner configuration.
14487 Typically retries will be configured more frequently than warning messages.
14488
14489 .option delay_warning_condition main string&!! "see below"
14490 .vindex "&$domain$&"
14491 The string is expanded at the time a warning message might be sent. If all the
14492 deferred addresses have the same domain, it is set in &$domain$& during the
14493 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14494 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14495 &"false"& (the comparison being done caselessly) then the warning message is
14496 not sent. The default is:
14497 .code
14498 delay_warning_condition = ${if or {\
14499   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14500   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14501   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14502   } {no}{yes}}
14503 .endd
14504 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14505 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14506 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14507 &"auto-replied"& in an &'Auto-Submitted:'& header.
14508
14509 .option deliver_drop_privilege main boolean false
14510 .cindex "unprivileged delivery"
14511 .cindex "delivery" "unprivileged"
14512 If this option is set true, Exim drops its root privilege at the start of a
14513 delivery process, and runs as the Exim user throughout. This severely restricts
14514 the kinds of local delivery that are possible, but is viable in certain types
14515 of configuration. There is a discussion about the use of root privilege in
14516 chapter &<<CHAPsecurity>>&.
14517
14518 .option deliver_queue_load_max main fixed-point unset
14519 .cindex "load average"
14520 .cindex "queue runner" "abandoning"
14521 When this option is set, a queue run is abandoned if the system load average
14522 becomes greater than the value of the option. The option has no effect on
14523 ancient operating systems on which Exim cannot determine the load average.
14524 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14525
14526
14527 .option delivery_date_remove main boolean true
14528 .cindex "&'Delivery-date:'& header line"
14529 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14530 message when it is delivered, in exactly the same way as &'Return-path:'& is
14531 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14532 should not be present in incoming messages, and this option causes them to be
14533 removed at the time the message is received, to avoid any problems that might
14534 occur when a delivered message is subsequently sent on to some other recipient.
14535
14536 .option disable_fsync main boolean false
14537 .cindex "&[fsync()]&, disabling"
14538 This option is available only if Exim was built with the compile-time option
14539 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14540 a runtime configuration generates an &"unknown option"& error. You should not
14541 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14542 really, really, really understand what you are doing. &'No pre-compiled
14543 distributions of Exim should ever make this option available.'&
14544
14545 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14546 updated files' data to be written to disc before continuing. Unexpected events
14547 such as crashes and power outages may cause data to be lost or scrambled.
14548 Here be Dragons. &*Beware.*&
14549
14550
14551 .option disable_ipv6 main boolean false
14552 .cindex "IPv6" "disabling"
14553 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14554 activities take place. AAAA records are never looked up, and any IPv6 addresses
14555 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14556 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14557 to handle IPv6 literal addresses.
14558
14559
14560 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14561 .cindex DKIM "controlling calls to the ACL"
14562 This option gives a list of DKIM domains for which the DKIM ACL is run.
14563 It is expanded after the message is received; by default it runs
14564 the ACL once for each signature in the message.
14565 See chapter &<<CHAPdkim>>&.
14566
14567
14568 .option dns_again_means_nonexist main "domain list&!!" unset
14569 .cindex "DNS" "&""try again""& response; overriding"
14570 DNS lookups give a &"try again"& response for the DNS errors
14571 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14572 keep trying to deliver a message, or to give repeated temporary errors to
14573 incoming mail. Sometimes the effect is caused by a badly set up name server and
14574 may persist for a long time. If a domain which exhibits this problem matches
14575 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14576 This option should be used with care. You can make it apply to reverse lookups
14577 by a setting such as this:
14578 .code
14579 dns_again_means_nonexist = *.in-addr.arpa
14580 .endd
14581 This option applies to all DNS lookups that Exim does. It also applies when the
14582 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14583 since these are most likely to be caused by DNS lookup problems. The
14584 &(dnslookup)& router has some options of its own for controlling what happens
14585 when lookups for MX or SRV records give temporary errors. These more specific
14586 options are applied after this global option.
14587
14588 .option dns_check_names_pattern main string "see below"
14589 .cindex "DNS" "pre-check of name syntax"
14590 When this option is set to a non-empty string, it causes Exim to check domain
14591 names for characters that are not allowed in host names before handing them to
14592 the DNS resolver, because some resolvers give temporary errors for names that
14593 contain unusual characters. If a domain name contains any unwanted characters,
14594 a &"not found"& result is forced, and the resolver is not called. The check is
14595 done by matching the domain name against a regular expression, which is the
14596 value of this option. The default pattern is
14597 .code
14598 dns_check_names_pattern = \
14599   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14600 .endd
14601 which permits only letters, digits, slashes, and hyphens in components, but
14602 they must start and end with a letter or digit. Slashes are not, in fact,
14603 permitted in host names, but they are found in certain NS records (which can be
14604 accessed in Exim by using a &%dnsdb%& lookup). If you set
14605 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14606 empty string.
14607
14608 .option dns_csa_search_limit main integer 5
14609 This option controls the depth of parental searching for CSA SRV records in the
14610 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14611
14612 .option dns_csa_use_reverse main boolean true
14613 This option controls whether or not an IP address, given as a CSA domain, is
14614 reversed and looked up in the reverse DNS, as described in more detail in
14615 section &<<SECTverifyCSA>>&.
14616
14617
14618 .option dns_dnssec_ok main integer -1
14619 .cindex "DNS" "resolver options"
14620 .cindex "DNS" "DNSSEC"
14621 If this option is set to a non-negative number then Exim will initialise the
14622 DNS resolver library to either use or not use DNSSEC, overriding the system
14623 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14624
14625 If the resolver library does not support DNSSEC then this option has no effect.
14626
14627
14628 .option dns_ipv4_lookup main "domain list&!!" unset
14629 .cindex "IPv6" "DNS lookup for AAAA records"
14630 .cindex "DNS" "IPv6 lookup for AAAA records"
14631 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14632 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14633 (A records) when trying to find IP addresses for hosts, unless the host's
14634 domain matches this list.
14635
14636 This is a fudge to help with name servers that give big delays or otherwise do
14637 not work for the AAAA record type. In due course, when the world's name
14638 servers have all been upgraded, there should be no need for this option.
14639
14640
14641 .option dns_retrans main time 0s
14642 .cindex "DNS" "resolver options"
14643 .cindex timeout "dns lookup"
14644 .cindex "DNS" timeout
14645 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14646 retransmission and retry parameters for DNS lookups. Values of zero (the
14647 defaults) leave the system default settings unchanged. The first value is the
14648 time between retries, and the second is the number of retries. It isn't
14649 totally clear exactly how these settings affect the total time a DNS lookup may
14650 take. I haven't found any documentation about timeouts on DNS lookups; these
14651 parameter values are available in the external resolver interface structure,
14652 but nowhere does it seem to describe how they are used or what you might want
14653 to set in them.
14654 See also the &%slow_lookup_log%& option.
14655
14656
14657 .option dns_retry main integer 0
14658 See &%dns_retrans%& above.
14659
14660
14661 .option dns_trust_aa main "domain list&!!" unset
14662 .cindex "DNS" "resolver options"
14663 .cindex "DNS" "DNSSEC"
14664 If this option is set then lookup results marked with the AA bit
14665 (Authoritative Answer) are trusted the same way as if they were
14666 DNSSEC-verified. The authority section's name of the answer must
14667 match with this expanded domain list.
14668
14669 Use this option only if you talk directly to a resolver that is
14670 authoritative for some zones and does not set the AD (Authentic Data)
14671 bit in the answer. Some DNS servers may have an configuration option to
14672 mark the answers from their own zones as verified (they set the AD bit).
14673 Others do not have this option. It is considered as poor practice using
14674 a resolver that is an authoritative server for some zones.
14675
14676 Use this option only if you really have to (e.g. if you want
14677 to use DANE for remote delivery to a server that is listed in the DNS
14678 zones that your resolver is authoritative for).
14679
14680 If the DNS answer packet has the AA bit set and contains resource record
14681 in the answer section, the name of the first NS record appearing in the
14682 authority section is compared against the list. If the answer packet is
14683 authoritative but the answer section is empty, the name of the first SOA
14684 record in the authoritative section is used instead.
14685
14686 .cindex "DNS" "resolver options"
14687 .option dns_use_edns0 main integer -1
14688 .cindex "DNS" "resolver options"
14689 .cindex "DNS" "EDNS0"
14690 If this option is set to a non-negative number then Exim will initialise the
14691 DNS resolver library to either use or not use EDNS0 extensions, overriding
14692 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14693 on.
14694
14695 If the resolver library does not support EDNS0 then this option has no effect.
14696
14697
14698 .option drop_cr main boolean false
14699 This is an obsolete option that is now a no-op. It used to affect the way Exim
14700 handled CR and LF characters in incoming messages. What happens now is
14701 described in section &<<SECTlineendings>>&.
14702
14703 .option dsn_advertise_hosts main "host list&!!" unset
14704 .cindex "bounce messages" "success"
14705 .cindex "DSN" "success"
14706 .cindex "Delivery Status Notification" "success"
14707 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14708 and accepted from, these hosts.
14709 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14710 and RET and ORCPT options on MAIL FROM commands.
14711 A NOTIFY=SUCCESS option requests success-DSN messages.
14712 A NOTIFY= option with no argument requests that no delay or failure DSNs
14713 are sent.
14714
14715 .option dsn_from main "string&!!" "see below"
14716 .cindex "&'From:'& header line" "in bounces"
14717 .cindex "bounce messages" "&'From:'& line, specifying"
14718 This option can be used to vary the contents of &'From:'& header lines in
14719 bounces and other automatically generated messages (&"Delivery Status
14720 Notifications"& &-- hence the name of the option). The default setting is:
14721 .code
14722 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14723 .endd
14724 The value is expanded every time it is needed. If the expansion fails, a
14725 panic is logged, and the default value is used.
14726
14727 .option envelope_to_remove main boolean true
14728 .cindex "&'Envelope-to:'& header line"
14729 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14730 message when it is delivered, in exactly the same way as &'Return-path:'& is
14731 handled. &'Envelope-to:'& records the original recipient address from the
14732 message's envelope that caused the delivery to happen. Such headers should not
14733 be present in incoming messages, and this option causes them to be removed at
14734 the time the message is received, to avoid any problems that might occur when a
14735 delivered message is subsequently sent on to some other recipient.
14736
14737
14738 .option errors_copy main "string list&!!" unset
14739 .cindex "bounce message" "copy to other address"
14740 .cindex "copy of bounce message"
14741 Setting this option causes Exim to send bcc copies of bounce messages that it
14742 generates to other addresses. &*Note*&: This does not apply to bounce messages
14743 coming from elsewhere. The value of the option is a colon-separated list of
14744 items. Each item consists of a pattern, terminated by white space, followed by
14745 a comma-separated list of email addresses. If a pattern contains spaces, it
14746 must be enclosed in double quotes.
14747
14748 Each pattern is processed in the same way as a single item in an address list
14749 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14750 the bounce message, the message is copied to the addresses on the list. The
14751 items are scanned in order, and once a matching one is found, no further items
14752 are examined. For example:
14753 .code
14754 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14755               rqps@mydomain   hostmaster@mydomain.example,\
14756                               postmaster@mydomain.example
14757 .endd
14758 .vindex "&$domain$&"
14759 .vindex "&$local_part$&"
14760 The address list is expanded before use. The expansion variables &$local_part$&
14761 and &$domain$& are set from the original recipient of the error message, and if
14762 there was any wildcard matching in the pattern, the expansion
14763 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14764 variables &$0$&, &$1$&, etc. are set in the normal way.
14765
14766
14767 .option errors_reply_to main string unset
14768 .cindex "bounce message" "&'Reply-to:'& in"
14769 By default, Exim's bounce and delivery warning messages contain the header line
14770 .display
14771 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14772 .endd
14773 .oindex &%quota_warn_message%&
14774 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14775 A warning message that is generated by the &%quota_warn_message%& option in an
14776 &(appendfile)& transport may contain its own &'From:'& header line that
14777 overrides the default.
14778
14779 Experience shows that people reply to bounce messages. If the
14780 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14781 and warning messages. For example:
14782 .code
14783 errors_reply_to = postmaster@my.domain.example
14784 .endd
14785 The value of the option is not expanded. It must specify a valid RFC 2822
14786 address. However, if a warning message that is generated by the
14787 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14788 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14789 not used.
14790
14791
14792 .option event_action main string&!! unset
14793 .cindex events
14794 This option declares a string to be expanded for Exim's events mechanism.
14795 For details see &<<CHAPevents>>&.
14796
14797
14798 .option exim_group main string "compile-time configured"
14799 .cindex "gid (group id)" "Exim's own"
14800 .cindex "Exim group"
14801 This option changes the gid under which Exim runs when it gives up root
14802 privilege. The default value is compiled into the binary. The value of this
14803 option is used only when &%exim_user%& is also set. Unless it consists entirely
14804 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14805 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14806 security issues.
14807
14808
14809 .option exim_path main string "see below"
14810 .cindex "Exim binary, path name"
14811 This option specifies the path name of the Exim binary, which is used when Exim
14812 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14813 the directory configured at compile time by the BIN_DIRECTORY setting. It
14814 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14815 other place.
14816 &*Warning*&: Do not use a macro to define the value of this option, because
14817 you will break those Exim utilities that scan the configuration file to find
14818 where the binary is. (They then use the &%-bP%& option to extract option
14819 settings such as the value of &%spool_directory%&.)
14820
14821
14822 .option exim_user main string "compile-time configured"
14823 .cindex "uid (user id)" "Exim's own"
14824 .cindex "Exim user"
14825 This option changes the uid under which Exim runs when it gives up root
14826 privilege. The default value is compiled into the binary. Ownership of the run
14827 time configuration file and the use of the &%-C%& and &%-D%& command line
14828 options is checked against the values in the binary, not what is set here.
14829
14830 Unless it consists entirely of digits, the string is looked up using
14831 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14832 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14833 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14834
14835
14836 .option extra_local_interfaces main "string list" unset
14837 This option defines network interfaces that are to be considered local when
14838 routing, but which are not used for listening by the daemon. See section
14839 &<<SECTreclocipadd>>& for details.
14840
14841
14842 . Allow this long option name to split; give it unsplit as a fifth argument
14843 . for the automatic .oindex that is generated by .option.
14844
14845 .option "extract_addresses_remove_arguments" main boolean true &&&
14846          extract_addresses_remove_arguments
14847 .oindex "&%-t%&"
14848 .cindex "command line" "addresses with &%-t%&"
14849 .cindex "Sendmail compatibility" "&%-t%& option"
14850 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14851 are present on the command line when the &%-t%& option is used to build an
14852 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14853 line addresses are removed from the recipients list. This is also how Smail
14854 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14855 command line addresses are added to those obtained from the header lines. When
14856 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14857 argument headers. If it is set false, Exim adds rather than removes argument
14858 addresses.
14859
14860
14861 .option finduser_retries main integer 0
14862 .cindex "NIS, retrying user lookups"
14863 On systems running NIS or other schemes in which user and group information is
14864 distributed from a remote system, there can be times when &[getpwnam()]& and
14865 related functions fail, even when given valid data, because things time out.
14866 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14867 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14868 many extra times to find a user or a group, waiting for one second between
14869 retries.
14870
14871 .cindex "&_/etc/passwd_&" "multiple reading of"
14872 You should not set this option greater than zero if your user information is in
14873 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14874 search the file multiple times for non-existent users, and also cause delay.
14875
14876
14877
14878 .option freeze_tell main "string list, comma separated" unset
14879 .cindex "freezing messages" "sending a message when freezing"
14880 On encountering certain errors, or when configured to do so in a system filter,
14881 ACL, or special router, Exim freezes a message. This means that no further
14882 delivery attempts take place until an administrator thaws the message, or the
14883 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14884 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14885 warning message whenever it freezes something, unless the message it is
14886 freezing is a locally-generated bounce message. (Without this exception there
14887 is the possibility of looping.) The warning message is sent to the addresses
14888 supplied as the comma-separated value of this option. If several of the
14889 message's addresses cause freezing, only a single message is sent. If the
14890 freezing was automatic, the reason(s) for freezing can be found in the message
14891 log. If you configure freezing in a filter or ACL, you must arrange for any
14892 logging that you require.
14893
14894
14895 .option gecos_name main string&!! unset
14896 .cindex "HP-UX"
14897 .cindex "&""gecos""& field, parsing"
14898 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14899 password file to hold other information in addition to users' real names. Exim
14900 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14901 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14902 of the field are used unchanged, except that, if an ampersand is encountered,
14903 it is replaced by the user's login name with the first character forced to
14904 upper case, since this is a convention that is observed on many systems.
14905
14906 When these options are set, &%gecos_pattern%& is treated as a regular
14907 expression that is to be applied to the field (again with && replaced by the
14908 login name), and if it matches, &%gecos_name%& is expanded and used as the
14909 user's name.
14910
14911 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14912 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14913 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14914 name terminates at the first comma, the following can be used:
14915 .code
14916 gecos_pattern = ([^,]*)
14917 gecos_name = $1
14918 .endd
14919
14920 .option gecos_pattern main string unset
14921 See &%gecos_name%& above.
14922
14923
14924 .option gnutls_compat_mode main boolean unset
14925 This option controls whether GnuTLS is used in compatibility mode in an Exim
14926 server. This reduces security slightly, but improves interworking with older
14927 implementations of TLS.
14928
14929
14930 option gnutls_allow_auto_pkcs11 main boolean unset
14931 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14932 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14933
14934 See
14935 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14936 for documentation.
14937
14938
14939
14940 .option headers_charset main string "see below"
14941 This option sets a default character set for translating from encoded MIME
14942 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14943 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14944 ultimate default is ISO-8859-1. For more details see the description of header
14945 insertions in section &<<SECTexpansionitems>>&.
14946
14947
14948
14949 .option header_maxsize main integer "see below"
14950 .cindex "header section" "maximum size of"
14951 .cindex "limit" "size of message header section"
14952 This option controls the overall maximum size of a message's header
14953 section. The default is the value of HEADER_MAXSIZE in
14954 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14955 sections are rejected.
14956
14957
14958 .option header_line_maxsize main integer 0
14959 .cindex "header lines" "maximum size of"
14960 .cindex "limit" "size of one header line"
14961 This option limits the length of any individual header line in a message, after
14962 all the continuations have been joined together. Messages with individual
14963 header lines that are longer than the limit are rejected. The default value of
14964 zero means &"no limit"&.
14965
14966
14967
14968
14969 .option helo_accept_junk_hosts main "host list&!!" unset
14970 .cindex "HELO" "accepting junk data"
14971 .cindex "EHLO" "accepting junk data"
14972 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14973 mail, and gives an error response for invalid data. Unfortunately, there are
14974 some SMTP clients that send syntactic junk. They can be accommodated by setting
14975 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14976 if you want to do semantic checking.
14977 See also &%helo_allow_chars%& for a way of extending the permitted character
14978 set.
14979
14980
14981 .option helo_allow_chars main string unset
14982 .cindex "HELO" "underscores in"
14983 .cindex "EHLO" "underscores in"
14984 .cindex "underscore in EHLO/HELO"
14985 This option can be set to a string of rogue characters that are permitted in
14986 all EHLO and HELO names in addition to the standard letters, digits,
14987 hyphens, and dots. If you really must allow underscores, you can set
14988 .code
14989 helo_allow_chars = _
14990 .endd
14991 Note that the value is one string, not a list.
14992
14993
14994 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14995 .cindex "HELO" "forcing reverse lookup"
14996 .cindex "EHLO" "forcing reverse lookup"
14997 If the domain given by a client in a HELO or EHLO command matches this
14998 list, a reverse lookup is done in order to establish the host's true name. The
14999 default forces a lookup if the client host gives the server's name or any of
15000 its IP addresses (in brackets), something that broken clients have been seen to
15001 do.
15002
15003
15004 .option helo_try_verify_hosts main "host list&!!" unset
15005 .cindex "HELO verifying" "optional"
15006 .cindex "EHLO" "verifying, optional"
15007 By default, Exim just checks the syntax of HELO and EHLO commands (see
15008 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15009 to do more extensive checking of the data supplied by these commands. The ACL
15010 condition &`verify = helo`& is provided to make this possible.
15011 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15012 to force the check to occur. From release 4.53 onwards, this is no longer
15013 necessary. If the check has not been done before &`verify = helo`& is
15014 encountered, it is done at that time. Consequently, this option is obsolete.
15015 Its specification is retained here for backwards compatibility.
15016
15017 When an EHLO or HELO command is received, if the calling host matches
15018 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15019 EHLO command either:
15020
15021 .ilist
15022 is an IP literal matching the calling address of the host, or
15023 .next
15024 .cindex "DNS" "reverse lookup"
15025 .cindex "reverse DNS lookup"
15026 matches the host name that Exim obtains by doing a reverse lookup of the
15027 calling host address, or
15028 .next
15029 when looked up in DNS yields the calling host address.
15030 .endlist
15031
15032 However, the EHLO or HELO command is not rejected if any of the checks
15033 fail. Processing continues, but the result of the check is remembered, and can
15034 be detected later in an ACL by the &`verify = helo`& condition.
15035
15036 If DNS was used for successful verification, the variable
15037 .cindex "DNS" "DNSSEC"
15038 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15039
15040 .option helo_verify_hosts main "host list&!!" unset
15041 .cindex "HELO verifying" "mandatory"
15042 .cindex "EHLO" "verifying, mandatory"
15043 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15044 backwards compatibility. For hosts that match this option, Exim checks the host
15045 name given in the HELO or EHLO in the same way as for
15046 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15047 rejected with a 550 error, and entries are written to the main and reject logs.
15048 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15049 error.
15050
15051 .option hold_domains main "domain list&!!" unset
15052 .cindex "domain" "delaying delivery"
15053 .cindex "delivery" "delaying certain domains"
15054 This option allows mail for particular domains to be held on the queue
15055 manually. The option is overridden if a message delivery is forced with the
15056 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15057 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15058 item in &%hold_domains%&, no routing or delivery for that address is done, and
15059 it is deferred every time the message is looked at.
15060
15061 This option is intended as a temporary operational measure for delaying the
15062 delivery of mail while some problem is being sorted out, or some new
15063 configuration tested. If you just want to delay the processing of some
15064 domains until a queue run occurs, you should use &%queue_domains%& or
15065 &%queue_smtp_domains%&, not &%hold_domains%&.
15066
15067 A setting of &%hold_domains%& does not override Exim's code for removing
15068 messages from the queue if they have been there longer than the longest retry
15069 time in any retry rule. If you want to hold messages for longer than the normal
15070 retry times, insert a dummy retry rule with a long retry time.
15071
15072
15073 .option host_lookup main "host list&!!" unset
15074 .cindex "host name" "lookup, forcing"
15075 Exim does not look up the name of a calling host from its IP address unless it
15076 is required to compare against some host list, or the host matches
15077 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15078 option (which normally contains IP addresses rather than host names). The
15079 default configuration file contains
15080 .code
15081 host_lookup = *
15082 .endd
15083 which causes a lookup to happen for all hosts. If the expense of these lookups
15084 is felt to be too great, the setting can be changed or removed.
15085
15086 After a successful reverse lookup, Exim does a forward lookup on the name it
15087 has obtained, to verify that it yields the IP address that it started with. If
15088 this check fails, Exim behaves as if the name lookup failed.
15089
15090 .vindex "&$host_lookup_failed$&"
15091 .vindex "&$sender_host_name$&"
15092 After any kind of failure, the host name (in &$sender_host_name$&) remains
15093 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15094 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15095 &`verify = reverse_host_lookup`& in ACLs.
15096
15097
15098 .option host_lookup_order main "string list" &`bydns:byaddr`&
15099 This option specifies the order of different lookup methods when Exim is trying
15100 to find a host name from an IP address. The default is to do a DNS lookup
15101 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15102 if that fails. You can change the order of these lookups, or omit one entirely,
15103 if you want.
15104
15105 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15106 multiple PTR records in the DNS and the IP address is not listed in
15107 &_/etc/hosts_&. Different operating systems give different results in this
15108 case. That is why the default tries a DNS lookup first.
15109
15110
15111
15112 .option host_reject_connection main "host list&!!" unset
15113 .cindex "host" "rejecting connections from"
15114 If this option is set, incoming SMTP calls from the hosts listed are rejected
15115 as soon as the connection is made.
15116 This option is obsolete, and retained only for backward compatibility, because
15117 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15118 connections immediately.
15119
15120 The ability to give an immediate rejection (either by this option or using an
15121 ACL) is provided for use in unusual cases. Many hosts will just try again,
15122 sometimes without much delay. Normally, it is better to use an ACL to reject
15123 incoming messages at a later stage, such as after RCPT commands. See
15124 chapter &<<CHAPACL>>&.
15125
15126
15127 .option hosts_connection_nolog main "host list&!!" unset
15128 .cindex "host" "not logging connections from"
15129 This option defines a list of hosts for which connection logging does not
15130 happen, even though the &%smtp_connection%& log selector is set. For example,
15131 you might want not to log SMTP connections from local processes, or from
15132 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15133 the daemon; you should therefore strive to restrict its value to a short inline
15134 list of IP addresses and networks. To disable logging SMTP connections from
15135 local processes, you must create a host list with an empty item. For example:
15136 .code
15137 hosts_connection_nolog = :
15138 .endd
15139 If the &%smtp_connection%& log selector is not set, this option has no effect.
15140
15141
15142
15143 .option hosts_proxy main "host list&!!" unset
15144 .cindex proxy "proxy protocol"
15145 This option enables use of Proxy Protocol proxies for incoming
15146 connections.  For details see &<<SECTproxyInbound>>&.
15147
15148
15149 .option hosts_treat_as_local main "domain list&!!" unset
15150 .cindex "local host" "domains treated as"
15151 .cindex "host" "treated as local"
15152 If this option is set, any host names that match the domain list are treated as
15153 if they were the local host when Exim is scanning host lists obtained from MX
15154 records
15155 or other sources. Note that the value of this option is a domain list, not a
15156 host list, because it is always used to check host names, not IP addresses.
15157
15158 This option also applies when Exim is matching the special items
15159 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15160 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15161 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15162 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15163 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15164 interfaces and recognizing the local host.
15165
15166
15167 .option ibase_servers main "string list" unset
15168 .cindex "InterBase" "server list"
15169 This option provides a list of InterBase servers and associated connection data,
15170 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15171 The option is available only if Exim has been built with InterBase support.
15172
15173
15174
15175 .option ignore_bounce_errors_after main time 10w
15176 .cindex "bounce message" "discarding"
15177 .cindex "discarding bounce message"
15178 This option affects the processing of bounce messages that cannot be delivered,
15179 that is, those that suffer a permanent delivery failure. (Bounce messages that
15180 suffer temporary delivery failures are of course retried in the usual way.)
15181
15182 After a permanent delivery failure, bounce messages are frozen,
15183 because there is no sender to whom they can be returned. When a frozen bounce
15184 message has been on the queue for more than the given time, it is unfrozen at
15185 the next queue run, and a further delivery is attempted. If delivery fails
15186 again, the bounce message is discarded. This makes it possible to keep failed
15187 bounce messages around for a shorter time than the normal maximum retry time
15188 for frozen messages. For example,
15189 .code
15190 ignore_bounce_errors_after = 12h
15191 .endd
15192 retries failed bounce message deliveries after 12 hours, discarding any further
15193 failures. If the value of this option is set to a zero time period, bounce
15194 failures are discarded immediately. Setting a very long time (as in the default
15195 value) has the effect of disabling this option. For ways of automatically
15196 dealing with other kinds of frozen message, see &%auto_thaw%& and
15197 &%timeout_frozen_after%&.
15198
15199
15200 .option ignore_fromline_hosts main "host list&!!" unset
15201 .cindex "&""From""& line"
15202 .cindex "UUCP" "&""From""& line"
15203 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15204 the headers of a message. By default this is treated as the start of the
15205 message's body, which means that any following headers are not recognized as
15206 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15207 match those hosts that insist on sending it. If the sender is actually a local
15208 process rather than a remote host, and is using &%-bs%& to inject the messages,
15209 &%ignore_fromline_local%& must be set to achieve this effect.
15210
15211
15212 .option ignore_fromline_local main boolean false
15213 See &%ignore_fromline_hosts%& above.
15214
15215 .option keep_environment main "string list" unset
15216 .cindex "environment" "values from"
15217 This option contains a string list of environment variables to keep.
15218 You have to trust these variables or you have to be sure that
15219 these variables do not impose any security risk. Keep in mind that
15220 during the startup phase Exim is running with an effective UID 0 in most
15221 installations. As the default value is an empty list, the default
15222 environment for using libraries, running embedded Perl code, or running
15223 external binaries is empty, and does not not even contain PATH or HOME.
15224
15225 Actually the list is interpreted as a list of patterns
15226 (&<<SECTlistexpand>>&), except that it is not expanded first.
15227
15228 WARNING: Macro substitution is still done first, so having a macro
15229 FOO and having FOO_HOME in your &%keep_environment%& option may have
15230 unexpected results. You may work around this using a regular expression
15231 that does not match the macro name: ^[F]OO_HOME$.
15232
15233 Current versions of Exim issue a warning during startup if you do not mention
15234 &%keep_environment%& in your runtime configuration file and if your
15235 current environment is not empty. Future versions may not issue that warning
15236 anymore.
15237
15238 See the &%add_environment%& main config option for a way to set
15239 environment variables to a fixed value.  The environment for &(pipe)&
15240 transports is handled separately, see section &<<SECTpipeenv>>& for
15241 details.
15242
15243
15244 .option keep_malformed main time 4d
15245 This option specifies the length of time to keep messages whose spool files
15246 have been corrupted in some way. This should, of course, never happen. At the
15247 next attempt to deliver such a message, it gets removed. The incident is
15248 logged.
15249
15250
15251 .option ldap_ca_cert_dir main string unset
15252 .cindex "LDAP", "TLS CA certificate directory"
15253 .cindex certificate "directory for LDAP"
15254 This option indicates which directory contains CA certificates for verifying
15255 a TLS certificate presented by an LDAP server.
15256 While Exim does not provide a default value, your SSL library may.
15257 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15258 and constrained to be a directory.
15259
15260
15261 .option ldap_ca_cert_file main string unset
15262 .cindex "LDAP", "TLS CA certificate file"
15263 .cindex certificate "file for LDAP"
15264 This option indicates which file contains CA certificates for verifying
15265 a TLS certificate presented by an LDAP server.
15266 While Exim does not provide a default value, your SSL library may.
15267 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15268 and constrained to be a file.
15269
15270
15271 .option ldap_cert_file main string unset
15272 .cindex "LDAP" "TLS client certificate file"
15273 .cindex certificate "file for LDAP"
15274 This option indicates which file contains an TLS client certificate which
15275 Exim should present to the LDAP server during TLS negotiation.
15276 Should be used together with &%ldap_cert_key%&.
15277
15278
15279 .option ldap_cert_key main string unset
15280 .cindex "LDAP" "TLS client key file"
15281 .cindex certificate "key for LDAP"
15282 This option indicates which file contains the secret/private key to use
15283 to prove identity to the LDAP server during TLS negotiation.
15284 Should be used together with &%ldap_cert_file%&, which contains the
15285 identity to be proven.
15286
15287
15288 .option ldap_cipher_suite main string unset
15289 .cindex "LDAP" "TLS cipher suite"
15290 This controls the TLS cipher-suite negotiation during TLS negotiation with
15291 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15292 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15293
15294
15295 .option ldap_default_servers main "string list" unset
15296 .cindex "LDAP" "default servers"
15297 This option provides a list of LDAP servers which are tried in turn when an
15298 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15299 details of LDAP queries. This option is available only when Exim has been built
15300 with LDAP support.
15301
15302
15303 .option ldap_require_cert main string unset.
15304 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15305 This should be one of the values "hard", "demand", "allow", "try" or "never".
15306 A value other than one of these is interpreted as "never".
15307 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15308 Although Exim does not set a default, the LDAP library probably defaults
15309 to hard/demand.
15310
15311
15312 .option ldap_start_tls main boolean false
15313 .cindex "LDAP" "whether or not to negotiate TLS"
15314 If set, Exim will attempt to negotiate TLS with the LDAP server when
15315 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15316 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15317 of SSL-on-connect.
15318 In the event of failure to negotiate TLS, the action taken is controlled
15319 by &%ldap_require_cert%&.
15320
15321
15322 .option ldap_version main integer unset
15323 .cindex "LDAP" "protocol version, forcing"
15324 This option can be used to force Exim to set a specific protocol version for
15325 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15326 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15327 the LDAP headers; otherwise it is 2. This option is available only when Exim
15328 has been built with LDAP support.
15329
15330
15331
15332 .option local_from_check main boolean true
15333 .cindex "&'Sender:'& header line" "disabling addition of"
15334 .cindex "&'From:'& header line" "disabling checking of"
15335 When a message is submitted locally (that is, not over a TCP/IP connection) by
15336 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15337 checks that the &'From:'& header line matches the login of the calling user and
15338 the domain specified by &%qualify_domain%&.
15339
15340 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15341 locally submitted message is automatically qualified by Exim, unless the
15342 &%-bnq%& command line option is used.
15343
15344 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15345 on the local part. If the &'From:'& header line does not match, Exim adds a
15346 &'Sender:'& header with an address constructed from the calling user's login
15347 and the default qualify domain.
15348
15349 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15350 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15351 &'Sender:'& header lines supplied by untrusted users, you must also set
15352 &%local_sender_retain%& to be true.
15353
15354 .cindex "envelope sender"
15355 These options affect only the header lines in the message. The envelope sender
15356 is still forced to be the login id at the qualify domain unless
15357 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15358
15359 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15360 request similar header line checking. See section &<<SECTthesenhea>>&, which
15361 has more details about &'Sender:'& processing.
15362
15363
15364
15365
15366 .option local_from_prefix main string unset
15367 When Exim checks the &'From:'& header line of locally submitted messages for
15368 matching the login id (see &%local_from_check%& above), it can be configured to
15369 ignore certain prefixes and suffixes in the local part of the address. This is
15370 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15371 appropriate lists, in the same form as the &%local_part_prefix%& and
15372 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15373 example, if
15374 .code
15375 local_from_prefix = *-
15376 .endd
15377 is set, a &'From:'& line containing
15378 .code
15379 From: anything-user@your.domain.example
15380 .endd
15381 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15382 matches the actual sender address that is constructed from the login name and
15383 qualify domain.
15384
15385
15386 .option local_from_suffix main string unset
15387 See &%local_from_prefix%& above.
15388
15389
15390 .option local_interfaces main "string list" "see below"
15391 This option controls which network interfaces are used by the daemon for
15392 listening; they are also used to identify the local host when routing. Chapter
15393 &<<CHAPinterfaces>>& contains a full description of this option and the related
15394 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15395 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15396 &%local_interfaces%& is
15397 .code
15398 local_interfaces = 0.0.0.0
15399 .endd
15400 when Exim is built without IPv6 support; otherwise it is
15401 .code
15402 local_interfaces = <; ::0 ; 0.0.0.0
15403 .endd
15404
15405 .option local_scan_timeout main time 5m
15406 .cindex "timeout" "for &[local_scan()]& function"
15407 .cindex "&[local_scan()]& function" "timeout"
15408 This timeout applies to the &[local_scan()]& function (see chapter
15409 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15410 the incoming message is rejected with a temporary error if it is an SMTP
15411 message. For a non-SMTP message, the message is dropped and Exim ends with a
15412 non-zero code. The incident is logged on the main and reject logs.
15413
15414
15415
15416 .option local_sender_retain main boolean false
15417 .cindex "&'Sender:'& header line" "retaining from local submission"
15418 When a message is submitted locally (that is, not over a TCP/IP connection) by
15419 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15420 do not want this to happen, you must set &%local_sender_retain%&, and you must
15421 also set &%local_from_check%& to be false (Exim will complain if you do not).
15422 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15423 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15424
15425
15426
15427
15428 .option localhost_number main string&!! unset
15429 .cindex "host" "locally unique number for"
15430 .cindex "message ids" "with multiple hosts"
15431 .vindex "&$localhost_number$&"
15432 Exim's message ids are normally unique only within the local host. If
15433 uniqueness among a set of hosts is required, each host must set a different
15434 value for the &%localhost_number%& option. The string is expanded immediately
15435 after reading the configuration file (so that a number can be computed from the
15436 host name, for example) and the result of the expansion must be a number in the
15437 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15438 systems). This is available in subsequent string expansions via the variable
15439 &$localhost_number$&. When &%localhost_number is set%&, the final two
15440 characters of the message id, instead of just being a fractional part of the
15441 time, are computed from the time and the local host number as described in
15442 section &<<SECTmessiden>>&.
15443
15444
15445
15446 .option log_file_path main "string list&!!" "set at compile time"
15447 .cindex "log" "file path for"
15448 This option sets the path which is used to determine the names of Exim's log
15449 files, or indicates that logging is to be to syslog, or both. It is expanded
15450 when Exim is entered, so it can, for example, contain a reference to the host
15451 name. If no specific path is set for the log files at compile or run time,
15452 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15453 they are written in a sub-directory called &_log_& in Exim's spool directory.
15454 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15455 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15456 used. If this string is fixed at your installation (contains no expansion
15457 variables) it is recommended that you do not set this option in the
15458 configuration file, but instead supply the path using LOG_FILE_PATH in
15459 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15460 early on &-- in particular, failure to read the configuration file.
15461
15462
15463 .option log_selector main string unset
15464 .cindex "log" "selectors"
15465 This option can be used to reduce or increase the number of things that Exim
15466 writes to its log files. Its argument is made up of names preceded by plus or
15467 minus characters. For example:
15468 .code
15469 log_selector = +arguments -retry_defer
15470 .endd
15471 A list of possible names and what they control is given in the chapter on
15472 logging, in section &<<SECTlogselector>>&.
15473
15474
15475 .option log_timezone main boolean false
15476 .cindex "log" "timezone for entries"
15477 .vindex "&$tod_log$&"
15478 .vindex "&$tod_zone$&"
15479 By default, the timestamps on log lines are in local time without the
15480 timezone. This means that if your timezone changes twice a year, the timestamps
15481 in log lines are ambiguous for an hour when the clocks go back. One way of
15482 avoiding this problem is to set the timezone to UTC. An alternative is to set
15483 &%log_timezone%& true. This turns on the addition of the timezone offset to
15484 timestamps in log lines. Turning on this option can add quite a lot to the size
15485 of log files because each line is extended by 6 characters. Note that the
15486 &$tod_log$& variable contains the log timestamp without the zone, but there is
15487 another variable called &$tod_zone$& that contains just the timezone offset.
15488
15489
15490 .option lookup_open_max main integer 25
15491 .cindex "too many open files"
15492 .cindex "open files, too many"
15493 .cindex "file" "too many open"
15494 .cindex "lookup" "maximum open files"
15495 .cindex "limit" "open files for lookups"
15496 This option limits the number of simultaneously open files for single-key
15497 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15498 Exim normally keeps these files open during routing, because often the same
15499 file is required several times. If the limit is reached, Exim closes the least
15500 recently used file. Note that if you are using the &'ndbm'& library, it
15501 actually opens two files for each logical DBM database, though it still counts
15502 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15503 open files"& errors with NDBM, you need to reduce the value of
15504 &%lookup_open_max%&.
15505
15506
15507 .option max_username_length main integer 0
15508 .cindex "length of login name"
15509 .cindex "user name" "maximum length"
15510 .cindex "limit" "user name length"
15511 Some operating systems are broken in that they truncate long arguments to
15512 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15513 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15514 an argument that is longer behaves as if &[getpwnam()]& failed.
15515
15516
15517 .option message_body_newlines main bool false
15518 .cindex "message body" "newlines in variables"
15519 .cindex "newline" "in message body variables"
15520 .vindex "&$message_body$&"
15521 .vindex "&$message_body_end$&"
15522 By default, newlines in the message body are replaced by spaces when setting
15523 the &$message_body$& and &$message_body_end$& expansion variables. If this
15524 option is set true, this no longer happens.
15525
15526
15527 .option message_body_visible main integer 500
15528 .cindex "body of message" "visible size"
15529 .cindex "message body" "visible size"
15530 .vindex "&$message_body$&"
15531 .vindex "&$message_body_end$&"
15532 This option specifies how much of a message's body is to be included in the
15533 &$message_body$& and &$message_body_end$& expansion variables.
15534
15535
15536 .option message_id_header_domain main string&!! unset
15537 .cindex "&'Message-ID:'& header line"
15538 If this option is set, the string is expanded and used as the right hand side
15539 (domain) of the &'Message-ID:'& header that Exim creates if a
15540 locally-originated incoming message does not have one. &"Locally-originated"&
15541 means &"not received over TCP/IP."&
15542 Otherwise, the primary host name is used.
15543 Only letters, digits, dot and hyphen are accepted; any other characters are
15544 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15545 empty string, the option is ignored.
15546
15547
15548 .option message_id_header_text main string&!! unset
15549 If this variable is set, the string is expanded and used to augment the text of
15550 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15551 message does not have one. The text of this header is required by RFC 2822 to
15552 take the form of an address. By default, Exim uses its internal message id as
15553 the local part, and the primary host name as the domain. If this option is set,
15554 it is expanded, and provided the expansion is not forced to fail, and does not
15555 yield an empty string, the result is inserted into the header immediately
15556 before the @, separated from the internal message id by a dot. Any characters
15557 that are illegal in an address are automatically converted into hyphens. This
15558 means that variables such as &$tod_log$& can be used, because the spaces and
15559 colons will become hyphens.
15560
15561
15562 .option message_logs main boolean true
15563 .cindex "message logs" "disabling"
15564 .cindex "log" "message log; disabling"
15565 If this option is turned off, per-message log files are not created in the
15566 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15567 Exim, by reducing the number of files involved in handling a message from a
15568 minimum of four (header spool file, body spool file, delivery journal, and
15569 per-message log) to three. The other major I/O activity is Exim's main log,
15570 which is not affected by this option.
15571
15572
15573 .option message_size_limit main string&!! 50M
15574 .cindex "message" "size limit"
15575 .cindex "limit" "message size"
15576 .cindex "size" "of message, limit"
15577 This option limits the maximum size of message that Exim will process. The
15578 value is expanded for each incoming connection so, for example, it can be made
15579 to depend on the IP address of the remote host for messages arriving via
15580 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15581 optionally followed by K or M.
15582
15583 &*Note*&: This limit cannot be made to depend on a message's sender or any
15584 other properties of an individual message, because it has to be advertised in
15585 the server's response to EHLO. String expansion failure causes a temporary
15586 error. A value of zero means no limit, but its use is not recommended. See also
15587 &%bounce_return_size_limit%&.
15588
15589 Incoming SMTP messages are failed with a 552 error if the limit is
15590 exceeded; locally-generated messages either get a stderr message or a delivery
15591 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15592 an oversized message is logged in both the main and the reject logs. See also
15593 the generic transport option &%message_size_limit%&, which limits the size of
15594 message that an individual transport can process.
15595
15596 If you use a virus-scanner and set this option to to a value larger than the
15597 maximum size that your virus-scanner is configured to support, you may get
15598 failures triggered by large mails.  The right size to configure for the
15599 virus-scanner depends upon what data is passed and the options in use but it's
15600 probably safest to just set it to a little larger than this value.  E.g., with a
15601 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15602 some problems may result.
15603
15604 A value of 0 will disable size limit checking; Exim will still advertise the
15605 SIZE extension in an EHLO response, but without a limit, so as to permit
15606 SMTP clients to still indicate the message size along with the MAIL verb.
15607
15608
15609 .option move_frozen_messages main boolean false
15610 .cindex "frozen messages" "moving"
15611 This option, which is available only if Exim has been built with the setting
15612 .code
15613 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15614 .endd
15615 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15616 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15617 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15618 standard utilities for handling such moved messages, and they do not show up in
15619 lists generated by &%-bp%& or by the Exim monitor.
15620
15621
15622 .option mua_wrapper main boolean false
15623 Setting this option true causes Exim to run in a very restrictive mode in which
15624 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15625 contains a full description of this facility.
15626
15627
15628
15629 .option mysql_servers main "string list" unset
15630 .cindex "MySQL" "server list"
15631 This option provides a list of MySQL servers and associated connection data, to
15632 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15633 option is available only if Exim has been built with MySQL support.
15634
15635
15636 .option never_users main "string list&!!" unset
15637 This option is expanded just once, at the start of Exim's processing. Local
15638 message deliveries are normally run in processes that are setuid to the
15639 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15640 It is usually desirable to prevent any deliveries from running as root, as a
15641 safety precaution.
15642
15643 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15644 list of users that must not be used for local deliveries. This list is fixed in
15645 the binary and cannot be overridden by the configuration file. By default, it
15646 contains just the single user name &"root"&. The &%never_users%& runtime option
15647 can be used to add more users to the fixed list.
15648
15649 If a message is to be delivered as one of the users on the fixed list or the
15650 &%never_users%& list, an error occurs, and delivery is deferred. A common
15651 example is
15652 .code
15653 never_users = root:daemon:bin
15654 .endd
15655 Including root is redundant if it is also on the fixed list, but it does no
15656 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15657 transport driver.
15658
15659
15660 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15661 .cindex "OpenSSL "compatibility options"
15662 This option allows an administrator to adjust the SSL options applied
15663 by OpenSSL to connections.  It is given as a space-separated list of items,
15664 each one to be +added or -subtracted from the current value.
15665
15666 This option is only available if Exim is built against OpenSSL.  The values
15667 available for this option vary according to the age of your OpenSSL install.
15668 The &"all"& value controls a subset of flags which are available, typically
15669 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15670 list the values known on your system and Exim should support all the
15671 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15672 names lose the leading &"SSL_OP_"& and are lower-cased.
15673
15674 Note that adjusting the options can have severe impact upon the security of
15675 SSL as used by Exim.  It is possible to disable safety checks and shoot
15676 yourself in the foot in various unpleasant ways.  This option should not be
15677 adjusted lightly.  An unrecognised item will be detected at startup, by
15678 invoking Exim with the &%-bV%& flag.
15679
15680 The option affects Exim operating both as a server and as a client.
15681
15682 Historical note: prior to release 4.80, Exim defaulted this value to
15683 "+dont_insert_empty_fragments", which may still be needed for compatibility
15684 with some clients, but which lowers security by increasing exposure to
15685 some now infamous attacks.
15686
15687 Examples:
15688 .code
15689 # Make both old MS and old Eudora happy:
15690 openssl_options = -all +microsoft_big_sslv3_buffer \
15691                        +dont_insert_empty_fragments
15692
15693 # Disable older protocol versions:
15694 openssl_options = +no_sslv2 +no_sslv3
15695 .endd
15696
15697 Possible options may include:
15698 .ilist
15699 &`all`&
15700 .next
15701 &`allow_unsafe_legacy_renegotiation`&
15702 .next
15703 &`cipher_server_preference`&
15704 .next
15705 &`dont_insert_empty_fragments`&
15706 .next
15707 &`ephemeral_rsa`&
15708 .next
15709 &`legacy_server_connect`&
15710 .next
15711 &`microsoft_big_sslv3_buffer`&
15712 .next
15713 &`microsoft_sess_id_bug`&
15714 .next
15715 &`msie_sslv2_rsa_padding`&
15716 .next
15717 &`netscape_challenge_bug`&
15718 .next
15719 &`netscape_reuse_cipher_change_bug`&
15720 .next
15721 &`no_compression`&
15722 .next
15723 &`no_session_resumption_on_renegotiation`&
15724 .next
15725 &`no_sslv2`&
15726 .next
15727 &`no_sslv3`&
15728 .next
15729 &`no_ticket`&
15730 .next
15731 &`no_tlsv1`&
15732 .next
15733 &`no_tlsv1_1`&
15734 .next
15735 &`no_tlsv1_2`&
15736 .next
15737 &`safari_ecdhe_ecdsa_bug`&
15738 .next
15739 &`single_dh_use`&
15740 .next
15741 &`single_ecdh_use`&
15742 .next
15743 &`ssleay_080_client_dh_bug`&
15744 .next
15745 &`sslref2_reuse_cert_type_bug`&
15746 .next
15747 &`tls_block_padding_bug`&
15748 .next
15749 &`tls_d5_bug`&
15750 .next
15751 &`tls_rollback_bug`&
15752 .endlist
15753
15754 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15755 all clients connecting using the MacOS SecureTransport TLS facility prior
15756 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15757 to negotiate TLS then this option value might help, provided that your OpenSSL
15758 release is new enough to contain this work-around.  This may be a situation
15759 where you have to upgrade OpenSSL to get buggy clients working.
15760
15761
15762 .option oracle_servers main "string list" unset
15763 .cindex "Oracle" "server list"
15764 This option provides a list of Oracle servers and associated connection data,
15765 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15766 The option is available only if Exim has been built with Oracle support.
15767
15768
15769 .option percent_hack_domains main "domain list&!!" unset
15770 .cindex "&""percent hack""&"
15771 .cindex "source routing" "in email address"
15772 .cindex "address" "source-routed"
15773 The &"percent hack"& is the convention whereby a local part containing a
15774 percent sign is re-interpreted as a new email address, with the percent
15775 replaced by @. This is sometimes called &"source routing"&, though that term is
15776 also applied to RFC 2822 addresses that begin with an @ character. If this
15777 option is set, Exim implements the percent facility for those domains listed,
15778 but no others. This happens before an incoming SMTP address is tested against
15779 an ACL.
15780
15781 &*Warning*&: The &"percent hack"& has often been abused by people who are
15782 trying to get round relaying restrictions. For this reason, it is best avoided
15783 if at all possible. Unfortunately, a number of less security-conscious MTAs
15784 implement it unconditionally. If you are running Exim on a gateway host, and
15785 routing mail through to internal MTAs without processing the local parts, it is
15786 a good idea to reject recipient addresses with percent characters in their
15787 local parts. Exim's default configuration does this.
15788
15789
15790 .option perl_at_start main boolean false
15791 .cindex "Perl"
15792 This option is available only when Exim is built with an embedded Perl
15793 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15794
15795
15796 .option perl_startup main string unset
15797 .cindex "Perl"
15798 This option is available only when Exim is built with an embedded Perl
15799 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15800
15801 .option perl_startup main boolean false
15802 .cindex "Perl"
15803 This Option enables the taint mode of the embedded Perl interpreter.
15804
15805
15806 .option pgsql_servers main "string list" unset
15807 .cindex "PostgreSQL lookup type" "server list"
15808 This option provides a list of PostgreSQL servers and associated connection
15809 data, to be used in conjunction with &(pgsql)& lookups (see section
15810 &<<SECID72>>&). The option is available only if Exim has been built with
15811 PostgreSQL support.
15812
15813
15814 .option pid_file_path main string&!! "set at compile time"
15815 .cindex "daemon" "pid file path"
15816 .cindex "pid file, path for"
15817 This option sets the name of the file to which the Exim daemon writes its
15818 process id. The string is expanded, so it can contain, for example, references
15819 to the host name:
15820 .code
15821 pid_file_path = /var/log/$primary_hostname/exim.pid
15822 .endd
15823 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15824 spool directory.
15825 The value set by the option can be overridden by the &%-oP%& command line
15826 option. A pid file is not written if a &"non-standard"& daemon is run by means
15827 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15828
15829
15830 .option pipelining_advertise_hosts main "host list&!!" *
15831 .cindex "PIPELINING" "suppressing advertising"
15832 This option can be used to suppress the advertisement of the SMTP
15833 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15834 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15835 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15836 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15837 that clients will use it; &"out of order"& commands that are &"expected"& do
15838 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15839
15840
15841 .option prdr_enable main boolean false
15842 .cindex "PRDR" "enabling on server"
15843 This option can be used to enable the Per-Recipient Data Response extension
15844 to SMTP, defined by Eric Hall.
15845 If the option is set, PRDR is advertised by Exim when operating as a server.
15846 If the client requests PRDR, and more than one recipient, for a message
15847 an additional ACL is called for each recipient after the message content
15848 is received.  See section &<<SECTPRDRACL>>&.
15849
15850 .option preserve_message_logs main boolean false
15851 .cindex "message logs" "preserving"
15852 If this option is set, message log files are not deleted when messages are
15853 completed. Instead, they are moved to a sub-directory of the spool directory
15854 called &_msglog.OLD_&, where they remain available for statistical or debugging
15855 purposes. This is a dangerous option to set on systems with any appreciable
15856 volume of mail. Use with care!
15857
15858
15859 .option primary_hostname main string "see below"
15860 .cindex "name" "of local host"
15861 .cindex "host" "name of local"
15862 .cindex "local host" "name of"
15863 .vindex "&$primary_hostname$&"
15864 This specifies the name of the current host. It is used in the default EHLO or
15865 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15866 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15867 The value is also used by default in some SMTP response messages from an Exim
15868 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15869
15870 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15871 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15872 contains only one component, Exim passes it to &[gethostbyname()]& (or
15873 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15874 version. The variable &$primary_hostname$& contains the host name, whether set
15875 explicitly by this option, or defaulted.
15876
15877
15878 .option print_topbitchars main boolean false
15879 .cindex "printing characters"
15880 .cindex "8-bit characters"
15881 By default, Exim considers only those characters whose codes lie in the range
15882 32&--126 to be printing characters. In a number of circumstances (for example,
15883 when writing log entries) non-printing characters are converted into escape
15884 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15885 is set, code values of 128 and above are also considered to be printing
15886 characters.
15887
15888 This option also affects the header syntax checks performed by the
15889 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15890 the user's full name when constructing From: and Sender: addresses (as
15891 described in section &<<SECTconstr>>&). Setting this option can cause
15892 Exim to generate eight bit message headers that do not conform to the
15893 standards.
15894
15895
15896 .option process_log_path main string unset
15897 .cindex "process log path"
15898 .cindex "log" "process log"
15899 .cindex "&'exiwhat'&"
15900 This option sets the name of the file to which an Exim process writes its
15901 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15902 utility script. If this option is unset, the file called &_exim-process.info_&
15903 in Exim's spool directory is used. The ability to specify the name explicitly
15904 can be useful in environments where two different Exims are running, using
15905 different spool directories.
15906
15907
15908 .option prod_requires_admin main boolean true
15909 .oindex "&%-M%&"
15910 .oindex "&%-R%&"
15911 .oindex "&%-q%&"
15912 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15913 admin user unless &%prod_requires_admin%& is set false. See also
15914 &%queue_list_requires_admin%&.
15915
15916
15917 .option qualify_domain main string "see below"
15918 .cindex "domain" "for qualifying addresses"
15919 .cindex "address" "qualification"
15920 This option specifies the domain name that is added to any envelope sender
15921 addresses that do not have a domain qualification. It also applies to
15922 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15923 are accepted by default only for locally-generated messages. Qualification is
15924 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15925 locally-generated messages, unless the &%-bnq%& command line option is used.
15926
15927 Messages from external sources must always contain fully qualified addresses,
15928 unless the sending host matches &%sender_unqualified_hosts%& or
15929 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15930 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15931 necessary. Internally, Exim always works with fully qualified envelope
15932 addresses. If &%qualify_domain%& is not set, it defaults to the
15933 &%primary_hostname%& value.
15934
15935
15936 .option qualify_recipient main string "see below"
15937 This option allows you to specify a different domain for qualifying recipient
15938 addresses to the one that is used for senders. See &%qualify_domain%& above.
15939
15940
15941
15942 .option queue_domains main "domain list&!!" unset
15943 .cindex "domain" "specifying non-immediate delivery"
15944 .cindex "queueing incoming messages"
15945 .cindex "message" "queueing certain domains"
15946 This option lists domains for which immediate delivery is not required.
15947 A delivery process is started whenever a message is received, but only those
15948 domains that do not match are processed. All other deliveries wait until the
15949 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15950
15951
15952 .option queue_list_requires_admin main boolean true
15953 .oindex "&%-bp%&"
15954 The &%-bp%& command-line option, which lists the messages that are on the
15955 queue, requires the caller to be an admin user unless
15956 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15957
15958
15959 .option queue_only main boolean false
15960 .cindex "queueing incoming messages"
15961 .cindex "message" "queueing unconditionally"
15962 If &%queue_only%& is set, a delivery process is not automatically started
15963 whenever a message is received. Instead, the message waits on the queue for the
15964 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15965 delivered immediately when certain conditions (such as heavy load) occur.
15966
15967 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15968 and &%-odi%& command line options override &%queue_only%& unless
15969 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15970 &%queue_only_load%&, and &%smtp_accept_queue%&.
15971
15972
15973 .option queue_only_file main string unset
15974 .cindex "queueing incoming messages"
15975 .cindex "message" "queueing by file existence"
15976 This option can be set to a colon-separated list of absolute path names, each
15977 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15978 it tests for the existence of each listed path using a call to &[stat()]&. For
15979 each path that exists, the corresponding queueing option is set.
15980 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15981 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15982 .code
15983 queue_only_file = smtp/some/file
15984 .endd
15985 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15986 &_/some/file_& exists.
15987
15988
15989 .option queue_only_load main fixed-point unset
15990 .cindex "load average"
15991 .cindex "queueing incoming messages"
15992 .cindex "message" "queueing by load"
15993 If the system load average is higher than this value, incoming messages from
15994 all sources are queued, and no automatic deliveries are started. If this
15995 happens during local or remote SMTP input, all subsequent messages received on
15996 the same SMTP connection are queued by default, whatever happens to the load in
15997 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15998 false.
15999
16000 Deliveries will subsequently be performed by queue runner processes. This
16001 option has no effect on ancient operating systems on which Exim cannot
16002 determine the load average. See also &%deliver_queue_load_max%& and
16003 &%smtp_load_reserve%&.
16004
16005
16006 .option queue_only_load_latch main boolean true
16007 .cindex "load average" "re-evaluating per message"
16008 When this option is true (the default), once one message has been queued
16009 because the load average is higher than the value set by &%queue_only_load%&,
16010 all subsequent messages received on the same SMTP connection are also queued.
16011 This is a deliberate choice; even though the load average may fall below the
16012 threshold, it doesn't seem right to deliver later messages on the same
16013 connection when not delivering earlier ones. However, there are special
16014 circumstances such as very long-lived connections from scanning appliances
16015 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16016 should be set false. This causes the value of the load average to be
16017 re-evaluated for each message.
16018
16019
16020 .option queue_only_override main boolean true
16021 .cindex "queueing incoming messages"
16022 When this option is true, the &%-od%&&'x'& command line options override the
16023 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16024 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16025 to override; they are accepted, but ignored.
16026
16027
16028 .option queue_run_in_order main boolean false
16029 .cindex "queue runner" "processing messages in order"
16030 If this option is set, queue runs happen in order of message arrival instead of
16031 in an arbitrary order. For this to happen, a complete list of the entire queue
16032 must be set up before the deliveries start. When the queue is all held in a
16033 single directory (the default), a single list is created for both the ordered
16034 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16035 single list is not created when &%queue_run_in_order%& is false. In this case,
16036 the sub-directories are processed one at a time (in a random order), and this
16037 avoids setting up one huge list for the whole queue. Thus, setting
16038 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16039 when the queue is large, because of the extra work in setting up the single,
16040 large list. In most situations, &%queue_run_in_order%& should not be set.
16041
16042
16043
16044 .option queue_run_max main integer&!! 5
16045 .cindex "queue runner" "maximum number of"
16046 This controls the maximum number of queue runner processes that an Exim daemon
16047 can run simultaneously. This does not mean that it starts them all at once,
16048 but rather that if the maximum number are still running when the time comes to
16049 start another one, it refrains from starting another one. This can happen with
16050 very large queues and/or very sluggish deliveries. This option does not,
16051 however, interlock with other processes, so additional queue runners can be
16052 started by other means, or by killing and restarting the daemon.
16053
16054 Setting this option to zero does not suppress queue runs; rather, it disables
16055 the limit, allowing any number of simultaneous queue runner processes to be
16056 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16057 the daemon's command line.
16058
16059 .new
16060 .cindex queues named
16061 .cindex "named queues"
16062 To set limits for different named queues use
16063 an expansion depending on the &$queue_name$& variable.
16064 .wen
16065
16066 .option queue_smtp_domains main "domain list&!!" unset
16067 .cindex "queueing incoming messages"
16068 .cindex "message" "queueing remote deliveries"
16069 When this option is set, a delivery process is started whenever a message is
16070 received, routing is performed, and local deliveries take place.
16071 However, if any SMTP deliveries are required for domains that match
16072 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16073 message waits on the queue for the next queue run. Since routing of the message
16074 has taken place, Exim knows to which remote hosts it must be delivered, and so
16075 when the queue run happens, multiple messages for the same host are delivered
16076 over a single SMTP connection. The &%-odqs%& command line option causes all
16077 SMTP deliveries to be queued in this way, and is equivalent to setting
16078 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16079 &%queue_domains%&.
16080
16081
16082 .option receive_timeout main time 0s
16083 .cindex "timeout" "for non-SMTP input"
16084 This option sets the timeout for accepting a non-SMTP message, that is, the
16085 maximum time that Exim waits when reading a message on the standard input. If
16086 the value is zero, it will wait for ever. This setting is overridden by the
16087 &%-or%& command line option. The timeout for incoming SMTP messages is
16088 controlled by &%smtp_receive_timeout%&.
16089
16090 .option received_header_text main string&!! "see below"
16091 .cindex "customizing" "&'Received:'& header"
16092 .cindex "&'Received:'& header line" "customizing"
16093 This string defines the contents of the &'Received:'& message header that is
16094 added to each message, except for the timestamp, which is automatically added
16095 on at the end (preceded by a semicolon). The string is expanded each time it is
16096 used. If the expansion yields an empty string, no &'Received:'& header line is
16097 added to the message. Otherwise, the string should start with the text
16098 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16099 header lines. The default setting is:
16100
16101 .code
16102 received_header_text = Received: \
16103   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16104   {${if def:sender_ident \
16105   {from ${quote_local_part:$sender_ident} }}\
16106   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16107   by $primary_hostname \
16108   ${if def:received_protocol {with $received_protocol}} \
16109   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16110   (Exim $version_number)\n\t\
16111   ${if def:sender_address \
16112   {(envelope-from <$sender_address>)\n\t}}\
16113   id $message_exim_id\
16114   ${if def:received_for {\n\tfor $received_for}}
16115 .endd
16116
16117 The reference to the TLS cipher is omitted when Exim is built without TLS
16118 support. The use of conditional expansions ensures that this works for both
16119 locally generated messages and messages received from remote hosts, giving
16120 header lines such as the following:
16121 .code
16122 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16123 by marley.carol.example with esmtp (Exim 4.00)
16124 (envelope-from <bob@carol.example>)
16125 id 16IOWa-00019l-00
16126 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16127 Received: by scrooge.carol.example with local (Exim 4.00)
16128 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16129 .endd
16130 Until the body of the message has been received, the timestamp is the time when
16131 the message started to be received. Once the body has arrived, and all policy
16132 checks have taken place, the timestamp is updated to the time at which the
16133 message was accepted.
16134
16135
16136 .option received_headers_max main integer 30
16137 .cindex "loop" "prevention"
16138 .cindex "mail loop prevention"
16139 .cindex "&'Received:'& header line" "counting"
16140 When a message is to be delivered, the number of &'Received:'& headers is
16141 counted, and if it is greater than this parameter, a mail loop is assumed to
16142 have occurred, the delivery is abandoned, and an error message is generated.
16143 This applies to both local and remote deliveries.
16144
16145
16146 .option recipient_unqualified_hosts main "host list&!!" unset
16147 .cindex "unqualified addresses"
16148 .cindex "host" "unqualified addresses from"
16149 This option lists those hosts from which Exim is prepared to accept unqualified
16150 recipient addresses in message envelopes. The addresses are made fully
16151 qualified by the addition of the &%qualify_recipient%& value. This option also
16152 affects message header lines. Exim does not reject unqualified recipient
16153 addresses in headers, but it qualifies them only if the message came from a
16154 host that matches &%recipient_unqualified_hosts%&,
16155 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16156 option was not set.
16157
16158
16159 .option recipients_max main integer 0
16160 .cindex "limit" "number of recipients"
16161 .cindex "recipient" "maximum number"
16162 If this option is set greater than zero, it specifies the maximum number of
16163 original recipients for any message. Additional recipients that are generated
16164 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16165 all recipients over the limit; earlier recipients are delivered as normal.
16166 Non-SMTP messages with too many recipients are failed, and no deliveries are
16167 done.
16168
16169 .cindex "RCPT" "maximum number of incoming"
16170 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16171 RCPT commands in a single message.
16172
16173
16174 .option recipients_max_reject main boolean false
16175 If this option is set true, Exim rejects SMTP messages containing too many
16176 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16177 error to the eventual DATA command. Otherwise (the default) it gives a 452
16178 error to the surplus RCPT commands and accepts the message on behalf of the
16179 initial set of recipients. The remote server should then re-send the message
16180 for the remaining recipients at a later time.
16181
16182
16183 .option remote_max_parallel main integer 2
16184 .cindex "delivery" "parallelism for remote"
16185 This option controls parallel delivery of one message to a number of remote
16186 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16187 does all the remote deliveries for a message one by one. Otherwise, if a single
16188 message has to be delivered to more than one remote host, or if several copies
16189 have to be sent to the same remote host, up to &%remote_max_parallel%&
16190 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16191 deliveries are required, the maximum number of processes are started, and as
16192 each one finishes, another is begun. The order of starting processes is the
16193 same as if sequential delivery were being done, and can be controlled by the
16194 &%remote_sort_domains%& option. If parallel delivery takes place while running
16195 with debugging turned on, the debugging output from each delivery process is
16196 tagged with its process id.
16197
16198 This option controls only the maximum number of parallel deliveries for one
16199 message in one Exim delivery process. Because Exim has no central queue
16200 manager, there is no way of controlling the total number of simultaneous
16201 deliveries if the configuration allows a delivery attempt as soon as a message
16202 is received.
16203
16204 .cindex "number of deliveries"
16205 .cindex "delivery" "maximum number of"
16206 If you want to control the total number of deliveries on the system, you
16207 need to set the &%queue_only%& option. This ensures that all incoming messages
16208 are added to the queue without starting a delivery process. Then set up an Exim
16209 daemon to start queue runner processes at appropriate intervals (probably
16210 fairly often, for example, every minute), and limit the total number of queue
16211 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16212 delivers only one message at a time, the maximum number of deliveries that can
16213 then take place at once is &%queue_run_max%& multiplied by
16214 &%remote_max_parallel%&.
16215
16216 If it is purely remote deliveries you want to control, use
16217 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16218 doing the SMTP routing before queueing, so that several messages for the same
16219 host will eventually get delivered down the same connection.
16220
16221
16222 .option remote_sort_domains main "domain list&!!" unset
16223 .cindex "sorting remote deliveries"
16224 .cindex "delivery" "sorting remote"
16225 When there are a number of remote deliveries for a message, they are sorted by
16226 domain into the order given by this list. For example,
16227 .code
16228 remote_sort_domains = *.cam.ac.uk:*.uk
16229 .endd
16230 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16231 then to those in the &%uk%& domain, then to any others.
16232
16233
16234 .option retry_data_expire main time 7d
16235 .cindex "hints database" "data expiry"
16236 This option sets a &"use before"& time on retry information in Exim's hints
16237 database. Any older retry data is ignored. This means that, for example, once a
16238 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16239 past failures.
16240
16241
16242 .option retry_interval_max main time 24h
16243 .cindex "retry" "limit on interval"
16244 .cindex "limit" "on retry interval"
16245 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16246 intervals between delivery attempts for messages that cannot be delivered
16247 straight away. This option sets an overall limit to the length of time between
16248 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16249 the default value.
16250
16251
16252 .option return_path_remove main boolean true
16253 .cindex "&'Return-path:'& header line" "removing"
16254 RFC 2821, section 4.4, states that an SMTP server must insert a
16255 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16256 The &'Return-path:'& header preserves the sender address as received in the
16257 MAIL command. This description implies that this header should not be present
16258 in an incoming message. If &%return_path_remove%& is true, any existing
16259 &'Return-path:'& headers are removed from messages at the time they are
16260 received. Exim's transports have options for adding &'Return-path:'& headers at
16261 the time of delivery. They are normally used only for final local deliveries.
16262
16263
16264 .option return_size_limit main integer 100K
16265 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16266
16267
16268 .option rfc1413_hosts main "host list&!!" @[]
16269 .cindex "RFC 1413"
16270 .cindex "host" "for RFC 1413 calls"
16271 RFC 1413 identification calls are made to any client host which matches
16272 an item in the list.
16273 The default value specifies just this host, being any local interface
16274 for the system.
16275
16276 .option rfc1413_query_timeout main time 0s
16277 .cindex "RFC 1413" "query timeout"
16278 .cindex "timeout" "for RFC 1413 call"
16279 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16280 no RFC 1413 calls are ever made.
16281
16282
16283 .option sender_unqualified_hosts main "host list&!!" unset
16284 .cindex "unqualified addresses"
16285 .cindex "host" "unqualified addresses from"
16286 This option lists those hosts from which Exim is prepared to accept unqualified
16287 sender addresses. The addresses are made fully qualified by the addition of
16288 &%qualify_domain%&. This option also affects message header lines. Exim does
16289 not reject unqualified addresses in headers that contain sender addresses, but
16290 it qualifies them only if the message came from a host that matches
16291 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16292 using TCP/IP), and the &%-bnq%& option was not set.
16293
16294 .option set_environment main "string list" empty
16295 .cindex "environment"
16296 This option allows to set individual environment variables that the
16297 currently linked libraries and programs in child processes use. The
16298 default list is empty,
16299
16300
16301 .option slow_lookup_log main integer 0
16302 .cindex "logging" "slow lookups"
16303 .cindex "dns" "logging slow lookups"
16304 This option controls logging of slow lookups.
16305 If the value is nonzero it is taken as a number of milliseconds
16306 and lookups taking longer than this are logged.
16307 Currently this applies only to DNS lookups.
16308
16309
16310
16311 .option smtp_accept_keepalive main boolean true
16312 .cindex "keepalive" "on incoming connection"
16313 This option controls the setting of the SO_KEEPALIVE option on incoming
16314 TCP/IP socket connections. When set, it causes the kernel to probe idle
16315 connections periodically, by sending packets with &"old"& sequence numbers. The
16316 other end of the connection should send an acknowledgment if the connection is
16317 still okay or a reset if the connection has been aborted. The reason for doing
16318 this is that it has the beneficial effect of freeing up certain types of
16319 connection that can get stuck when the remote host is disconnected without
16320 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16321 hours to detect unreachable hosts.
16322
16323
16324
16325 .option smtp_accept_max main integer 20
16326 .cindex "limit" "incoming SMTP connections"
16327 .cindex "SMTP" "incoming connection count"
16328 .cindex "inetd"
16329 This option specifies the maximum number of simultaneous incoming SMTP calls
16330 that Exim will accept. It applies only to the listening daemon; there is no
16331 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16332 value is set to zero, no limit is applied. However, it is required to be
16333 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16334 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16335
16336 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16337 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16338 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16339 and &%smtp_load_reserve%& are then checked before accepting the connection.
16340
16341
16342 .option smtp_accept_max_nonmail main integer 10
16343 .cindex "limit" "non-mail SMTP commands"
16344 .cindex "SMTP" "limiting non-mail commands"
16345 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16346 the connection if there are too many. This option defines &"too many"&. The
16347 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16348 client looping sending EHLO, for example. The check is applied only if the
16349 client host matches &%smtp_accept_max_nonmail_hosts%&.
16350
16351 When a new message is expected, one occurrence of RSET is not counted. This
16352 allows a client to send one RSET between messages (this is not necessary,
16353 but some clients do it). Exim also allows one uncounted occurrence of HELO
16354 or EHLO, and one occurrence of STARTTLS between messages. After
16355 starting up a TLS session, another EHLO is expected, and so it too is not
16356 counted. The first occurrence of AUTH in a connection, or immediately
16357 following STARTTLS is not counted. Otherwise, all commands other than
16358 MAIL, RCPT, DATA, and QUIT are counted.
16359
16360
16361 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16362 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16363 check by setting this option. The default value makes it apply to all hosts. By
16364 changing the value, you can exclude any badly-behaved hosts that you have to
16365 live with.
16366
16367
16368 . Allow this long option name to split; give it unsplit as a fifth argument
16369 . for the automatic .oindex that is generated by .option.
16370 . We insert " &~&~" which is both pretty nasty visually and results in
16371 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16372 . zero-width-space, which would be nicer visually and results in (at least)
16373 . html that Firefox will split on when it's forced to reflow (rather than
16374 . inserting a horizontal scrollbar).  However, the text is still not
16375 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16376 . the option name to split.
16377
16378 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16379          smtp_accept_max_per_connection
16380 .cindex "SMTP" "limiting incoming message count"
16381 .cindex "limit" "messages per SMTP connection"
16382 The value of this option limits the number of MAIL commands that Exim is
16383 prepared to accept over a single SMTP connection, whether or not each command
16384 results in the transfer of a message. After the limit is reached, a 421
16385 response is given to subsequent MAIL commands. This limit is a safety
16386 precaution against a client that goes mad (incidents of this type have been
16387 seen).
16388
16389
16390 .option smtp_accept_max_per_host main string&!! unset
16391 .cindex "limit" "SMTP connections from one host"
16392 .cindex "host" "limiting SMTP connections from"
16393 This option restricts the number of simultaneous IP connections from a single
16394 host (strictly, from a single IP address) to the Exim daemon. The option is
16395 expanded, to enable different limits to be applied to different hosts by
16396 reference to &$sender_host_address$&. Once the limit is reached, additional
16397 connection attempts from the same host are rejected with error code 421. This
16398 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16399 of zero imposes no limit. If this option is set greater than zero, it is
16400 required that &%smtp_accept_max%& be non-zero.
16401
16402 &*Warning*&: When setting this option you should not use any expansion
16403 constructions that take an appreciable amount of time. The expansion and test
16404 happen in the main daemon loop, in order to reject additional connections
16405 without forking additional processes (otherwise a denial-of-service attack
16406 could cause a vast number or processes to be created). While the daemon is
16407 doing this processing, it cannot accept any other incoming connections.
16408
16409
16410
16411 .option smtp_accept_queue main integer 0
16412 .cindex "SMTP" "incoming connection count"
16413 .cindex "queueing incoming messages"
16414 .cindex "message" "queueing by SMTP connection count"
16415 If the number of simultaneous incoming SMTP connections being handled via the
16416 listening daemon exceeds this value, messages received by SMTP are just placed
16417 on the queue; no delivery processes are started automatically. The count is
16418 fixed at the start of an SMTP connection. It cannot be updated in the
16419 subprocess that receives messages, and so the queueing or not queueing applies
16420 to all messages received in the same connection.
16421
16422 A value of zero implies no limit, and clearly any non-zero value is useful only
16423 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16424 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16425 various &%-od%&&'x'& command line options.
16426
16427
16428 . See the comment on smtp_accept_max_per_connection
16429
16430 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16431          smtp_accept_queue_per_connection
16432 .cindex "queueing incoming messages"
16433 .cindex "message" "queueing by message count"
16434 This option limits the number of delivery processes that Exim starts
16435 automatically when receiving messages via SMTP, whether via the daemon or by
16436 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16437 and the number of messages received in a single SMTP session exceeds this
16438 number, subsequent messages are placed on the queue, but no delivery processes
16439 are started. This helps to limit the number of Exim processes when a server
16440 restarts after downtime and there is a lot of mail waiting for it on other
16441 systems. On large systems, the default should probably be increased, and on
16442 dial-in client systems it should probably be set to zero (that is, disabled).
16443
16444
16445 .option smtp_accept_reserve main integer 0
16446 .cindex "SMTP" "incoming call count"
16447 .cindex "host" "reserved"
16448 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16449 number of SMTP connections that are reserved for connections from the hosts
16450 that are specified in &%smtp_reserve_hosts%&. The value set in
16451 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16452 restricted to this number of connections; the option specifies a minimum number
16453 of connection slots for them, not a maximum. It is a guarantee that this group
16454 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16455 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16456 individual host.
16457
16458 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16459 set to 5, once there are 45 active connections (from any hosts), new
16460 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16461 provided the other criteria for acceptance are met.
16462
16463
16464 .option smtp_active_hostname main string&!! unset
16465 .cindex "host" "name in SMTP responses"
16466 .cindex "SMTP" "host name in responses"
16467 .vindex "&$primary_hostname$&"
16468 This option is provided for multi-homed servers that want to masquerade as
16469 several different hosts. At the start of an incoming SMTP connection, its value
16470 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16471 responses. For example, it is used as domain name in the response to an
16472 incoming HELO or EHLO command.
16473
16474 .vindex "&$smtp_active_hostname$&"
16475 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16476 is saved with any messages that are received. It is therefore available for use
16477 in routers and transports when the message is later delivered.
16478
16479 If this option is unset, or if its expansion is forced to fail, or if the
16480 expansion results in an empty string, the value of &$primary_hostname$& is
16481 used. Other expansion failures cause a message to be written to the main and
16482 panic logs, and the SMTP command receives a temporary error. Typically, the
16483 value of &%smtp_active_hostname%& depends on the incoming interface address.
16484 For example:
16485 .code
16486 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16487   {cox.mydomain}{box.mydomain}}
16488 .endd
16489
16490 Although &$smtp_active_hostname$& is primarily concerned with incoming
16491 messages, it is also used as the default for HELO commands in callout
16492 verification if there is no remote transport from which to obtain a
16493 &%helo_data%& value.
16494
16495 .option smtp_banner main string&!! "see below"
16496 .cindex "SMTP" "welcome banner"
16497 .cindex "banner for SMTP"
16498 .cindex "welcome banner for SMTP"
16499 .cindex "customizing" "SMTP banner"
16500 This string, which is expanded every time it is used, is output as the initial
16501 positive response to an SMTP connection. The default setting is:
16502 .code
16503 smtp_banner = $smtp_active_hostname ESMTP Exim \
16504   $version_number $tod_full
16505 .endd
16506 Failure to expand the string causes a panic error. If you want to create a
16507 multiline response to the initial SMTP connection, use &"\n"& in the string at
16508 appropriate points, but not at the end. Note that the 220 code is not included
16509 in this string. Exim adds it automatically (several times in the case of a
16510 multiline response).
16511
16512
16513 .option smtp_check_spool_space main boolean true
16514 .cindex "checking disk space"
16515 .cindex "disk space, checking"
16516 .cindex "spool directory" "checking space"
16517 When this option is set, if an incoming SMTP session encounters the SIZE
16518 option on a MAIL command, it checks that there is enough space in the
16519 spool directory's partition to accept a message of that size, while still
16520 leaving free the amount specified by &%check_spool_space%& (even if that value
16521 is zero). If there isn't enough space, a temporary error code is returned.
16522
16523
16524 .option smtp_connect_backlog main integer 20
16525 .cindex "connection backlog"
16526 .cindex "SMTP" "connection backlog"
16527 .cindex "backlog of connections"
16528 This option specifies a maximum number of waiting SMTP connections. Exim passes
16529 this value to the TCP/IP system when it sets up its listener. Once this number
16530 of connections are waiting for the daemon's attention, subsequent connection
16531 attempts are refused at the TCP/IP level. At least, that is what the manuals
16532 say; in some circumstances such connection attempts have been observed to time
16533 out instead. For large systems it is probably a good idea to increase the
16534 value (to 50, say). It also gives some protection against denial-of-service
16535 attacks by SYN flooding.
16536
16537
16538 .option smtp_enforce_sync main boolean true
16539 .cindex "SMTP" "synchronization checking"
16540 .cindex "synchronization checking in SMTP"
16541 The SMTP protocol specification requires the client to wait for a response from
16542 the server at certain points in the dialogue. Without PIPELINING these
16543 synchronization points are after every command; with PIPELINING they are
16544 fewer, but they still exist.
16545
16546 Some spamming sites send out a complete set of SMTP commands without waiting
16547 for any response. Exim protects against this by rejecting a message if the
16548 client has sent further input when it should not have. The error response &"554
16549 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16550 for this error cannot be perfect because of transmission delays (unexpected
16551 input may be on its way but not yet received when Exim checks). However, it
16552 does detect many instances.
16553
16554 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16555 If you want to disable the check selectively (for example, only for certain
16556 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16557 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16558
16559
16560
16561 .option smtp_etrn_command main string&!! unset
16562 .cindex "ETRN" "command to be run"
16563 .vindex "&$domain$&"
16564 If this option is set, the given command is run whenever an SMTP ETRN
16565 command is received from a host that is permitted to issue such commands (see
16566 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16567 are independently expanded. The expansion variable &$domain$& is set to the
16568 argument of the ETRN command, and no syntax checking is done on it. For
16569 example:
16570 .code
16571 smtp_etrn_command = /etc/etrn_command $domain \
16572                     $sender_host_address
16573 .endd
16574 A new process is created to run the command, but Exim does not wait for it to
16575 complete. Consequently, its status cannot be checked. If the command cannot be
16576 run, a line is written to the panic log, but the ETRN caller still receives
16577 a 250 success response. Exim is normally running under its own uid when
16578 receiving SMTP, so it is not possible for it to change the uid before running
16579 the command.
16580
16581
16582 .option smtp_etrn_serialize main boolean true
16583 .cindex "ETRN" "serializing"
16584 When this option is set, it prevents the simultaneous execution of more than
16585 one identical command as a result of ETRN in an SMTP connection. See
16586 section &<<SECTETRN>>& for details.
16587
16588
16589 .option smtp_load_reserve main fixed-point unset
16590 .cindex "load average"
16591 If the system load average ever gets higher than this, incoming SMTP calls are
16592 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16593 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16594 the load is over the limit. The option has no effect on ancient operating
16595 systems on which Exim cannot determine the load average. See also
16596 &%deliver_queue_load_max%& and &%queue_only_load%&.
16597
16598
16599
16600 .option smtp_max_synprot_errors main integer 3
16601 .cindex "SMTP" "limiting syntax and protocol errors"
16602 .cindex "limit" "SMTP syntax and protocol errors"
16603 Exim rejects SMTP commands that contain syntax or protocol errors. In
16604 particular, a syntactically invalid email address, as in this command:
16605 .code
16606 RCPT TO:<abc xyz@a.b.c>
16607 .endd
16608 causes immediate rejection of the command, before any other tests are done.
16609 (The ACL cannot be run if there is no valid address to set up for it.) An
16610 example of a protocol error is receiving RCPT before MAIL. If there are
16611 too many syntax or protocol errors in one SMTP session, the connection is
16612 dropped. The limit is set by this option.
16613
16614 .cindex "PIPELINING" "expected errors"
16615 When the PIPELINING extension to SMTP is in use, some protocol errors are
16616 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16617 Exim assumes that PIPELINING will be used if it advertises it (see
16618 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16619 not count towards the limit.
16620
16621
16622
16623 .option smtp_max_unknown_commands main integer 3
16624 .cindex "SMTP" "limiting unknown commands"
16625 .cindex "limit" "unknown SMTP commands"
16626 If there are too many unrecognized commands in an incoming SMTP session, an
16627 Exim server drops the connection. This is a defence against some kinds of abuse
16628 that subvert web
16629 clients
16630 into making connections to SMTP ports; in these circumstances, a number of
16631 non-SMTP command lines are sent first.
16632
16633
16634
16635 .option smtp_ratelimit_hosts main "host list&!!" unset
16636 .cindex "SMTP" "rate limiting"
16637 .cindex "limit" "rate of message arrival"
16638 .cindex "RCPT" "rate limiting"
16639 Some sites find it helpful to be able to limit the rate at which certain hosts
16640 can send them messages, and the rate at which an individual message can specify
16641 recipients.
16642
16643 Exim has two rate-limiting facilities. This section describes the older
16644 facility, which can limit rates within a single connection. The newer
16645 &%ratelimit%& ACL condition can limit rates across all connections. See section
16646 &<<SECTratelimiting>>& for details of the newer facility.
16647
16648 When a host matches &%smtp_ratelimit_hosts%&, the values of
16649 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16650 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16651 respectively. Each option, if set, must contain a set of four comma-separated
16652 values:
16653
16654 .ilist
16655 A threshold, before which there is no rate limiting.
16656 .next
16657 An initial time delay. Unlike other times in Exim, numbers with decimal
16658 fractional parts are allowed here.
16659 .next
16660 A factor by which to increase the delay each time.
16661 .next
16662 A maximum value for the delay. This should normally be less than 5 minutes,
16663 because after that time, the client is liable to timeout the SMTP command.
16664 .endlist
16665
16666 For example, these settings have been used successfully at the site which
16667 first suggested this feature, for controlling mail from their customers:
16668 .code
16669 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16670 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16671 .endd
16672 The first setting specifies delays that are applied to MAIL commands after
16673 two have been received over a single connection. The initial delay is 0.5
16674 seconds, increasing by a factor of 1.05 each time. The second setting applies
16675 delays to RCPT commands when more than four occur in a single message.
16676
16677
16678 .option smtp_ratelimit_mail main string unset
16679 See &%smtp_ratelimit_hosts%& above.
16680
16681
16682 .option smtp_ratelimit_rcpt main string unset
16683 See &%smtp_ratelimit_hosts%& above.
16684
16685
16686 .option smtp_receive_timeout main time&!! 5m
16687 .cindex "timeout" "for SMTP input"
16688 .cindex "SMTP" "input timeout"
16689 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16690 input, including batch SMTP. If a line of input (either an SMTP command or a
16691 data line) is not received within this time, the SMTP connection is dropped and
16692 the message is abandoned.
16693 A line is written to the log containing one of the following messages:
16694 .code
16695 SMTP command timeout on connection from...
16696 SMTP data timeout on connection from...
16697 .endd
16698 The former means that Exim was expecting to read an SMTP command; the latter
16699 means that it was in the DATA phase, reading the contents of a message.
16700
16701 If the first character of the option is a &"$"& the option is
16702 expanded before use and may depend on
16703 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16704
16705
16706 .oindex "&%-os%&"
16707 The value set by this option can be overridden by the
16708 &%-os%& command-line option. A setting of zero time disables the timeout, but
16709 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16710 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16711 timeout is controlled by &%receive_timeout%& and &%-or%&.
16712
16713
16714 .option smtp_reserve_hosts main "host list&!!" unset
16715 This option defines hosts for which SMTP connections are reserved; see
16716 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16717
16718
16719 .option smtp_return_error_details main boolean false
16720 .cindex "SMTP" "details policy failures"
16721 .cindex "policy control" "rejection, returning details"
16722 In the default state, Exim uses bland messages such as
16723 &"Administrative prohibition"& when it rejects SMTP commands for policy
16724 reasons. Many sysadmins like this because it gives away little information
16725 to spammers. However, some other sysadmins who are applying strict checking
16726 policies want to give out much fuller information about failures. Setting
16727 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16728 example, instead of &"Administrative prohibition"&, it might give:
16729 .code
16730 550-Rejected after DATA: '>' missing at end of address:
16731 550 failing address in "From" header is: <user@dom.ain
16732 .endd
16733
16734
16735 .option smtputf8_advertise_hosts main "host list&!!" *
16736 .cindex "SMTPUTF8" "advertising"
16737 When Exim is built with support for internationalised mail names,
16738 the availability therof is advertised in
16739 response to EHLO only to those client hosts that match this option. See
16740 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16741
16742
16743 .option spamd_address main string "see below"
16744 This option is available when Exim is compiled with the content-scanning
16745 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16746 The default value is
16747 .code
16748 127.0.0.1 783
16749 .endd
16750 See section &<<SECTscanspamass>>& for more details.
16751
16752
16753
16754 .option split_spool_directory main boolean false
16755 .cindex "multiple spool directories"
16756 .cindex "spool directory" "split"
16757 .cindex "directories, multiple"
16758 If this option is set, it causes Exim to split its input directory into 62
16759 subdirectories, each with a single alphanumeric character as its name. The
16760 sixth character of the message id is used to allocate messages to
16761 subdirectories; this is the least significant base-62 digit of the time of
16762 arrival of the message.
16763
16764 Splitting up the spool in this way may provide better performance on systems
16765 where there are long mail queues, by reducing the number of files in any one
16766 directory. The msglog directory is also split up in a similar way to the input
16767 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16768 are still placed in the single directory &_msglog.OLD_&.
16769
16770 It is not necessary to take any special action for existing messages when
16771 changing &%split_spool_directory%&. Exim notices messages that are in the
16772 &"wrong"& place, and continues to process them. If the option is turned off
16773 after a period of being on, the subdirectories will eventually empty and be
16774 automatically deleted.
16775
16776 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16777 changes. Instead of creating a list of all messages in the queue, and then
16778 trying to deliver each one in turn, it constructs a list of those in one
16779 sub-directory and tries to deliver them, before moving on to the next
16780 sub-directory. The sub-directories are processed in a random order. This
16781 spreads out the scanning of the input directories, and uses less memory. It is
16782 particularly beneficial when there are lots of messages on the queue. However,
16783 if &%queue_run_in_order%& is set, none of this new processing happens. The
16784 entire queue has to be scanned and sorted before any deliveries can start.
16785
16786
16787 .option spool_directory main string&!! "set at compile time"
16788 .cindex "spool directory" "path to"
16789 This defines the directory in which Exim keeps its spool, that is, the messages
16790 it is waiting to deliver. The default value is taken from the compile-time
16791 configuration setting, if there is one. If not, this option must be set. The
16792 string is expanded, so it can contain, for example, a reference to
16793 &$primary_hostname$&.
16794
16795 If the spool directory name is fixed on your installation, it is recommended
16796 that you set it at build time rather than from this option, particularly if the
16797 log files are being written to the spool directory (see &%log_file_path%&).
16798 Otherwise log files cannot be used for errors that are detected early on, such
16799 as failures in the configuration file.
16800
16801 By using this option to override the compiled-in path, it is possible to run
16802 tests of Exim without using the standard spool.
16803
16804 .option sqlite_lock_timeout main time 5s
16805 .cindex "sqlite lookup type" "lock timeout"
16806 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16807 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16808
16809 .option strict_acl_vars main boolean false
16810 .cindex "&ACL;" "variables, handling unset"
16811 This option controls what happens if a syntactically valid but undefined ACL
16812 variable is referenced. If it is false (the default), an empty string
16813 is substituted; if it is true, an error is generated. See section
16814 &<<SECTaclvariables>>& for details of ACL variables.
16815
16816 .option strip_excess_angle_brackets main boolean false
16817 .cindex "angle brackets, excess"
16818 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16819 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16820 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16821 passed on to another MTA, the excess angle brackets are not passed on. If this
16822 option is not set, multiple pairs of angle brackets cause a syntax error.
16823
16824
16825 .option strip_trailing_dot main boolean false
16826 .cindex "trailing dot on domain"
16827 .cindex "dot" "trailing on domain"
16828 If this option is set, a trailing dot at the end of a domain in an address is
16829 ignored. If this is in the envelope and the message is passed on to another
16830 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16831 domain causes a syntax error.
16832 However, addresses in header lines are checked only when an ACL requests header
16833 syntax checking.
16834
16835
16836 .option syslog_duplication main boolean true
16837 .cindex "syslog" "duplicate log lines; suppressing"
16838 When Exim is logging to syslog, it writes the log lines for its three
16839 separate logs at different syslog priorities so that they can in principle
16840 be separated on the logging hosts. Some installations do not require this
16841 separation, and in those cases, the duplication of certain log lines is a
16842 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16843 particular log line is written to syslog. For lines that normally go to
16844 both the main log and the reject log, the reject log version (possibly
16845 containing message header lines) is written, at LOG_NOTICE priority.
16846 Lines that normally go to both the main and the panic log are written at
16847 the LOG_ALERT priority.
16848
16849
16850 .option syslog_facility main string unset
16851 .cindex "syslog" "facility; setting"
16852 This option sets the syslog &"facility"& name, used when Exim is logging to
16853 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16854 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16855 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16856 details of Exim's logging.
16857
16858
16859
16860 .option syslog_processname main string &`exim`&
16861 .cindex "syslog" "process name; setting"
16862 This option sets the syslog &"ident"& name, used when Exim is logging to
16863 syslog. The value must be no longer than 32 characters. See chapter
16864 &<<CHAPlog>>& for details of Exim's logging.
16865
16866
16867
16868 .option syslog_timestamp main boolean true
16869 .cindex "syslog" "timestamps"
16870 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16871 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16872 details of Exim's logging.
16873
16874
16875 .option system_filter main string&!! unset
16876 .cindex "filter" "system filter"
16877 .cindex "system filter" "specifying"
16878 .cindex "Sieve filter" "not available for system filter"
16879 This option specifies an Exim filter file that is applied to all messages at
16880 the start of each delivery attempt, before any routing is done. System filters
16881 must be Exim filters; they cannot be Sieve filters. If the system filter
16882 generates any deliveries to files or pipes, or any new mail messages, the
16883 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16884 which transports are to be used. Details of this facility are given in chapter
16885 &<<CHAPsystemfilter>>&.
16886
16887
16888 .option system_filter_directory_transport main string&!! unset
16889 .vindex "&$address_file$&"
16890 This sets the name of the transport driver that is to be used when the
16891 &%save%& command in a system message filter specifies a path ending in &"/"&,
16892 implying delivery of each message into a separate file in some directory.
16893 During the delivery, the variable &$address_file$& contains the path name.
16894
16895
16896 .option system_filter_file_transport main string&!! unset
16897 .cindex "file" "transport for system filter"
16898 This sets the name of the transport driver that is to be used when the &%save%&
16899 command in a system message filter specifies a path not ending in &"/"&. During
16900 the delivery, the variable &$address_file$& contains the path name.
16901
16902 .option system_filter_group main string unset
16903 .cindex "gid (group id)" "system filter"
16904 This option is used only when &%system_filter_user%& is also set. It sets the
16905 gid under which the system filter is run, overriding any gid that is associated
16906 with the user. The value may be numerical or symbolic.
16907
16908 .option system_filter_pipe_transport main string&!! unset
16909 .cindex "&(pipe)& transport" "for system filter"
16910 .vindex "&$address_pipe$&"
16911 This specifies the transport driver that is to be used when a &%pipe%& command
16912 is used in a system filter. During the delivery, the variable &$address_pipe$&
16913 contains the pipe command.
16914
16915
16916 .option system_filter_reply_transport main string&!! unset
16917 .cindex "&(autoreply)& transport" "for system filter"
16918 This specifies the transport driver that is to be used when a &%mail%& command
16919 is used in a system filter.
16920
16921
16922 .option system_filter_user main string unset
16923 .cindex "uid (user id)" "system filter"
16924 If this option is set to root, the system filter is run in the main Exim
16925 delivery process, as root.  Otherwise, the system filter runs in a separate
16926 process, as the given user, defaulting to the Exim run-time user.
16927 Unless the string consists entirely of digits, it
16928 is looked up in the password data. Failure to find the named user causes a
16929 configuration error. The gid is either taken from the password data, or
16930 specified by &%system_filter_group%&. When the uid is specified numerically,
16931 &%system_filter_group%& is required to be set.
16932
16933 If the system filter generates any pipe, file, or reply deliveries, the uid
16934 under which the filter is run is used when transporting them, unless a
16935 transport option overrides.
16936
16937
16938 .option tcp_nodelay main boolean true
16939 .cindex "daemon" "TCP_NODELAY on sockets"
16940 .cindex "Nagle algorithm"
16941 .cindex "TCP_NODELAY on listening sockets"
16942 If this option is set false, it stops the Exim daemon setting the
16943 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16944 turns off the &"Nagle algorithm"&, which is a way of improving network
16945 performance in interactive (character-by-character) situations. Turning it off
16946 should improve Exim's performance a bit, so that is what happens by default.
16947 However, it appears that some broken clients cannot cope, and time out. Hence
16948 this option. It affects only those sockets that are set up for listening by the
16949 daemon. Sockets created by the smtp transport for delivering mail always set
16950 TCP_NODELAY.
16951
16952
16953 .option timeout_frozen_after main time 0s
16954 .cindex "frozen messages" "timing out"
16955 .cindex "timeout" "frozen messages"
16956 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16957 message of any kind that has been on the queue for longer than the given time
16958 is automatically cancelled at the next queue run. If the frozen message is a
16959 bounce message, it is just discarded; otherwise, a bounce is sent to the
16960 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16961 If you want to timeout frozen bounce messages earlier than other kinds of
16962 frozen message, see &%ignore_bounce_errors_after%&.
16963
16964 &*Note:*& the default value of zero means no timeouts; with this setting,
16965 frozen messages remain on the queue forever (except for any frozen bounce
16966 messages that are released by &%ignore_bounce_errors_after%&).
16967
16968
16969 .option timezone main string unset
16970 .cindex "timezone, setting"
16971 .cindex "environment" "values from"
16972 The value of &%timezone%& is used to set the environment variable TZ while
16973 running Exim (if it is different on entry). This ensures that all timestamps
16974 created by Exim are in the required timezone. If you want all your timestamps
16975 to be in UTC (aka GMT) you should set
16976 .code
16977 timezone = UTC
16978 .endd
16979 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16980 or, if that is not set, from the value of the TZ environment variable when Exim
16981 is built. If &%timezone%& is set to the empty string, either at build or run
16982 time, any existing TZ variable is removed from the environment when Exim
16983 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16984 unfortunately not all, operating systems.
16985
16986
16987 .option tls_advertise_hosts main "host list&!!" *
16988 .cindex "TLS" "advertising"
16989 .cindex "encryption" "on SMTP connection"
16990 .cindex "SMTP" "encrypted connection"
16991 When Exim is built with support for TLS encrypted connections, the availability
16992 of the STARTTLS command to set up an encrypted session is advertised in
16993 response to EHLO only to those client hosts that match this option. See
16994 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16995 Note that the default value requires that a certificate be supplied
16996 using the &%tls_certificate%& option.  If TLS support for incoming connections
16997 is not required the &%tls_advertise_hosts%& option should be set empty.
16998
16999
17000 .option tls_certificate main string&!! unset
17001 .cindex "TLS" "server certificate; location of"
17002 .cindex "certificate" "server, location of"
17003 The value of this option is expanded, and must then be the absolute path to a
17004 file which contains the server's certificates. The server's private key is also
17005 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17006 &<<CHAPTLS>>& for further details.
17007
17008 &*Note*&: The certificates defined by this option are used only when Exim is
17009 receiving incoming messages as a server. If you want to supply certificates for
17010 use when sending messages as a client, you must set the &%tls_certificate%&
17011 option in the relevant &(smtp)& transport.
17012
17013 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17014 if the OpenSSL build supports TLS extensions and the TLS client sends the
17015 Server Name Indication extension, then this option and others documented in
17016 &<<SECTtlssni>>& will be re-expanded.
17017
17018 .new
17019 If this option is unset or empty a fresh self-signed certificate will be
17020 generated for every connection.
17021 .wen
17022
17023 .option tls_crl main string&!! unset
17024 .cindex "TLS" "server certificate revocation list"
17025 .cindex "certificate" "revocation list for server"
17026 This option specifies a certificate revocation list. The expanded value must
17027 be the name of a file that contains a CRL in PEM format.
17028
17029 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17030
17031
17032 .option tls_dh_max_bits main integer 2236
17033 .cindex "TLS" "D-H bit count"
17034 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17035 the chosen TLS library.  That value might prove to be too high for
17036 interoperability.  This option provides a maximum clamp on the value
17037 suggested, trading off security for interoperability.
17038
17039 The value must be at least 1024.
17040
17041 The value 2236 was chosen because, at time of adding the option, it was the
17042 hard-coded maximum value supported by the NSS cryptographic library, as used
17043 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17044
17045 If you prefer more security and are willing to break some clients, raise this
17046 number.
17047
17048 Note that the value passed to GnuTLS for *generating* a new prime may be a
17049 little less than this figure, because GnuTLS is inexact and may produce a
17050 larger prime than requested.
17051
17052
17053 .option tls_dhparam main string&!! unset
17054 .cindex "TLS" "D-H parameters for server"
17055 The value of this option is expanded and indicates the source of DH parameters
17056 to be used by Exim.
17057
17058 .new
17059 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17060 local DH parameters*&, which has been supported across all versions of Exim.  The
17061 other specific constants available are a fallback so that even when
17062 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17063 .wen
17064
17065 If &%tls_dhparam%& is a filename starting with a &`/`&,
17066 then it names a file from which DH
17067 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17068 PKCS#3 representation of the DH prime.  If the file does not exist, for
17069 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17070 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17071 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17072 and treated as though the &%tls_dhparam%& were set to "none".
17073
17074 If this option expands to the string "none", then no DH parameters will be
17075 loaded by Exim.
17076
17077 If this option expands to the string "historic" and Exim is using GnuTLS, then
17078 Exim will attempt to load a file from inside the spool directory.  If the file
17079 does not exist, Exim will attempt to create it.
17080 See section &<<SECTgnutlsparam>>& for further details.
17081
17082 .new
17083 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17084 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17085
17086 In older versions of Exim the default was the 2048 bit prime described in section
17087 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17088 in IKE is assigned number 23.
17089
17090 Otherwise, the option must expand to the name used by Exim for any of a number
17091 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17092 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17093 the number used by IKE, or "default" which corresponds to
17094 &`exim.dev.20160529.3`&.
17095
17096 The available standard primes are:
17097 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17098 &`ike1`&, &`ike2`&, &`ike5`&,
17099 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17100 &`ike22`&, &`ike23`& and &`ike24`&.
17101
17102 The available additional primes are:
17103 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17104
17105 Some of these will be too small to be accepted by clients.
17106 Some may be too large to be accepted by clients.
17107 The open cryptographic community has suspicions about the integrity of some
17108 of the later IKE values, which led into RFC7919 providing new fixed constants
17109 (the "ffdhe" identifiers).
17110
17111 At this point, all of the "ike" values should be considered obsolete;
17112 they're still in Exim to avoid breaking unusual configurations, but are
17113 candidates for removal the next time we have backwards-incompatible changes.
17114 .wen
17115
17116 The TLS protocol does not negotiate an acceptable size for this; clients tend
17117 to hard-drop connections if what is offered by the server is unacceptable,
17118 whether too large or too small, and there's no provision for the client to
17119 tell the server what these constraints are.  Thus, as a server operator, you
17120 need to make an educated guess as to what is most likely to work for your
17121 userbase.
17122
17123 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17124 is most likely to maximise interoperability.  The upper bound comes from
17125 applications using the Mozilla Network Security Services (NSS) library, which
17126 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17127 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17128 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17129 acceptable bound from 1024 to 2048.
17130
17131
17132 .option tls_eccurve main string&!! prime256v1
17133 .cindex TLS "EC cryptography"
17134 If built with a recent-enough version of OpenSSL,
17135 this option selects a EC curve for use by Exim.
17136
17137 Curve names of the form &'prime256v1'& are accepted.
17138 For even more-recent library versions, names of the form &'P-512'&
17139 are also accepted, plus the special value &'auto'&
17140 which tells the library to choose.
17141
17142 If the option is set to an empty string, no EC curves will be enabled.
17143
17144
17145 .option tls_ocsp_file main string&!! unset
17146 .cindex TLS "certificate status"
17147 .cindex TLS "OCSP proof file"
17148 This option
17149 must if set expand to the absolute path to a file which contains a current
17150 status proof for the server's certificate, as obtained from the
17151 Certificate Authority.
17152
17153 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17154
17155
17156 .option tls_on_connect_ports main "string list" unset
17157 .cindex SSMTP
17158 .cindex SMTPS
17159 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17160 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17161 set up without waiting for the client to issue a STARTTLS command. For
17162 further details, see section &<<SECTsupobssmt>>&.
17163
17164
17165
17166 .option tls_privatekey main string&!! unset
17167 .cindex "TLS" "server private key; location of"
17168 The value of this option is expanded, and must then be the absolute path to a
17169 file which contains the server's private key. If this option is unset, or if
17170 the expansion is forced to fail, or the result is an empty string, the private
17171 key is assumed to be in the same file as the server's certificates. See chapter
17172 &<<CHAPTLS>>& for further details.
17173
17174 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17175
17176
17177 .option tls_remember_esmtp main boolean false
17178 .cindex "TLS" "esmtp state; remembering"
17179 .cindex "TLS" "broken clients"
17180 If this option is set true, Exim violates the RFCs by remembering that it is in
17181 &"esmtp"& state after successfully negotiating a TLS session. This provides
17182 support for broken clients that fail to send a new EHLO after starting a
17183 TLS session.
17184
17185
17186 .option tls_require_ciphers main string&!! unset
17187 .cindex "TLS" "requiring specific ciphers"
17188 .cindex "cipher" "requiring specific"
17189 This option controls which ciphers can be used for incoming TLS connections.
17190 The &(smtp)& transport has an option of the same name for controlling outgoing
17191 connections. This option is expanded for each connection, so can be varied for
17192 different clients if required. The value of this option must be a list of
17193 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17194 in somewhat different ways. If GnuTLS is being used, the client controls the
17195 preference order of the available ciphers. Details are given in sections
17196 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17197
17198
17199 .option tls_try_verify_hosts main "host list&!!" unset
17200 .cindex "TLS" "client certificate verification"
17201 .cindex "certificate" "verification of client"
17202 See &%tls_verify_hosts%& below.
17203
17204
17205 .option tls_verify_certificates main string&!! system
17206 .cindex "TLS" "client certificate verification"
17207 .cindex "certificate" "verification of client"
17208 The value of this option is expanded, and must then be either the
17209 word "system"
17210 or the absolute path to
17211 a file or directory containing permitted certificates for clients that
17212 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17213
17214 The "system" value for the option will use a
17215 system default location compiled into the SSL library.
17216 This is not available for GnuTLS versions preceding 3.0.20,
17217 and will be taken as empty; an explicit location
17218 must be specified.
17219
17220 The use of a directory for the option value is not available for GnuTLS versions
17221 preceding 3.3.6 and a single file must be used.
17222
17223 With OpenSSL the certificates specified
17224 explicitly
17225 either by file or directory
17226 are added to those given by the system default location.
17227
17228 These certificates should be for the certificate authorities trusted, rather
17229 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17230 the value is a file then the certificates are sent by Exim as a server to
17231 connecting clients, defining the list of accepted certificate authorities.
17232 Thus the values defined should be considered public data.  To avoid this,
17233 use the explicit directory version.
17234
17235 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17236
17237 A forced expansion failure or setting to an empty string is equivalent to
17238 being unset.
17239
17240
17241 .option tls_verify_hosts main "host list&!!" unset
17242 .cindex "TLS" "client certificate verification"
17243 .cindex "certificate" "verification of client"
17244 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17245 certificates from clients. The expected certificates are defined by
17246 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17247 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17248 &%tls_verify_certificates%& is not set.
17249
17250 Any client that matches &%tls_verify_hosts%& is constrained by
17251 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17252 present one of the listed certificates. If it does not, the connection is
17253 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17254 the host to use TLS. It can still send SMTP commands through unencrypted
17255 connections. Forcing a client to use TLS has to be done separately using an
17256 ACL to reject inappropriate commands when the connection is not encrypted.
17257
17258 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17259 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17260 certificate and checks it against &%tls_verify_certificates%&, but does not
17261 abort the connection if there is no certificate or if it does not match. This
17262 state can be detected in an ACL, which makes it possible to implement policies
17263 such as &"accept for relay only if a verified certificate has been received,
17264 but accept for local delivery if encrypted, even without a verified
17265 certificate"&.
17266
17267 Client hosts that match neither of these lists are not asked to present
17268 certificates.
17269
17270
17271 .option trusted_groups main "string list&!!" unset
17272 .cindex "trusted groups"
17273 .cindex "groups" "trusted"
17274 This option is expanded just once, at the start of Exim's processing. If this
17275 option is set, any process that is running in one of the listed groups, or
17276 which has one of them as a supplementary group, is trusted. The groups can be
17277 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17278 details of what trusted callers are permitted to do. If neither
17279 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17280 are trusted.
17281
17282 .option trusted_users main "string list&!!" unset
17283 .cindex "trusted users"
17284 .cindex "user" "trusted"
17285 This option is expanded just once, at the start of Exim's processing. If this
17286 option is set, any process that is running as one of the listed users is
17287 trusted. The users can be specified numerically or by name. See section
17288 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17289 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17290 Exim user are trusted.
17291
17292 .option unknown_login main string&!! unset
17293 .cindex "uid (user id)" "unknown caller"
17294 .vindex "&$caller_uid$&"
17295 This is a specialized feature for use in unusual configurations. By default, if
17296 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17297 gives up. The &%unknown_login%& option can be used to set a login name to be
17298 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17299 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17300 is used for the user's real name (gecos field), unless this has been set by the
17301 &%-F%& option.
17302
17303 .option unknown_username main string unset
17304 See &%unknown_login%&.
17305
17306 .option untrusted_set_sender main "address list&!!" unset
17307 .cindex "trusted users"
17308 .cindex "sender" "setting by untrusted user"
17309 .cindex "untrusted user setting sender"
17310 .cindex "user" "untrusted setting sender"
17311 .cindex "envelope sender"
17312 When an untrusted user submits a message to Exim using the standard input, Exim
17313 normally creates an envelope sender address from the user's login and the
17314 default qualification domain. Data from the &%-f%& option (for setting envelope
17315 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17316 is used) is ignored.
17317
17318 However, untrusted users are permitted to set an empty envelope sender address,
17319 to declare that a message should never generate any bounces. For example:
17320 .code
17321 exim -f '<>' user@domain.example
17322 .endd
17323 .vindex "&$sender_ident$&"
17324 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17325 other envelope sender addresses in a controlled way. When it is set, untrusted
17326 users are allowed to set envelope sender addresses that match any of the
17327 patterns in the list. Like all address lists, the string is expanded. The
17328 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17329 users to setting senders that start with their login ids
17330 followed by a hyphen
17331 by a setting like this:
17332 .code
17333 untrusted_set_sender = ^$sender_ident-
17334 .endd
17335 If you want to allow untrusted users to set envelope sender addresses without
17336 restriction, you can use
17337 .code
17338 untrusted_set_sender = *
17339 .endd
17340 The &%untrusted_set_sender%& option applies to all forms of local input, but
17341 only to the setting of the envelope sender. It does not permit untrusted users
17342 to use the other options which trusted user can use to override message
17343 parameters. Furthermore, it does not stop Exim from removing an existing
17344 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17345 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17346 overriding these actions. The handling of the &'Sender:'& header is also
17347 described in section &<<SECTthesenhea>>&.
17348
17349 The log line for a message's arrival shows the envelope sender following
17350 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17351 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17352 envelope sender address, the user's login is shown in parentheses after the
17353 sender address.
17354
17355
17356 .option uucp_from_pattern main string "see below"
17357 .cindex "&""From""& line"
17358 .cindex "UUCP" "&""From""& line"
17359 Some applications that pass messages to an MTA via a command line interface use
17360 an initial line starting with &"From&~"& to pass the envelope sender. In
17361 particular, this is used by UUCP software. Exim recognizes such a line by means
17362 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17363 matches, the sender address is constructed by expanding the contents of
17364 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17365 default pattern recognizes lines in the following two forms:
17366 .code
17367 From ph10 Fri Jan  5 12:35 GMT 1996
17368 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17369 .endd
17370 The pattern can be seen by running
17371 .code
17372 exim -bP uucp_from_pattern
17373 .endd
17374 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17375 year in the second case. The first word after &"From&~"& is matched in the
17376 regular expression by a parenthesized subpattern. The default value for
17377 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17378 (&"ph10"& in the example above) as the message's sender. See also
17379 &%ignore_fromline_hosts%&.
17380
17381
17382 .option uucp_from_sender main string&!! &`$1`&
17383 See &%uucp_from_pattern%& above.
17384
17385
17386 .option warn_message_file main string unset
17387 .cindex "warning of delay" "customizing the message"
17388 .cindex "customizing" "warning message"
17389 This option defines a template file containing paragraphs of text to be used
17390 for constructing the warning message which is sent by Exim when a message has
17391 been on the queue for a specified amount of time, as specified by
17392 &%delay_warning%&. Details of the file's contents are given in chapter
17393 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17394
17395
17396 .option write_rejectlog main boolean true
17397 .cindex "reject log" "disabling"
17398 If this option is set false, Exim no longer writes anything to the reject log.
17399 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17400 .ecindex IIDconfima
17401 .ecindex IIDmaiconf
17402
17403
17404
17405
17406 . ////////////////////////////////////////////////////////////////////////////
17407 . ////////////////////////////////////////////////////////////////////////////
17408
17409 .chapter "Generic options for routers" "CHAProutergeneric"
17410 .scindex IIDgenoprou1 "options" "generic; for routers"
17411 .scindex IIDgenoprou2 "generic options" "router"
17412 This chapter describes the generic options that apply to all routers.
17413 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17414
17415 For a general description of how a router operates, see sections
17416 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17417 which the preconditions are tested. The order of expansion of the options that
17418 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17419 &%headers_remove%&, &%transport%&.
17420
17421
17422
17423 .option address_data routers string&!! unset
17424 .cindex "router" "data attached to address"
17425 The string is expanded just before the router is run, that is, after all the
17426 precondition tests have succeeded. If the expansion is forced to fail, the
17427 router declines, the value of &%address_data%& remains unchanged, and the
17428 &%more%& option controls what happens next. Other expansion failures cause
17429 delivery of the address to be deferred.
17430
17431 .vindex "&$address_data$&"
17432 When the expansion succeeds, the value is retained with the address, and can be
17433 accessed using the variable &$address_data$& in the current router, subsequent
17434 routers, and the eventual transport.
17435
17436 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17437 that runs a user's filter file, the contents of &$address_data$& are accessible
17438 in the filter. This is not normally a problem, because such data is usually
17439 either not confidential or it &"belongs"& to the current user, but if you do
17440 put confidential data into &$address_data$& you need to remember this point.
17441
17442 Even if the router declines or passes, the value of &$address_data$& remains
17443 with the address, though it can be changed by another &%address_data%& setting
17444 on a subsequent router. If a router generates child addresses, the value of
17445 &$address_data$& propagates to them. This also applies to the special kind of
17446 &"child"& that is generated by a router with the &%unseen%& option.
17447
17448 The idea of &%address_data%& is that you can use it to look up a lot of data
17449 for the address once, and then pick out parts of the data later. For example,
17450 you could use a single LDAP lookup to return a string of the form
17451 .code
17452 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17453 .endd
17454 In the transport you could pick out the mailbox by a setting such as
17455 .code
17456 file = ${extract{mailbox}{$address_data}}
17457 .endd
17458 This makes the configuration file less messy, and also reduces the number of
17459 lookups (though Exim does cache lookups).
17460
17461 .vindex "&$sender_address_data$&"
17462 .vindex "&$address_data$&"
17463 The &%address_data%& facility is also useful as a means of passing information
17464 from one router to another, and from a router to a transport. In addition, if
17465 &$address_data$& is set by a router when verifying a recipient address from an
17466 ACL, it remains available for use in the rest of the ACL statement. After
17467 verifying a sender, the value is transferred to &$sender_address_data$&.
17468
17469
17470
17471 .option address_test routers&!? boolean true
17472 .oindex "&%-bt%&"
17473 .cindex "router" "skipping when address testing"
17474 If this option is set false, the router is skipped when routing is being tested
17475 by means of the &%-bt%& command line option. This can be a convenience when
17476 your first router sends messages to an external scanner, because it saves you
17477 having to set the &"already scanned"& indicator when testing real address
17478 routing.
17479
17480
17481
17482 .option cannot_route_message routers string&!! unset
17483 .cindex "router" "customizing &""cannot route""& message"
17484 .cindex "customizing" "&""cannot route""& message"
17485 This option specifies a text message that is used when an address cannot be
17486 routed because Exim has run out of routers. The default message is
17487 &"Unrouteable address"&. This option is useful only on routers that have
17488 &%more%& set false, or on the very last router in a configuration, because the
17489 value that is used is taken from the last router that is considered. This
17490 includes a router that is skipped because its preconditions are not met, as
17491 well as a router that declines. For example, using the default configuration,
17492 you could put:
17493 .code
17494 cannot_route_message = Remote domain not found in DNS
17495 .endd
17496 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17497 and
17498 .code
17499 cannot_route_message = Unknown local user
17500 .endd
17501 on the final router that checks for local users. If string expansion fails for
17502 this option, the default message is used. Unless the expansion failure was
17503 explicitly forced, a message about the failure is written to the main and panic
17504 logs, in addition to the normal message about the routing failure.
17505
17506
17507 .option caseful_local_part routers boolean false
17508 .cindex "case of local parts"
17509 .cindex "router" "case of local parts"
17510 By default, routers handle the local parts of addresses in a case-insensitive
17511 manner, though the actual case is preserved for transmission with the message.
17512 If you want the case of letters to be significant in a router, you must set
17513 this option true. For individual router options that contain address or local
17514 part lists (for example, &%local_parts%&), case-sensitive matching can be
17515 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17516 more details.
17517
17518 .vindex "&$local_part$&"
17519 .vindex "&$original_local_part$&"
17520 .vindex "&$parent_local_part$&"
17521 The value of the &$local_part$& variable is forced to lower case while a
17522 router is running unless &%caseful_local_part%& is set. When a router assigns
17523 an address to a transport, the value of &$local_part$& when the transport runs
17524 is the same as it was in the router. Similarly, when a router generates child
17525 addresses by aliasing or forwarding, the values of &$original_local_part$&
17526 and &$parent_local_part$& are those that were used by the redirecting router.
17527
17528 This option applies to the processing of an address by a router. When a
17529 recipient address is being processed in an ACL, there is a separate &%control%&
17530 modifier that can be used to specify case-sensitive processing within the ACL
17531 (see section &<<SECTcontrols>>&).
17532
17533
17534
17535 .option check_local_user routers&!? boolean false
17536 .cindex "local user, checking in router"
17537 .cindex "router" "checking for local user"
17538 .cindex "&_/etc/passwd_&"
17539 .vindex "&$home$&"
17540 When this option is true, Exim checks that the local part of the recipient
17541 address (with affixes removed if relevant) is the name of an account on the
17542 local system. The check is done by calling the &[getpwnam()]& function rather
17543 than trying to read &_/etc/passwd_& directly. This means that other methods of
17544 holding password data (such as NIS) are supported. If the local part is a local
17545 user, &$home$& is set from the password data, and can be tested in other
17546 preconditions that are evaluated after this one (the order of evaluation is
17547 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17548 overridden by &%router_home_directory%&. If the local part is not a local user,
17549 the router is skipped.
17550
17551 If you want to check that the local part is either the name of a local user
17552 or matches something else, you cannot combine &%check_local_user%& with a
17553 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17554 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17555 setting to achieve this. For example:
17556 .code
17557 local_parts = passwd;$local_part : lsearch;/etc/other/users
17558 .endd
17559 Note, however, that the side effects of &%check_local_user%& (such as setting
17560 up a home directory) do not occur when a &(passwd)& lookup is used in a
17561 &%local_parts%& (or any other) precondition.
17562
17563
17564
17565 .option condition routers&!? string&!! unset
17566 .cindex "router" "customized precondition"
17567 This option specifies a general precondition test that has to succeed for the
17568 router to be called. The &%condition%& option is the last precondition to be
17569 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17570 result is a forced failure, or an empty string, or one of the strings &"0"& or
17571 &"no"& or &"false"& (checked without regard to the case of the letters), the
17572 router is skipped, and the address is offered to the next one.
17573
17574 If the result is any other value, the router is run (as this is the last
17575 precondition to be evaluated, all the other preconditions must be true).
17576
17577 This option is unusual in that multiple &%condition%& options may be present.
17578 All &%condition%& options must succeed.
17579
17580 The &%condition%& option provides a means of applying custom conditions to the
17581 running of routers. Note that in the case of a simple conditional expansion,
17582 the default expansion values are exactly what is wanted. For example:
17583 .code
17584 condition = ${if >{$message_age}{600}}
17585 .endd
17586 Because of the default behaviour of the string expansion, this is equivalent to
17587 .code
17588 condition = ${if >{$message_age}{600}{true}{}}
17589 .endd
17590
17591 A multiple condition example, which succeeds:
17592 .code
17593 condition = ${if >{$message_age}{600}}
17594 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17595 condition = foobar
17596 .endd
17597
17598 If the expansion fails (other than forced failure) delivery is deferred. Some
17599 of the other precondition options are common special cases that could in fact
17600 be specified using &%condition%&.
17601
17602 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17603 are far older, and use one set of semantics.  ACLs are newer and when
17604 they were created, the ACL &%condition%& process was given far stricter
17605 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17606 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17607 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17608 Router rules processing behavior.
17609
17610 This is best illustrated in an example:
17611 .code
17612 # If used in an ACL condition will fail with a syntax error, but
17613 # in a router condition any extra characters are treated as a string
17614
17615 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17616 true {yes} {no}}
17617
17618 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17619  {yes} {no}}
17620 .endd
17621 In each example above, the &%if%& statement actually ends after
17622 &"{google.com}}"&.  Since no true or false braces were defined, the
17623 default &%if%& behavior is to return a boolean true or a null answer
17624 (which evaluates to false). The rest of the line is then treated as a
17625 string. So the first example resulted in the boolean answer &"true"&
17626 with the string &" {yes} {no}}"& appended to it. The second example
17627 resulted in the null output (indicating false) with the string
17628 &" {yes} {no}}"& appended to it.
17629
17630 In fact you can put excess forward braces in too.  In the router
17631 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17632 mean something, like after a &"$"& or when required as part of a
17633 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17634 string characters.
17635
17636 Thus, in a Router, the above expansion strings will both always evaluate
17637 true, as the result of expansion is a non-empty string which doesn't
17638 match an explicit false value.  This can be tricky to debug.  By
17639 contrast, in an ACL either of those strings will always result in an
17640 expansion error because the result doesn't look sufficiently boolean.
17641
17642
17643 .option debug_print routers string&!! unset
17644 .cindex "testing" "variables in drivers"
17645 If this option is set and debugging is enabled (see the &%-d%& command line
17646 option) or in address-testing mode (see the &%-bt%& command line option),
17647 the string is expanded and included in the debugging output.
17648 If expansion of the string fails, the error message is written to the debugging
17649 output, and Exim carries on processing.
17650 This option is provided to help with checking out the values of variables and
17651 so on when debugging router configurations. For example, if a &%condition%&
17652 option appears not to be working, &%debug_print%& can be used to output the
17653 variables it references. The output happens after checks for &%domains%&,
17654 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17655 are tested. A newline is added to the text if it does not end with one.
17656 The variable &$router_name$& contains the name of the router.
17657
17658
17659
17660 .option disable_logging routers boolean false
17661 If this option is set true, nothing is logged for any routing errors
17662 or for any deliveries caused by this router. You should not set this option
17663 unless you really, really know what you are doing. See also the generic
17664 transport option of the same name.
17665
17666 .option dnssec_request_domains routers "domain list&!!" unset
17667 .cindex "MX record" "security"
17668 .cindex "DNSSEC" "MX lookup"
17669 .cindex "security" "MX lookup"
17670 .cindex "DNS" "DNSSEC"
17671 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17672 the dnssec request bit set.
17673 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17674
17675 .option dnssec_require_domains routers "domain list&!!" unset
17676 .cindex "MX record" "security"
17677 .cindex "DNSSEC" "MX lookup"
17678 .cindex "security" "MX lookup"
17679 .cindex "DNS" "DNSSEC"
17680 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17681 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17682 (AD bit) set will be ignored and logged as a host-lookup failure.
17683 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17684
17685
17686 .option domains routers&!? "domain list&!!" unset
17687 .cindex "router" "restricting to specific domains"
17688 .vindex "&$domain_data$&"
17689 If this option is set, the router is skipped unless the current domain matches
17690 the list. If the match is achieved by means of a file lookup, the data that the
17691 lookup returned for the domain is placed in &$domain_data$& for use in string
17692 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17693 a list of the order in which preconditions are evaluated.
17694
17695
17696
17697 .option driver routers string unset
17698 This option must always be set. It specifies which of the available routers is
17699 to be used.
17700
17701
17702 .option dsn_lasthop routers boolean false
17703 .cindex "DSN" "success"
17704 .cindex "Delivery Status Notification" "success"
17705 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17706 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17707 instead send a success DSN as if the next hop does not support DSN.
17708 Not effective on redirect routers.
17709
17710
17711
17712 .option errors_to routers string&!! unset
17713 .cindex "envelope sender"
17714 .cindex "router" "changing address for errors"
17715 If a router successfully handles an address, it may assign the address to a
17716 transport for delivery or it may generate child addresses. In both cases, if
17717 there is a delivery problem during later processing, the resulting bounce
17718 message is sent to the address that results from expanding this string,
17719 provided that the address verifies successfully. The &%errors_to%& option is
17720 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17721
17722 The &%errors_to%& setting associated with an address can be overridden if it
17723 subsequently passes through other routers that have their own &%errors_to%&
17724 settings, or if the message is delivered by a transport with a &%return_path%&
17725 setting.
17726
17727 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17728 the expansion fails to verify, the errors address associated with the incoming
17729 address is used. At top level, this is the envelope sender. A non-forced
17730 expansion failure causes delivery to be deferred.
17731
17732 If an address for which &%errors_to%& has been set ends up being delivered over
17733 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17734 any bounces that are generated by other MTAs on the delivery route are also
17735 sent there. You can set &%errors_to%& to the empty string by either of these
17736 settings:
17737 .code
17738 errors_to =
17739 errors_to = ""
17740 .endd
17741 An expansion item that yields an empty string has the same effect. If you do
17742 this, a locally detected delivery error for addresses processed by this router
17743 no longer gives rise to a bounce message; the error is discarded. If the
17744 address is delivered to a remote host, the return path is set to &`<>`&, unless
17745 overridden by the &%return_path%& option on the transport.
17746
17747 .vindex "&$address_data$&"
17748 If for some reason you want to discard local errors, but use a non-empty
17749 MAIL command for remote delivery, you can preserve the original return
17750 path in &$address_data$& in the router, and reinstate it in the transport by
17751 setting &%return_path%&.
17752
17753 The most common use of &%errors_to%& is to direct mailing list bounces to the
17754 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17755 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17756
17757
17758
17759 .option expn routers&!? boolean true
17760 .cindex "address" "testing"
17761 .cindex "testing" "addresses"
17762 .cindex "EXPN" "router skipping"
17763 .cindex "router" "skipping for EXPN"
17764 If this option is turned off, the router is skipped when testing an address
17765 as a result of processing an SMTP EXPN command. You might, for example,
17766 want to turn it off on a router for users' &_.forward_& files, while leaving it
17767 on for the system alias file.
17768 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17769 are evaluated.
17770
17771 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17772 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17773 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17774
17775
17776
17777 .option fail_verify routers boolean false
17778 .cindex "router" "forcing verification failure"
17779 Setting this option has the effect of setting both &%fail_verify_sender%& and
17780 &%fail_verify_recipient%& to the same value.
17781
17782
17783
17784 .option fail_verify_recipient routers boolean false
17785 If this option is true and an address is accepted by this router when
17786 verifying a recipient, verification fails.
17787
17788
17789
17790 .option fail_verify_sender routers boolean false
17791 If this option is true and an address is accepted by this router when
17792 verifying a sender, verification fails.
17793
17794
17795
17796 .option fallback_hosts routers "string list" unset
17797 .cindex "router" "fallback hosts"
17798 .cindex "fallback" "hosts specified on router"
17799 String expansion is not applied to this option. The argument must be a
17800 colon-separated list of host names or IP addresses. The list separator can be
17801 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17802 each name or address. In fact, the format of each item is exactly the same as
17803 defined for the list of hosts in a &(manualroute)& router (see section
17804 &<<SECTformatonehostitem>>&).
17805
17806 If a router queues an address for a remote transport, this host list is
17807 associated with the address, and used instead of the transport's fallback host
17808 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17809 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17810 transport for further details.
17811
17812
17813 .option group routers string&!! "see below"
17814 .cindex "gid (group id)" "local delivery"
17815 .cindex "local transports" "uid and gid"
17816 .cindex "transport" "local"
17817 .cindex "router" "setting group"
17818 When a router queues an address for a transport, and the transport does not
17819 specify a group, the group given here is used when running the delivery
17820 process.
17821 The group may be specified numerically or by name. If expansion fails, the
17822 error is logged and delivery is deferred.
17823 The default is unset, unless &%check_local_user%& is set, when the default
17824 is taken from the password information. See also &%initgroups%& and &%user%&
17825 and the discussion in chapter &<<CHAPenvironment>>&.
17826
17827
17828
17829 .option headers_add routers list&!! unset
17830 .cindex "header lines" "adding"
17831 .cindex "router" "adding header lines"
17832 This option specifies a list of text headers,
17833 newline-separated (by default, changeable in the usual way),
17834 that is associated with any addresses that are accepted by the router.
17835 Each item is separately expanded, at routing time.  However, this
17836 option has no effect when an address is just being verified. The way in which
17837 the text is used to add header lines at transport time is described in section
17838 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17839 message is in the process of being transported. This means that references to
17840 header lines in string expansions in the transport's configuration do not
17841 &"see"& the added header lines.
17842
17843 The &%headers_add%& option is expanded after &%errors_to%&, but before
17844 &%headers_remove%& and &%transport%&. If an item is empty, or if
17845 an item expansion is forced to fail, the item has no effect. Other expansion
17846 failures are treated as configuration errors.
17847
17848 Unlike most options, &%headers_add%& can be specified multiple times
17849 for a router; all listed headers are added.
17850
17851 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17852 router that has the &%one_time%& option set.
17853
17854 .cindex "duplicate addresses"
17855 .oindex "&%unseen%&"
17856 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17857 additions are deleted when the address is passed on to subsequent routers.
17858 For a &%redirect%& router, if a generated address is the same as the incoming
17859 address, this can lead to duplicate addresses with different header
17860 modifications. Exim does not do duplicate deliveries (except, in certain
17861 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17862 which of the duplicates is discarded, so this ambiguous situation should be
17863 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17864
17865
17866
17867 .option headers_remove routers list&!! unset
17868 .cindex "header lines" "removing"
17869 .cindex "router" "removing header lines"
17870 This option specifies a list of text headers,
17871 colon-separated (by default, changeable in the usual way),
17872 that is associated with any addresses that are accepted by the router.
17873 Each item is separately expanded, at routing time.  However, this
17874 option has no effect when an address is just being verified. The way in which
17875 the text is used to remove header lines at transport time is described in
17876 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17877 the message is in the process of being transported. This means that references
17878 to header lines in string expansions in the transport's configuration still
17879 &"see"& the original header lines.
17880
17881 The &%headers_remove%& option is expanded after &%errors_to%& and
17882 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17883 the item has no effect. Other expansion failures are treated as configuration
17884 errors.
17885
17886 Unlike most options, &%headers_remove%& can be specified multiple times
17887 for a router; all listed headers are removed.
17888
17889 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17890 router that has the &%one_time%& option set.
17891
17892 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17893 removal requests are deleted when the address is passed on to subsequent
17894 routers, and this can lead to problems with duplicates -- see the similar
17895 warning for &%headers_add%& above.
17896
17897 &*Warning 3*&: Because of the separate expansion of the list items,
17898 items that contain a list separator must have it doubled.
17899 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17900
17901
17902
17903 .option ignore_target_hosts routers "host list&!!" unset
17904 .cindex "IP address" "discarding"
17905 .cindex "router" "discarding IP addresses"
17906 Although this option is a host list, it should normally contain IP address
17907 entries rather than names. If any host that is looked up by the router has an
17908 IP address that matches an item in this list, Exim behaves as if that IP
17909 address did not exist. This option allows you to cope with rogue DNS entries
17910 like
17911 .code
17912 remote.domain.example.  A  127.0.0.1
17913 .endd
17914 by setting
17915 .code
17916 ignore_target_hosts = 127.0.0.1
17917 .endd
17918 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17919 discarded in this way, the router declines. In a conventional configuration, an
17920 attempt to mail to such a domain would normally provoke the &"unrouteable
17921 domain"& error, and an attempt to verify an address in the domain would fail.
17922 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17923 router declines if presented with one of the listed addresses.
17924
17925 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17926 means of the first or the second of the following settings, respectively:
17927 .code
17928 ignore_target_hosts = 0.0.0.0/0
17929 ignore_target_hosts = <; 0::0/0
17930 .endd
17931 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17932 in the second line matches all IPv6 addresses.
17933
17934 This option may also be useful for ignoring link-local and site-local IPv6
17935 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17936 is expanded before use as a list, it is possible to make it dependent on the
17937 domain that is being routed.
17938
17939 .vindex "&$host_address$&"
17940 During its expansion, &$host_address$& is set to the IP address that is being
17941 checked.
17942
17943 .option initgroups routers boolean false
17944 .cindex "additional groups"
17945 .cindex "groups" "additional"
17946 .cindex "local transports" "uid and gid"
17947 .cindex "transport" "local"
17948 If the router queues an address for a transport, and this option is true, and
17949 the uid supplied by the router is not overridden by the transport, the
17950 &[initgroups()]& function is called when running the transport to ensure that
17951 any additional groups associated with the uid are set up. See also &%group%&
17952 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17953
17954
17955
17956 .option local_part_prefix routers&!? "string list" unset
17957 .cindex "router" "prefix for local part"
17958 .cindex "prefix" "for local part, used in router"
17959 If this option is set, the router is skipped unless the local part starts with
17960 one of the given strings, or &%local_part_prefix_optional%& is true. See
17961 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17962 evaluated.
17963
17964 The list is scanned from left to right, and the first prefix that matches is
17965 used. A limited form of wildcard is available; if the prefix begins with an
17966 asterisk, it matches the longest possible sequence of arbitrary characters at
17967 the start of the local part. An asterisk should therefore always be followed by
17968 some character that does not occur in normal local parts.
17969 .cindex "multiple mailboxes"
17970 .cindex "mailbox" "multiple"
17971 Wildcarding can be used to set up multiple user mailboxes, as described in
17972 section &<<SECTmulbox>>&.
17973
17974 .vindex "&$local_part$&"
17975 .vindex "&$local_part_prefix$&"
17976 During the testing of the &%local_parts%& option, and while the router is
17977 running, the prefix is removed from the local part, and is available in the
17978 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17979 the router accepts the address, this remains true during subsequent delivery by
17980 a transport. In particular, the local part that is transmitted in the RCPT
17981 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17982 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17983 the relevant transport.
17984
17985 When an address is being verified, &%local_part_prefix%& affects only the
17986 behaviour of the router. If the callout feature of verification is in use, this
17987 means that the full address, including the prefix, will be used during the
17988 callout.
17989
17990 The prefix facility is commonly used to handle local parts of the form
17991 &%owner-something%&. Another common use is to support local parts of the form
17992 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17993 to tell a user their forwarding is broken &-- by placing a router like this one
17994 immediately before the router that handles &_.forward_& files:
17995 .code
17996 real_localuser:
17997   driver = accept
17998   local_part_prefix = real-
17999   check_local_user
18000   transport = local_delivery
18001 .endd
18002 For security, it would probably be a good idea to restrict the use of this
18003 router to locally-generated messages, using a condition such as this:
18004 .code
18005   condition = ${if match {$sender_host_address}\
18006                          {\N^(|127\.0\.0\.1)$\N}}
18007 .endd
18008
18009 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18010 both conditions must be met if not optional. Care must be taken if wildcards
18011 are used in both a prefix and a suffix on the same router. Different
18012 separator characters must be used to avoid ambiguity.
18013
18014
18015 .option local_part_prefix_optional routers boolean false
18016 See &%local_part_prefix%& above.
18017
18018
18019
18020 .option local_part_suffix routers&!? "string list" unset
18021 .cindex "router" "suffix for local part"
18022 .cindex "suffix for local part" "used in router"
18023 This option operates in the same way as &%local_part_prefix%&, except that the
18024 local part must end (rather than start) with the given string, the
18025 &%local_part_suffix_optional%& option determines whether the suffix is
18026 mandatory, and the wildcard * character, if present, must be the last
18027 character of the suffix. This option facility is commonly used to handle local
18028 parts of the form &%something-request%& and multiple user mailboxes of the form
18029 &%username-foo%&.
18030
18031
18032 .option local_part_suffix_optional routers boolean false
18033 See &%local_part_suffix%& above.
18034
18035
18036
18037 .option local_parts routers&!? "local part list&!!" unset
18038 .cindex "router" "restricting to specific local parts"
18039 .cindex "local part" "checking in router"
18040 The router is run only if the local part of the address matches the list.
18041 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18042 are evaluated, and
18043 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18044 string is expanded, it is possible to make it depend on the domain, for
18045 example:
18046 .code
18047 local_parts = dbm;/usr/local/specials/$domain
18048 .endd
18049 .vindex "&$local_part_data$&"
18050 If the match is achieved by a lookup, the data that the lookup returned
18051 for the local part is placed in the variable &$local_part_data$& for use in
18052 expansions of the router's private options. You might use this option, for
18053 example, if you have a large number of local virtual domains, and you want to
18054 send all postmaster mail to the same place without having to set up an alias in
18055 each virtual domain:
18056 .code
18057 postmaster:
18058   driver = redirect
18059   local_parts = postmaster
18060   data = postmaster@real.domain.example
18061 .endd
18062
18063
18064 .option log_as_local routers boolean "see below"
18065 .cindex "log" "delivery line"
18066 .cindex "delivery" "log line format"
18067 Exim has two logging styles for delivery, the idea being to make local
18068 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18069 recipient address is given just as the local part, without a domain. The use of
18070 this style is controlled by this option. It defaults to true for the &(accept)&
18071 router, and false for all the others. This option applies only when a
18072 router assigns an address to a transport. It has no effect on routers that
18073 redirect addresses.
18074
18075
18076
18077 .option more routers boolean&!! true
18078 The result of string expansion for this option must be a valid boolean value,
18079 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18080 result causes an error, and delivery is deferred. If the expansion is forced to
18081 fail, the default value for the option (true) is used. Other failures cause
18082 delivery to be deferred.
18083
18084 If this option is set false, and the router declines to handle the address, no
18085 further routers are tried, routing fails, and the address is bounced.
18086 .oindex "&%self%&"
18087 However, if the router explicitly passes an address to the following router by
18088 means of the setting
18089 .code
18090 self = pass
18091 .endd
18092 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18093 does not affect the behaviour if one of the precondition tests fails. In that
18094 case, the address is always passed to the next router.
18095
18096 Note that &%address_data%& is not considered to be a precondition. If its
18097 expansion is forced to fail, the router declines, and the value of &%more%&
18098 controls what happens next.
18099
18100
18101 .option pass_on_timeout routers boolean false
18102 .cindex "timeout" "of router"
18103 .cindex "router" "timeout"
18104 If a router times out during a host lookup, it normally causes deferral of the
18105 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18106 router, overriding &%no_more%&. This may be helpful for systems that are
18107 intermittently connected to the Internet, or those that want to pass to a smart
18108 host any messages that cannot immediately be delivered.
18109
18110 There are occasional other temporary errors that can occur while doing DNS
18111 lookups. They are treated in the same way as a timeout, and this option
18112 applies to all of them.
18113
18114
18115
18116 .option pass_router routers string unset
18117 .cindex "router" "go to after &""pass""&"
18118 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18119 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18120 routing to continue, and overriding a false setting of &%more%&. When one of
18121 these routers returns &"pass"&, the address is normally handed on to the next
18122 router in sequence. This can be changed by setting &%pass_router%& to the name
18123 of another router. However (unlike &%redirect_router%&) the named router must
18124 be below the current router, to avoid loops. Note that this option applies only
18125 to the special case of &"pass"&. It does not apply when a router returns
18126 &"decline"& because it cannot handle an address.
18127
18128
18129
18130 .option redirect_router routers string unset
18131 .cindex "router" "start at after redirection"
18132 Sometimes an administrator knows that it is pointless to reprocess addresses
18133 generated from alias or forward files with the same router again. For
18134 example, if an alias file translates real names into login ids there is no
18135 point searching the alias file a second time, especially if it is a large file.
18136
18137 The &%redirect_router%& option can be set to the name of any router instance.
18138 It causes the routing of any generated addresses to start at the named router
18139 instead of at the first router. This option has no effect if the router in
18140 which it is set does not generate new addresses.
18141
18142
18143
18144 .option require_files routers&!? "string list&!!" unset
18145 .cindex "file" "requiring for router"
18146 .cindex "router" "requiring file existence"
18147 This option provides a general mechanism for predicating the running of a
18148 router on the existence or non-existence of certain files or directories.
18149 Before running a router, as one of its precondition tests, Exim works its way
18150 through the &%require_files%& list, expanding each item separately.
18151
18152 Because the list is split before expansion, any colons in expansion items must
18153 be doubled, or the facility for using a different list separator must be used.
18154 If any expansion is forced to fail, the item is ignored. Other expansion
18155 failures cause routing of the address to be deferred.
18156
18157 If any expanded string is empty, it is ignored. Otherwise, except as described
18158 below, each string must be a fully qualified file path, optionally preceded by
18159 &"!"&. The paths are passed to the &[stat()]& function to test for the
18160 existence of the files or directories. The router is skipped if any paths not
18161 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18162
18163 .cindex "NFS"
18164 If &[stat()]& cannot determine whether a file exists or not, delivery of
18165 the message is deferred. This can happen when NFS-mounted filesystems are
18166 unavailable.
18167
18168 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18169 options, so you cannot use it to check for the existence of a file in which to
18170 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18171 full list of the order in which preconditions are evaluated.) However, as
18172 these options are all expanded, you can use the &%exists%& expansion condition
18173 to make such tests. The &%require_files%& option is intended for checking files
18174 that the router may be going to use internally, or which are needed by a
18175 transport (for example &_.procmailrc_&).
18176
18177 During delivery, the &[stat()]& function is run as root, but there is a
18178 facility for some checking of the accessibility of a file by another user.
18179 This is not a proper permissions check, but just a &"rough"& check that
18180 operates as follows:
18181
18182 If an item in a &%require_files%& list does not contain any forward slash
18183 characters, it is taken to be the user (and optional group, separated by a
18184 comma) to be checked for subsequent files in the list. If no group is specified
18185 but the user is specified symbolically, the gid associated with the uid is
18186 used. For example:
18187 .code
18188 require_files = mail:/some/file
18189 require_files = $local_part:$home/.procmailrc
18190 .endd
18191 If a user or group name in a &%require_files%& list does not exist, the
18192 &%require_files%& condition fails.
18193
18194 Exim performs the check by scanning along the components of the file path, and
18195 checking the access for the given uid and gid. It checks for &"x"& access on
18196 directories, and &"r"& access on the final file. Note that this means that file
18197 access control lists, if the operating system has them, are ignored.
18198
18199 &*Warning 1*&: When the router is being run to verify addresses for an
18200 incoming SMTP message, Exim is not running as root, but under its own uid. This
18201 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18202 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18203 user is not permitted to read one of the directories on the file's path.
18204
18205 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18206 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18207 without root access. In this case, if a check for access by a particular user
18208 is requested, Exim creates a subprocess that runs as that user, and tries the
18209 check again in that process.
18210
18211 The default action for handling an unresolved EACCES is to consider it to
18212 be caused by a configuration error, and routing is deferred because the
18213 existence or non-existence of the file cannot be determined. However, in some
18214 circumstances it may be desirable to treat this condition as if the file did
18215 not exist. If the file name (or the exclamation mark that precedes the file
18216 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18217 as if the file did not exist. For example:
18218 .code
18219 require_files = +/some/file
18220 .endd
18221 If the router is not an essential part of verification (for example, it
18222 handles users' &_.forward_& files), another solution is to set the &%verify%&
18223 option false so that the router is skipped when verifying.
18224
18225
18226
18227 .option retry_use_local_part routers boolean "see below"
18228 .cindex "hints database" "retry keys"
18229 .cindex "local part" "in retry keys"
18230 When a delivery suffers a temporary routing failure, a retry record is created
18231 in Exim's hints database. For addresses whose routing depends only on the
18232 domain, the key for the retry record should not involve the local part, but for
18233 other addresses, both the domain and the local part should be included.
18234 Usually, remote routing is of the former kind, and local routing is of the
18235 latter kind.
18236
18237 This option controls whether the local part is used to form the key for retry
18238 hints for addresses that suffer temporary errors while being handled by this
18239 router. The default value is true for any router that has &%check_local_user%&
18240 set, and false otherwise. Note that this option does not apply to hints keys
18241 for transport delays; they are controlled by a generic transport option of the
18242 same name.
18243
18244 The setting of &%retry_use_local_part%& applies only to the router on which it
18245 appears. If the router generates child addresses, they are routed
18246 independently; this setting does not become attached to them.
18247
18248
18249
18250 .option router_home_directory routers string&!! unset
18251 .cindex "router" "home directory for"
18252 .cindex "home directory" "for router"
18253 .vindex "&$home$&"
18254 This option sets a home directory for use while the router is running. (Compare
18255 &%transport_home_directory%&, which sets a home directory for later
18256 transporting.) In particular, if used on a &(redirect)& router, this option
18257 sets a value for &$home$& while a filter is running. The value is expanded;
18258 forced expansion failure causes the option to be ignored &-- other failures
18259 cause the router to defer.
18260
18261 Expansion of &%router_home_directory%& happens immediately after the
18262 &%check_local_user%& test (if configured), before any further expansions take
18263 place.
18264 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18265 are evaluated.)
18266 While the router is running, &%router_home_directory%& overrides the value of
18267 &$home$& that came from &%check_local_user%&.
18268
18269 When a router accepts an address and assigns it to a local transport (including
18270 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18271 delivery), the home directory setting for the transport is taken from the first
18272 of these values that is set:
18273
18274 .ilist
18275 The &%home_directory%& option on the transport;
18276 .next
18277 The &%transport_home_directory%& option on the router;
18278 .next
18279 The password data if &%check_local_user%& is set on the router;
18280 .next
18281 The &%router_home_directory%& option on the router.
18282 .endlist
18283
18284 In other words, &%router_home_directory%& overrides the password data for the
18285 router, but not for the transport.
18286
18287
18288
18289 .option self routers string freeze
18290 .cindex "MX record" "pointing to local host"
18291 .cindex "local host" "MX pointing to"
18292 This option applies to those routers that use a recipient address to find a
18293 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18294 and &(manualroute)& routers.
18295 Certain configurations of the &(queryprogram)& router can also specify a list
18296 of remote hosts.
18297 Usually such routers are configured to send the message to a remote host via an
18298 &(smtp)& transport. The &%self%& option specifies what happens when the first
18299 host on the list turns out to be the local host.
18300 The way in which Exim checks for the local host is described in section
18301 &<<SECTreclocipadd>>&.
18302
18303 Normally this situation indicates either an error in Exim's configuration (for
18304 example, the router should be configured not to process this domain), or an
18305 error in the DNS (for example, the MX should not point to this host). For this
18306 reason, the default action is to log the incident, defer the address, and
18307 freeze the message. The following alternatives are provided for use in special
18308 cases:
18309
18310 .vlist
18311 .vitem &%defer%&
18312 Delivery of the message is tried again later, but the message is not frozen.
18313
18314 .vitem "&%reroute%&: <&'domain'&>"
18315 The domain is changed to the given domain, and the address is passed back to
18316 be reprocessed by the routers. No rewriting of headers takes place. This
18317 behaviour is essentially a redirection.
18318
18319 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18320 The domain is changed to the given domain, and the address is passed back to be
18321 reprocessed by the routers. Any headers that contain the original domain are
18322 rewritten.
18323
18324 .vitem &%pass%&
18325 .oindex "&%more%&"
18326 .vindex "&$self_hostname$&"
18327 The router passes the address to the next router, or to the router named in the
18328 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18329 subsequent routing and delivery, the variable &$self_hostname$& contains the
18330 name of the local host that the router encountered. This can be used to
18331 distinguish between different cases for hosts with multiple names. The
18332 combination
18333 .code
18334 self = pass
18335 no_more
18336 .endd
18337 ensures that only those addresses that routed to the local host are passed on.
18338 Without &%no_more%&, addresses that were declined for other reasons would also
18339 be passed to the next router.
18340
18341 .vitem &%fail%&
18342 Delivery fails and an error report is generated.
18343
18344 .vitem &%send%&
18345 .cindex "local host" "sending to"
18346 The anomaly is ignored and the address is queued for the transport. This
18347 setting should be used with extreme caution. For an &(smtp)& transport, it
18348 makes sense only in cases where the program that is listening on the SMTP port
18349 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18350 different configuration file that handles the domain in another way.
18351 .endlist
18352
18353
18354
18355 .option senders routers&!? "address list&!!" unset
18356 .cindex "router" "checking senders"
18357 If this option is set, the router is skipped unless the message's sender
18358 address matches something on the list.
18359 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18360 are evaluated.
18361
18362 There are issues concerning verification when the running of routers is
18363 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18364 setting, it sets the sender to the null string. When using the &%-bt%& option
18365 to check a configuration file, it is necessary also to use the &%-f%& option to
18366 set an appropriate sender. For incoming mail, the sender is unset when
18367 verifying the sender, but is available when verifying any recipients. If the
18368 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18369 matters.
18370
18371
18372 .option translate_ip_address routers string&!! unset
18373 .cindex "IP address" "translating"
18374 .cindex "packet radio"
18375 .cindex "router" "IP address translation"
18376 There exist some rare networking situations (for example, packet radio) where
18377 it is helpful to be able to translate IP addresses generated by normal routing
18378 mechanisms into other IP addresses, thus performing a kind of manual IP
18379 routing. This should be done only if the normal IP routing of the TCP/IP stack
18380 is inadequate or broken. Because this is an extremely uncommon requirement, the
18381 code to support this option is not included in the Exim binary unless
18382 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18383
18384 .vindex "&$host_address$&"
18385 The &%translate_ip_address%& string is expanded for every IP address generated
18386 by the router, with the generated address set in &$host_address$&. If the
18387 expansion is forced to fail, no action is taken.
18388 For any other expansion error, delivery of the message is deferred.
18389 If the result of the expansion is an IP address, that replaces the original
18390 address; otherwise the result is assumed to be a host name &-- this is looked
18391 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18392 produce one or more replacement IP addresses. For example, to subvert all IP
18393 addresses in some specific networks, this could be added to a router:
18394 .code
18395 translate_ip_address = \
18396   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18397     {$value}fail}}
18398 .endd
18399 The file would contain lines like
18400 .code
18401 10.2.3.128/26    some.host
18402 10.8.4.34/26     10.44.8.15
18403 .endd
18404 You should not make use of this facility unless you really understand what you
18405 are doing.
18406
18407
18408
18409 .option transport routers string&!! unset
18410 This option specifies the transport to be used when a router accepts an address
18411 and sets it up for delivery. A transport is never needed if a router is used
18412 only for verification. The value of the option is expanded at routing time,
18413 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18414 and result must be the name of one of the configured transports. If it is not,
18415 delivery is deferred.
18416
18417 The &%transport%& option is not used by the &(redirect)& router, but it does
18418 have some private options that set up transports for pipe and file deliveries
18419 (see chapter &<<CHAPredirect>>&).
18420
18421
18422
18423 .option transport_current_directory routers string&!! unset
18424 .cindex "current directory for local transport"
18425 This option associates a current directory with any address that is routed
18426 to a local transport. This can happen either because a transport is
18427 explicitly configured for the router, or because it generates a delivery to a
18428 file or a pipe. During the delivery process (that is, at transport time), this
18429 option string is expanded and is set as the current directory, unless
18430 overridden by a setting on the transport.
18431 If the expansion fails for any reason, including forced failure, an error is
18432 logged, and delivery is deferred.
18433 See chapter &<<CHAPenvironment>>& for details of the local delivery
18434 environment.
18435
18436
18437
18438
18439 .option transport_home_directory routers string&!! "see below"
18440 .cindex "home directory" "for local transport"
18441 This option associates a home directory with any address that is routed to a
18442 local transport. This can happen either because a transport is explicitly
18443 configured for the router, or because it generates a delivery to a file or a
18444 pipe. During the delivery process (that is, at transport time), the option
18445 string is expanded and is set as the home directory, unless overridden by a
18446 setting of &%home_directory%& on the transport.
18447 If the expansion fails for any reason, including forced failure, an error is
18448 logged, and delivery is deferred.
18449
18450 If the transport does not specify a home directory, and
18451 &%transport_home_directory%& is not set for the router, the home directory for
18452 the transport is taken from the password data if &%check_local_user%& is set for
18453 the router. Otherwise it is taken from &%router_home_directory%& if that option
18454 is set; if not, no home directory is set for the transport.
18455
18456 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18457 environment.
18458
18459
18460
18461
18462 .option unseen routers boolean&!! false
18463 .cindex "router" "carrying on after success"
18464 The result of string expansion for this option must be a valid boolean value,
18465 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18466 result causes an error, and delivery is deferred. If the expansion is forced to
18467 fail, the default value for the option (false) is used. Other failures cause
18468 delivery to be deferred.
18469
18470 When this option is set true, routing does not cease if the router accepts the
18471 address. Instead, a copy of the incoming address is passed to the next router,
18472 overriding a false setting of &%more%&. There is little point in setting
18473 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18474 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18475 sometimes true and sometimes false).
18476
18477 .cindex "copy of message (&%unseen%& option)"
18478 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18479 qualifier in filter files. It can be used to cause copies of messages to be
18480 delivered to some other destination, while also carrying out a normal delivery.
18481 In effect, the current address is made into a &"parent"& that has two children
18482 &-- one that is delivered as specified by this router, and a clone that goes on
18483 to be routed further. For this reason, &%unseen%& may not be combined with the
18484 &%one_time%& option in a &(redirect)& router.
18485
18486 &*Warning*&: Header lines added to the address (or specified for removal) by
18487 this router or by previous routers affect the &"unseen"& copy of the message
18488 only. The clone that continues to be processed by further routers starts with
18489 no added headers and none specified for removal. For a &%redirect%& router, if
18490 a generated address is the same as the incoming address, this can lead to
18491 duplicate addresses with different header modifications. Exim does not do
18492 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18493 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18494 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18495 &%redirect%& router may be of help.
18496
18497 Unlike the handling of header modifications, any data that was set by the
18498 &%address_data%& option in the current or previous routers &'is'& passed on to
18499 subsequent routers.
18500
18501
18502 .option user routers string&!! "see below"
18503 .cindex "uid (user id)" "local delivery"
18504 .cindex "local transports" "uid and gid"
18505 .cindex "transport" "local"
18506 .cindex "router" "user for filter processing"
18507 .cindex "filter" "user for processing"
18508 When a router queues an address for a transport, and the transport does not
18509 specify a user, the user given here is used when running the delivery process.
18510 The user may be specified numerically or by name. If expansion fails, the
18511 error is logged and delivery is deferred.
18512 This user is also used by the &(redirect)& router when running a filter file.
18513 The default is unset, except when &%check_local_user%& is set. In this case,
18514 the default is taken from the password information. If the user is specified as
18515 a name, and &%group%& is not set, the group associated with the user is used.
18516 See also &%initgroups%& and &%group%& and the discussion in chapter
18517 &<<CHAPenvironment>>&.
18518
18519
18520
18521 .option verify routers&!? boolean true
18522 Setting this option has the effect of setting &%verify_sender%& and
18523 &%verify_recipient%& to the same value.
18524
18525
18526 .option verify_only routers&!? boolean false
18527 .cindex "EXPN" "with &%verify_only%&"
18528 .oindex "&%-bv%&"
18529 .cindex "router" "used only when verifying"
18530 If this option is set, the router is used only when verifying an address,
18531 delivering in cutthrough mode or
18532 testing with the &%-bv%& option, not when actually doing a delivery, testing
18533 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18534 restricted to verifying only senders or recipients by means of
18535 &%verify_sender%& and &%verify_recipient%&.
18536
18537 &*Warning*&: When the router is being run to verify addresses for an incoming
18538 SMTP message, Exim is not running as root, but under its own uid. If the router
18539 accesses any files, you need to make sure that they are accessible to the Exim
18540 user or group.
18541
18542
18543 .option verify_recipient routers&!? boolean true
18544 If this option is false, the router is skipped when verifying recipient
18545 addresses,
18546 delivering in cutthrough mode
18547 or testing recipient verification using &%-bv%&.
18548 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18549 are evaluated.
18550 See also the &$verify_mode$& variable.
18551
18552
18553 .option verify_sender routers&!? boolean true
18554 If this option is false, the router is skipped when verifying sender addresses
18555 or testing sender verification using &%-bvs%&.
18556 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18557 are evaluated.
18558 See also the &$verify_mode$& variable.
18559 .ecindex IIDgenoprou1
18560 .ecindex IIDgenoprou2
18561
18562
18563
18564
18565
18566
18567 . ////////////////////////////////////////////////////////////////////////////
18568 . ////////////////////////////////////////////////////////////////////////////
18569
18570 .chapter "The accept router" "CHID4"
18571 .cindex "&(accept)& router"
18572 .cindex "routers" "&(accept)&"
18573 The &(accept)& router has no private options of its own. Unless it is being
18574 used purely for verification (see &%verify_only%&) a transport is required to
18575 be defined by the generic &%transport%& option. If the preconditions that are
18576 specified by generic options are met, the router accepts the address and queues
18577 it for the given transport. The most common use of this router is for setting
18578 up deliveries to local mailboxes. For example:
18579 .code
18580 localusers:
18581   driver = accept
18582   domains = mydomain.example
18583   check_local_user
18584   transport = local_delivery
18585 .endd
18586 The &%domains%& condition in this example checks the domain of the address, and
18587 &%check_local_user%& checks that the local part is the login of a local user.
18588 When both preconditions are met, the &(accept)& router runs, and queues the
18589 address for the &(local_delivery)& transport.
18590
18591
18592
18593
18594
18595
18596 . ////////////////////////////////////////////////////////////////////////////
18597 . ////////////////////////////////////////////////////////////////////////////
18598
18599 .chapter "The dnslookup router" "CHAPdnslookup"
18600 .scindex IIDdnsrou1 "&(dnslookup)& router"
18601 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18602 The &(dnslookup)& router looks up the hosts that handle mail for the
18603 recipient's domain in the DNS. A transport must always be set for this router,
18604 unless &%verify_only%& is set.
18605
18606 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18607 SRV records. If none are found, or if SRV support is not configured,
18608 MX records are looked up. If no MX records exist, address records are sought.
18609 However, &%mx_domains%& can be set to disable the direct use of address
18610 records.
18611
18612 MX records of equal priority are sorted by Exim into a random order. Exim then
18613 looks for address records for the host names obtained from MX or SRV records.
18614 When a host has more than one IP address, they are sorted into a random order,
18615 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18616 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18617 generic option, the router declines.
18618
18619 Unless they have the highest priority (lowest MX value), MX records that point
18620 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18621 are discarded, together with any other MX records of equal or lower priority.
18622
18623 .cindex "MX record" "pointing to local host"
18624 .cindex "local host" "MX pointing to"
18625 .oindex "&%self%&" "in &(dnslookup)& router"
18626 If the host pointed to by the highest priority MX record, or looked up as an
18627 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18628 happens is controlled by the generic &%self%& option.
18629
18630
18631 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18632 There have been problems with DNS servers when SRV records are looked up.
18633 Some misbehaving servers return a DNS error or timeout when a non-existent
18634 SRV record is sought. Similar problems have in the past been reported for
18635 MX records. The global &%dns_again_means_nonexist%& option can help with this
18636 problem, but it is heavy-handed because it is a global option.
18637
18638 For this reason, there are two options, &%srv_fail_domains%& and
18639 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18640 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18641 an attempt to look up an SRV or MX record causes one of these results, and the
18642 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18643 such record"&. In the case of an SRV lookup, this means that the router
18644 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18645 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18646 case routing fails.
18647
18648
18649 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18650 .cindex "&(dnslookup)& router" "declines"
18651 There are a few cases where a &(dnslookup)& router will decline to accept
18652 an address; if such a router is expected to handle "all remaining non-local
18653 domains", then it is important to set &%no_more%&.
18654
18655 The router will defer rather than decline if the domain
18656 is found in the &%fail_defer_domains%& router option.
18657
18658 Reasons for a &(dnslookup)& router to decline currently include:
18659 .ilist
18660 The domain does not exist in DNS
18661 .next
18662 The domain exists but the MX record's host part is just "."; this is a common
18663 convention (borrowed from SRV) used to indicate that there is no such service
18664 for this domain and to not fall back to trying A/AAAA records.
18665 .next
18666 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18667 .next
18668 MX record points to a non-existent host.
18669 .next
18670 MX record points to an IP address and the main section option
18671 &%allow_mx_to_ip%& is not set.
18672 .next
18673 MX records exist and point to valid hosts, but all hosts resolve only to
18674 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18675 .next
18676 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18677 &%dns_check_names_pattern%& for handling one variant of this)
18678 .next
18679 &%check_secondary_mx%& is set on this router but the local host can
18680 not be found in the MX records (see below)
18681 .endlist
18682
18683
18684
18685
18686 .section "Private options for dnslookup" "SECID118"
18687 .cindex "options" "&(dnslookup)& router"
18688 The private options for the &(dnslookup)& router are as follows:
18689
18690 .option check_secondary_mx dnslookup boolean false
18691 .cindex "MX record" "checking for secondary"
18692 If this option is set, the router declines unless the local host is found in
18693 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18694 process domains for which the local host is a secondary mail exchanger
18695 differently to other domains. The way in which Exim decides whether a host is
18696 the local host is described in section &<<SECTreclocipadd>>&.
18697
18698
18699 .option check_srv dnslookup string&!! unset
18700 .cindex "SRV record" "enabling use of"
18701 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18702 addition to MX and address records. The support is disabled by default. To
18703 enable SRV support, set the &%check_srv%& option to the name of the service
18704 required. For example,
18705 .code
18706 check_srv = smtp
18707 .endd
18708 looks for SRV records that refer to the normal smtp service. The option is
18709 expanded, so the service name can vary from message to message or address
18710 to address. This might be helpful if SRV records are being used for a
18711 submission service. If the expansion is forced to fail, the &%check_srv%&
18712 option is ignored, and the router proceeds to look for MX records in the
18713 normal way.
18714
18715 When the expansion succeeds, the router searches first for SRV records for
18716 the given service (it assumes TCP protocol). A single SRV record with a
18717 host name that consists of just a single dot indicates &"no such service for
18718 this domain"&; if this is encountered, the router declines. If other kinds of
18719 SRV record are found, they are used to construct a host list for delivery
18720 according to the rules of RFC 2782. MX records are not sought in this case.
18721
18722 When no SRV records are found, MX records (and address records) are sought in
18723 the traditional way. In other words, SRV records take precedence over MX
18724 records, just as MX records take precedence over address records. Note that
18725 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18726 defined it. It is apparently believed that MX records are sufficient for email
18727 and that SRV records should not be used for this purpose. However, SRV records
18728 have an additional &"weight"& feature which some people might find useful when
18729 trying to split an SMTP load between hosts of different power.
18730
18731 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18732 when there is a DNS lookup error.
18733
18734
18735
18736
18737 .option fail_defer_domains dnslookup "domain list&!!" unset
18738 .cindex "MX record" "not found"
18739 DNS lookups for domains matching &%fail_defer_domains%&
18740 which find no matching record will cause the router to defer
18741 rather than the default behaviour of decline.
18742 This maybe be useful for queueing messages for a newly created
18743 domain while the DNS configuration is not ready.
18744 However, it will result in any message with mistyped domains
18745 also being queued.
18746
18747
18748 .option mx_domains dnslookup "domain list&!!" unset
18749 .cindex "MX record" "required to exist"
18750 .cindex "SRV record" "required to exist"
18751 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18752 record in order to be recognized. (The name of this option could be improved.)
18753 For example, if all the mail hosts in &'fict.example'& are known to have MX
18754 records, except for those in &'discworld.fict.example'&, you could use this
18755 setting:
18756 .code
18757 mx_domains = ! *.discworld.fict.example : *.fict.example
18758 .endd
18759 This specifies that messages addressed to a domain that matches the list but
18760 has no MX record should be bounced immediately instead of being routed using
18761 the address record.
18762
18763
18764 .option mx_fail_domains dnslookup "domain list&!!" unset
18765 If the DNS lookup for MX records for one of the domains in this list causes a
18766 DNS lookup error, Exim behaves as if no MX records were found. See section
18767 &<<SECTprowitdnsloo>>& for more discussion.
18768
18769
18770
18771
18772 .option qualify_single dnslookup boolean true
18773 .cindex "DNS" "resolver options"
18774 .cindex "DNS" "qualifying single-component names"
18775 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18776 lookups. Typically, but not standardly, this causes the resolver to qualify
18777 single-component names with the default domain. For example, on a machine
18778 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18779 &'thesaurus.ref.example'& inside the resolver. For details of what your
18780 resolver actually does, consult your man pages for &'resolver'& and
18781 &'resolv.conf'&.
18782
18783
18784
18785 .option rewrite_headers dnslookup boolean true
18786 .cindex "rewriting" "header lines"
18787 .cindex "header lines" "rewriting"
18788 If the domain name in the address that is being processed is not fully
18789 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18790 an address is specified as &'dormouse@teaparty'&, the domain might be
18791 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18792 occur as a result of setting the &%widen_domains%& option. If
18793 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18794 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18795 header lines of the message are rewritten with the full domain name.
18796
18797 This option should be turned off only when it is known that no message is
18798 ever going to be sent outside an environment where the abbreviation makes
18799 sense.
18800
18801 When an MX record is looked up in the DNS and matches a wildcard record, name
18802 servers normally return a record containing the name that has been looked up,
18803 making it impossible to detect whether a wildcard was present or not. However,
18804 some name servers have recently been seen to return the wildcard entry. If the
18805 name returned by a DNS lookup begins with an asterisk, it is not used for
18806 header rewriting.
18807
18808
18809 .option same_domain_copy_routing dnslookup boolean false
18810 .cindex "address" "copying routing"
18811 Addresses with the same domain are normally routed by the &(dnslookup)& router
18812 to the same list of hosts. However, this cannot be presumed, because the router
18813 options and preconditions may refer to the local part of the address. By
18814 default, therefore, Exim routes each address in a message independently. DNS
18815 servers run caches, so repeated DNS lookups are not normally expensive, and in
18816 any case, personal messages rarely have more than a few recipients.
18817
18818 If you are running mailing lists with large numbers of subscribers at the same
18819 domain, and you are using a &(dnslookup)& router which is independent of the
18820 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18821 lookups for identical domains in one message. In this case, when &(dnslookup)&
18822 routes an address to a remote transport, any other unrouted addresses in the
18823 message that have the same domain are automatically given the same routing
18824 without processing them independently,
18825 provided the following conditions are met:
18826
18827 .ilist
18828 No router that processed the address specified &%headers_add%& or
18829 &%headers_remove%&.
18830 .next
18831 The router did not change the address in any way, for example, by &"widening"&
18832 the domain.
18833 .endlist
18834
18835
18836
18837
18838 .option search_parents dnslookup boolean false
18839 .cindex "DNS" "resolver options"
18840 When this option is true, the resolver option RES_DNSRCH is set for DNS
18841 lookups. This is different from the &%qualify_single%& option in that it
18842 applies to domains containing dots. Typically, but not standardly, it causes
18843 the resolver to search for the name in the current domain and in parent
18844 domains. For example, on a machine in the &'fict.example'& domain, if looking
18845 up &'teaparty.wonderland'& failed, the resolver would try
18846 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18847 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18848
18849 Setting this option true can cause problems in domains that have a wildcard MX
18850 record, because any domain that does not have its own MX record matches the
18851 local wildcard.
18852
18853
18854
18855 .option srv_fail_domains dnslookup "domain list&!!" unset
18856 If the DNS lookup for SRV records for one of the domains in this list causes a
18857 DNS lookup error, Exim behaves as if no SRV records were found. See section
18858 &<<SECTprowitdnsloo>>& for more discussion.
18859
18860
18861
18862
18863 .option widen_domains dnslookup "string list" unset
18864 .cindex "domain" "partial; widening"
18865 If a DNS lookup fails and this option is set, each of its strings in turn is
18866 added onto the end of the domain, and the lookup is tried again. For example,
18867 if
18868 .code
18869 widen_domains = fict.example:ref.example
18870 .endd
18871 is set and a lookup of &'klingon.dictionary'& fails,
18872 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18873 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18874 and &%search_parents%& options can cause some widening to be undertaken inside
18875 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18876 when verifying, unless &%rewrite_headers%& is false (not the default).
18877
18878
18879 .section "Effect of qualify_single and search_parents" "SECID119"
18880 When a domain from an envelope recipient is changed by the resolver as a result
18881 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18882 corresponding address in the message's header lines unless &%rewrite_headers%&
18883 is set false. Exim then re-routes the address, using the full domain.
18884
18885 These two options affect only the DNS lookup that takes place inside the router
18886 for the domain of the address that is being routed. They do not affect lookups
18887 such as that implied by
18888 .code
18889 domains = @mx_any
18890 .endd
18891 that may happen while processing a router precondition before the router is
18892 entered. No widening ever takes place for these lookups.
18893 .ecindex IIDdnsrou1
18894 .ecindex IIDdnsrou2
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904 . ////////////////////////////////////////////////////////////////////////////
18905 . ////////////////////////////////////////////////////////////////////////////
18906
18907 .chapter "The ipliteral router" "CHID5"
18908 .cindex "&(ipliteral)& router"
18909 .cindex "domain literal" "routing"
18910 .cindex "routers" "&(ipliteral)&"
18911 This router has no private options. Unless it is being used purely for
18912 verification (see &%verify_only%&) a transport is required to be defined by the
18913 generic &%transport%& option. The router accepts the address if its domain part
18914 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18915 router handles the address
18916 .code
18917 root@[192.168.1.1]
18918 .endd
18919 by setting up delivery to the host with that IP address. IPv4 domain literals
18920 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18921 are similar, but the address is preceded by &`ipv6:`&. For example:
18922 .code
18923 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18924 .endd
18925 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18926 grounds that sooner or later somebody will try it.
18927
18928 .oindex "&%self%&" "in &(ipliteral)& router"
18929 If the IP address matches something in &%ignore_target_hosts%&, the router
18930 declines. If an IP literal turns out to refer to the local host, the generic
18931 &%self%& option determines what happens.
18932
18933 The RFCs require support for domain literals; however, their use is
18934 controversial in today's Internet. If you want to use this router, you must
18935 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18936 Exim will not recognize the domain literal syntax in addresses.
18937
18938
18939
18940 . ////////////////////////////////////////////////////////////////////////////
18941 . ////////////////////////////////////////////////////////////////////////////
18942
18943 .chapter "The iplookup router" "CHID6"
18944 .cindex "&(iplookup)& router"
18945 .cindex "routers" "&(iplookup)&"
18946 The &(iplookup)& router was written to fulfil a specific requirement in
18947 Cambridge University (which in fact no longer exists). For this reason, it is
18948 not included in the binary of Exim by default. If you want to include it, you
18949 must set
18950 .code
18951 ROUTER_IPLOOKUP=yes
18952 .endd
18953 in your &_Local/Makefile_& configuration file.
18954
18955 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18956 connection to one or more specific hosts. The host can then return the same or
18957 a different address &-- in effect rewriting the recipient address in the
18958 message's envelope. The new address is then passed on to subsequent routers. If
18959 this process fails, the address can be passed on to other routers, or delivery
18960 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18961 must not be specified for it.
18962
18963 .cindex "options" "&(iplookup)& router"
18964 .option hosts iplookup string unset
18965 This option must be supplied. Its value is a colon-separated list of host
18966 names. The hosts are looked up using &[gethostbyname()]&
18967 (or &[getipnodebyname()]& when available)
18968 and are tried in order until one responds to the query. If none respond, what
18969 happens is controlled by &%optional%&.
18970
18971
18972 .option optional iplookup boolean false
18973 If &%optional%& is true, if no response is obtained from any host, the address
18974 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18975 delivery to the address is deferred.
18976
18977
18978 .option port iplookup integer 0
18979 .cindex "port" "&(iplookup)& router"
18980 This option must be supplied. It specifies the port number for the TCP or UDP
18981 call.
18982
18983
18984 .option protocol iplookup string udp
18985 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18986 protocols is to be used.
18987
18988
18989 .option query iplookup string&!! "see below"
18990 This defines the content of the query that is sent to the remote hosts. The
18991 default value is:
18992 .code
18993 $local_part@$domain $local_part@$domain
18994 .endd
18995 The repetition serves as a way of checking that a response is to the correct
18996 query in the default case (see &%response_pattern%& below).
18997
18998
18999 .option reroute iplookup string&!! unset
19000 If this option is not set, the rerouted address is precisely the byte string
19001 returned by the remote host, up to the first white space, if any. If set, the
19002 string is expanded to form the rerouted address. It can include parts matched
19003 in the response by &%response_pattern%& by means of numeric variables such as
19004 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19005 whether or not a pattern is in use. In all cases, the rerouted address must end
19006 up in the form &'local_part@domain'&.
19007
19008
19009 .option response_pattern iplookup string unset
19010 This option can be set to a regular expression that is applied to the string
19011 returned from the remote host. If the pattern does not match the response, the
19012 router declines. If &%response_pattern%& is not set, no checking of the
19013 response is done, unless the query was defaulted, in which case there is a
19014 check that the text returned after the first white space is the original
19015 address. This checks that the answer that has been received is in response to
19016 the correct question. For example, if the response is just a new domain, the
19017 following could be used:
19018 .code
19019 response_pattern = ^([^@]+)$
19020 reroute = $local_part@$1
19021 .endd
19022
19023 .option timeout iplookup time 5s
19024 This specifies the amount of time to wait for a response from the remote
19025 machine. The same timeout is used for the &[connect()]& function for a TCP
19026 call. It does not apply to UDP.
19027
19028
19029
19030
19031 . ////////////////////////////////////////////////////////////////////////////
19032 . ////////////////////////////////////////////////////////////////////////////
19033
19034 .chapter "The manualroute router" "CHID7"
19035 .scindex IIDmanrou1 "&(manualroute)& router"
19036 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19037 .cindex "domain" "manually routing"
19038 The &(manualroute)& router is so-called because it provides a way of manually
19039 routing an address according to its domain. It is mainly used when you want to
19040 route addresses to remote hosts according to your own rules, bypassing the
19041 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19042 route to local transports, a facility that may be useful if you want to save
19043 messages for dial-in hosts in local files.
19044
19045 The &(manualroute)& router compares a list of domain patterns with the domain
19046 it is trying to route. If there is no match, the router declines. Each pattern
19047 has associated with it a list of hosts and some other optional data, which may
19048 include a transport. The combination of a pattern and its data is called a
19049 &"routing rule"&. For patterns that do not have an associated transport, the
19050 generic &%transport%& option must specify a transport, unless the router is
19051 being used purely for verification (see &%verify_only%&).
19052
19053 .vindex "&$host$&"
19054 In the case of verification, matching the domain pattern is sufficient for the
19055 router to accept the address. When actually routing an address for delivery,
19056 an address that matches a domain pattern is queued for the associated
19057 transport. If the transport is not a local one, a host list must be associated
19058 with the pattern; IP addresses are looked up for the hosts, and these are
19059 passed to the transport along with the mail address. For local transports, a
19060 host list is optional. If it is present, it is passed in &$host$& as a single
19061 text string.
19062
19063 The list of routing rules can be provided as an inline string in
19064 &%route_list%&, or the data can be obtained by looking up the domain in a file
19065 or database by setting &%route_data%&. Only one of these settings may appear in
19066 any one instance of &(manualroute)&. The format of routing rules is described
19067 below, following the list of private options.
19068
19069
19070 .section "Private options for manualroute" "SECTprioptman"
19071
19072 .cindex "options" "&(manualroute)& router"
19073 The private options for the &(manualroute)& router are as follows:
19074
19075 .option host_all_ignored manualroute string defer
19076 See &%host_find_failed%&.
19077
19078 .option host_find_failed manualroute string freeze
19079 This option controls what happens when &(manualroute)& tries to find an IP
19080 address for a host, and the host does not exist. The option can be set to one
19081 of the following values:
19082 .code
19083 decline
19084 defer
19085 fail
19086 freeze
19087 ignore
19088 pass
19089 .endd
19090 The default (&"freeze"&) assumes that this state is a serious configuration
19091 error. The difference between &"pass"& and &"decline"& is that the former
19092 forces the address to be passed to the next router (or the router defined by
19093 &%pass_router%&),
19094 .oindex "&%more%&"
19095 overriding &%no_more%&, whereas the latter passes the address to the next
19096 router only if &%more%& is true.
19097
19098 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19099 cannot be found. If all the hosts in the list are ignored, the behaviour is
19100 controlled by the &%host_all_ignored%& option. This takes the same values
19101 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19102
19103 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19104 state; if a host lookup gets a temporary error, delivery is deferred unless the
19105 generic &%pass_on_timeout%& option is set.
19106
19107
19108 .option hosts_randomize manualroute boolean false
19109 .cindex "randomized host list"
19110 .cindex "host" "list of; randomized"
19111 If this option is set, the order of the items in a host list in a routing rule
19112 is randomized each time the list is used, unless an option in the routing rule
19113 overrides (see below). Randomizing the order of a host list can be used to do
19114 crude load sharing. However, if more than one mail address is routed by the
19115 same router to the same host list, the host lists are considered to be the same
19116 (even though they may be randomized into different orders) for the purpose of
19117 deciding whether to batch the deliveries into a single SMTP transaction.
19118
19119 When &%hosts_randomize%& is true, a host list may be split
19120 into groups whose order is separately randomized. This makes it possible to
19121 set up MX-like behaviour. The boundaries between groups are indicated by an
19122 item that is just &`+`& in the host list. For example:
19123 .code
19124 route_list = * host1:host2:host3:+:host4:host5
19125 .endd
19126 The order of the first three hosts and the order of the last two hosts is
19127 randomized for each use, but the first three always end up before the last two.
19128 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19129 randomized host list is passed to an &(smtp)& transport that also has
19130 &%hosts_randomize set%&, the list is not re-randomized.
19131
19132
19133 .option route_data manualroute string&!! unset
19134 If this option is set, it must expand to yield the data part of a routing rule.
19135 Typically, the expansion string includes a lookup based on the domain. For
19136 example:
19137 .code
19138 route_data = ${lookup{$domain}dbm{/etc/routes}}
19139 .endd
19140 If the expansion is forced to fail, or the result is an empty string, the
19141 router declines. Other kinds of expansion failure cause delivery to be
19142 deferred.
19143
19144
19145 .option route_list manualroute "string list" unset
19146 This string is a list of routing rules, in the form defined below. Note that,
19147 unlike most string lists, the items are separated by semicolons. This is so
19148 that they may contain colon-separated host lists.
19149
19150
19151 .option same_domain_copy_routing manualroute boolean false
19152 .cindex "address" "copying routing"
19153 Addresses with the same domain are normally routed by the &(manualroute)&
19154 router to the same list of hosts. However, this cannot be presumed, because the
19155 router options and preconditions may refer to the local part of the address. By
19156 default, therefore, Exim routes each address in a message independently. DNS
19157 servers run caches, so repeated DNS lookups are not normally expensive, and in
19158 any case, personal messages rarely have more than a few recipients.
19159
19160 If you are running mailing lists with large numbers of subscribers at the same
19161 domain, and you are using a &(manualroute)& router which is independent of the
19162 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19163 lookups for identical domains in one message. In this case, when
19164 &(manualroute)& routes an address to a remote transport, any other unrouted
19165 addresses in the message that have the same domain are automatically given the
19166 same routing without processing them independently. However, this is only done
19167 if &%headers_add%& and &%headers_remove%& are unset.
19168
19169
19170
19171
19172 .section "Routing rules in route_list" "SECID120"
19173 The value of &%route_list%& is a string consisting of a sequence of routing
19174 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19175 entered as two semicolons. Alternatively, the list separator can be changed as
19176 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19177 Empty rules are ignored. The format of each rule is
19178 .display
19179 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19180 .endd
19181 The following example contains two rules, each with a simple domain pattern and
19182 no options:
19183 .code
19184 route_list = \
19185   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19186   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19187 .endd
19188 The three parts of a rule are separated by white space. The pattern and the
19189 list of hosts can be enclosed in quotes if necessary, and if they are, the
19190 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19191 single domain pattern, which is the only mandatory item in the rule. The
19192 pattern is in the same format as one item in a domain list (see section
19193 &<<SECTdomainlist>>&),
19194 except that it may not be the name of an interpolated file.
19195 That is, it may be wildcarded, or a regular expression, or a file or database
19196 lookup (with semicolons doubled, because of the use of semicolon as a separator
19197 in a &%route_list%&).
19198
19199 The rules in &%route_list%& are searched in order until one of the patterns
19200 matches the domain that is being routed. The list of hosts and then options are
19201 then used as described below. If there is no match, the router declines. When
19202 &%route_list%& is set, &%route_data%& must not be set.
19203
19204
19205
19206 .section "Routing rules in route_data" "SECID121"
19207 The use of &%route_list%& is convenient when there are only a small number of
19208 routing rules. For larger numbers, it is easier to use a file or database to
19209 hold the routing information, and use the &%route_data%& option instead.
19210 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19211 Most commonly, &%route_data%& is set as a string that contains an
19212 expansion lookup. For example, suppose we place two routing rules in a file
19213 like this:
19214 .code
19215 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19216 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19217 .endd
19218 This data can be accessed by setting
19219 .code
19220 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19221 .endd
19222 Failure of the lookup results in an empty string, causing the router to
19223 decline. However, you do not have to use a lookup in &%route_data%&. The only
19224 requirement is that the result of expanding the string is a list of hosts,
19225 possibly followed by options, separated by white space. The list of hosts must
19226 be enclosed in quotes if it contains white space.
19227
19228
19229
19230
19231 .section "Format of the list of hosts" "SECID122"
19232 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19233 always separately expanded before use. If the expansion fails, the router
19234 declines. The result of the expansion must be a colon-separated list of names
19235 and/or IP addresses, optionally also including ports. The format of each item
19236 in the list is described in the next section. The list separator can be changed
19237 as described in section &<<SECTlistconstruct>>&.
19238
19239 If the list of hosts was obtained from a &%route_list%& item, the following
19240 variables are set during its expansion:
19241
19242 .ilist
19243 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19244 If the domain was matched against a regular expression, the numeric variables
19245 &$1$&, &$2$&, etc. may be set. For example:
19246 .code
19247 route_list = ^domain(\d+)   host-$1.text.example
19248 .endd
19249 .next
19250 &$0$& is always set to the entire domain.
19251 .next
19252 &$1$& is also set when partial matching is done in a file lookup.
19253
19254 .next
19255 .vindex "&$value$&"
19256 If the pattern that matched the domain was a lookup item, the data that was
19257 looked up is available in the expansion variable &$value$&. For example:
19258 .code
19259 route_list = lsearch;;/some/file.routes  $value
19260 .endd
19261 .endlist
19262
19263 Note the doubling of the semicolon in the pattern that is necessary because
19264 semicolon is the default route list separator.
19265
19266
19267
19268 .section "Format of one host item" "SECTformatonehostitem"
19269 Each item in the list of hosts is either a host name or an IP address,
19270 optionally with an attached port number. When no port is given, an IP address
19271 is not enclosed in brackets. When a port is specified, it overrides the port
19272 specification on the transport. The port is separated from the name or address
19273 by a colon. This leads to some complications:
19274
19275 .ilist
19276 Because colon is the default separator for the list of hosts, either
19277 the colon that specifies a port must be doubled, or the list separator must
19278 be changed. The following two examples have the same effect:
19279 .code
19280 route_list = * "host1.tld::1225 : host2.tld::1226"
19281 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19282 .endd
19283 .next
19284 When IPv6 addresses are involved, it gets worse, because they contain
19285 colons of their own. To make this case easier, it is permitted to
19286 enclose an IP address (either v4 or v6) in square brackets if a port
19287 number follows. For example:
19288 .code
19289 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19290 .endd
19291 .endlist
19292
19293 .section "How the list of hosts is used" "SECThostshowused"
19294 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19295 the hosts is tried, in the order specified, when carrying out the SMTP
19296 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19297 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19298 transport.
19299
19300 Hosts may be listed by name or by IP address. An unadorned name in the list of
19301 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19302 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19303 records in the DNS. For example:
19304 .code
19305 route_list = *  x.y.z:p.q.r/MX:e.f.g
19306 .endd
19307 If this feature is used with a port specifier, the port must come last. For
19308 example:
19309 .code
19310 route_list = *  dom1.tld/mx::1225
19311 .endd
19312 If the &%hosts_randomize%& option is set, the order of the items in the list is
19313 randomized before any lookups are done. Exim then scans the list; for any name
19314 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19315 be an interface on the local host and the item is not the first in the list,
19316 Exim discards it and any subsequent items. If it is the first item, what
19317 happens is controlled by the
19318 .oindex "&%self%&" "in &(manualroute)& router"
19319 &%self%& option of the router.
19320
19321 A name on the list that is followed by &`/MX`& is replaced with the list of
19322 hosts obtained by looking up MX records for the name. This is always a DNS
19323 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19324 below) are not relevant here. The order of these hosts is determined by the
19325 preference values in the MX records, according to the usual rules. Because
19326 randomizing happens before the MX lookup, it does not affect the order that is
19327 defined by MX preferences.
19328
19329 If the local host is present in the sublist obtained from MX records, but is
19330 not the most preferred host in that list, it and any equally or less
19331 preferred hosts are removed before the sublist is inserted into the main list.
19332
19333 If the local host is the most preferred host in the MX list, what happens
19334 depends on where in the original list of hosts the &`/MX`& item appears. If it
19335 is not the first item (that is, there are previous hosts in the main list),
19336 Exim discards this name and any subsequent items in the main list.
19337
19338 If the MX item is first in the list of hosts, and the local host is the
19339 most preferred host, what happens is controlled by the &%self%& option of the
19340 router.
19341
19342 DNS failures when lookup up the MX records are treated in the same way as DNS
19343 failures when looking up IP addresses: &%pass_on_timeout%& and
19344 &%host_find_failed%& are used when relevant.
19345
19346 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19347 whether obtained from an MX lookup or not.
19348
19349
19350
19351 .section "How the options are used" "SECThowoptused"
19352 The options are a sequence of words; in practice no more than three are ever
19353 present. One of the words can be the name of a transport; this overrides the
19354 &%transport%& option on the router for this particular routing rule only. The
19355 other words (if present) control randomization of the list of hosts on a
19356 per-rule basis, and how the IP addresses of the hosts are to be found when
19357 routing to a remote transport. These options are as follows:
19358
19359 .ilist
19360 &%randomize%&: randomize the order of the hosts in this list, overriding the
19361 setting of &%hosts_randomize%& for this routing rule only.
19362 .next
19363 &%no_randomize%&: do not randomize the order of the hosts in this list,
19364 overriding the setting of &%hosts_randomize%& for this routing rule only.
19365 .next
19366 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19367 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19368 also look in &_/etc/hosts_& or other sources of information.
19369 .next
19370 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19371 no address records are found. If there is a temporary DNS error (such as a
19372 timeout), delivery is deferred.
19373 .endlist
19374
19375 For example:
19376 .code
19377 route_list = domain1  host1:host2:host3  randomize bydns;\
19378              domain2  host4:host5
19379 .endd
19380 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19381 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19382 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19383 or &[gethostbyname()]&, and the result of the lookup is the result of that
19384 call.
19385
19386 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19387 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19388 instead of TRY_AGAIN. That is why the default action is to try a DNS
19389 lookup first. Only if that gives a definite &"no such host"& is the local
19390 function called.
19391
19392
19393
19394 If no IP address for a host can be found, what happens is controlled by the
19395 &%host_find_failed%& option.
19396
19397 .vindex "&$host$&"
19398 When an address is routed to a local transport, IP addresses are not looked up.
19399 The host list is passed to the transport in the &$host$& variable.
19400
19401
19402
19403 .section "Manualroute examples" "SECID123"
19404 In some of the examples that follow, the presence of the &%remote_smtp%&
19405 transport, as defined in the default configuration file, is assumed:
19406
19407 .ilist
19408 .cindex "smart host" "example router"
19409 The &(manualroute)& router can be used to forward all external mail to a
19410 &'smart host'&. If you have set up, in the main part of the configuration, a
19411 named domain list that contains your local domains, for example:
19412 .code
19413 domainlist local_domains = my.domain.example
19414 .endd
19415 You can arrange for all other domains to be routed to a smart host by making
19416 your first router something like this:
19417 .code
19418 smart_route:
19419   driver = manualroute
19420   domains = !+local_domains
19421   transport = remote_smtp
19422   route_list = * smarthost.ref.example
19423 .endd
19424 This causes all non-local addresses to be sent to the single host
19425 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19426 they are tried in order
19427 (but you can use &%hosts_randomize%& to vary the order each time).
19428 Another way of configuring the same thing is this:
19429 .code
19430 smart_route:
19431   driver = manualroute
19432   transport = remote_smtp
19433   route_list = !+local_domains  smarthost.ref.example
19434 .endd
19435 There is no difference in behaviour between these two routers as they stand.
19436 However, they behave differently if &%no_more%& is added to them. In the first
19437 example, the router is skipped if the domain does not match the &%domains%&
19438 precondition; the following router is always tried. If the router runs, it
19439 always matches the domain and so can never decline. Therefore, &%no_more%&
19440 would have no effect. In the second case, the router is never skipped; it
19441 always runs. However, if it doesn't match the domain, it declines. In this case
19442 &%no_more%& would prevent subsequent routers from running.
19443
19444 .next
19445 .cindex "mail hub example"
19446 A &'mail hub'& is a host which receives mail for a number of domains via MX
19447 records in the DNS and delivers it via its own private routing mechanism. Often
19448 the final destinations are behind a firewall, with the mail hub being the one
19449 machine that can connect to machines both inside and outside the firewall. The
19450 &(manualroute)& router is usually used on a mail hub to route incoming messages
19451 to the correct hosts. For a small number of domains, the routing can be inline,
19452 using the &%route_list%& option, but for a larger number a file or database
19453 lookup is easier to manage.
19454
19455 If the domain names are in fact the names of the machines to which the mail is
19456 to be sent by the mail hub, the configuration can be quite simple. For
19457 example:
19458 .code
19459 hub_route:
19460   driver = manualroute
19461   transport = remote_smtp
19462   route_list = *.rhodes.tvs.example  $domain
19463 .endd
19464 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19465 whose names are the same as the mail domains. A similar approach can be taken
19466 if the host name can be obtained from the domain name by a string manipulation
19467 that the expansion facilities can handle. Otherwise, a lookup based on the
19468 domain can be used to find the host:
19469 .code
19470 through_firewall:
19471   driver = manualroute
19472   transport = remote_smtp
19473   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19474 .endd
19475 The result of the lookup must be the name or IP address of the host (or
19476 hosts) to which the address is to be routed. If the lookup fails, the route
19477 data is empty, causing the router to decline. The address then passes to the
19478 next router.
19479
19480 .next
19481 .cindex "batched SMTP output example"
19482 .cindex "SMTP" "batched outgoing; example"
19483 You can use &(manualroute)& to deliver messages to pipes or files in batched
19484 SMTP format for onward transportation by some other means. This is one way of
19485 storing mail for a dial-up host when it is not connected. The route list entry
19486 can be as simple as a single domain name in a configuration like this:
19487 .code
19488 save_in_file:
19489   driver = manualroute
19490   transport = batchsmtp_appendfile
19491   route_list = saved.domain.example
19492 .endd
19493 though often a pattern is used to pick up more than one domain. If there are
19494 several domains or groups of domains with different transport requirements,
19495 different transports can be listed in the routing information:
19496 .code
19497 save_in_file:
19498   driver = manualroute
19499   route_list = \
19500     *.saved.domain1.example  $domain  batch_appendfile; \
19501     *.saved.domain2.example  \
19502       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19503       batch_pipe
19504 .endd
19505 .vindex "&$domain$&"
19506 .vindex "&$host$&"
19507 The first of these just passes the domain in the &$host$& variable, which
19508 doesn't achieve much (since it is also in &$domain$&), but the second does a
19509 file lookup to find a value to pass, causing the router to decline to handle
19510 the address if the lookup fails.
19511
19512 .next
19513 .cindex "UUCP" "example of router for"
19514 Routing mail directly to UUCP software is a specific case of the use of
19515 &(manualroute)& in a gateway to another mail environment. This is an example of
19516 one way it can be done:
19517 .code
19518 # Transport
19519 uucp:
19520   driver = pipe
19521   user = nobody
19522   command = /usr/local/bin/uux -r - \
19523     ${substr_-5:$host}!rmail ${local_part}
19524   return_fail_output = true
19525
19526 # Router
19527 uucphost:
19528   transport = uucp
19529   driver = manualroute
19530   route_data = \
19531     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19532 .endd
19533 The file &_/usr/local/exim/uucphosts_& contains entries like
19534 .code
19535 darksite.ethereal.example:           darksite.UUCP
19536 .endd
19537 It can be set up more simply without adding and removing &".UUCP"& but this way
19538 makes clear the distinction between the domain name
19539 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19540 .endlist
19541 .ecindex IIDmanrou1
19542 .ecindex IIDmanrou2
19543
19544
19545
19546
19547
19548
19549
19550
19551 . ////////////////////////////////////////////////////////////////////////////
19552 . ////////////////////////////////////////////////////////////////////////////
19553
19554 .chapter "The queryprogram router" "CHAPdriverlast"
19555 .scindex IIDquerou1 "&(queryprogram)& router"
19556 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19557 .cindex "routing" "by external program"
19558 The &(queryprogram)& router routes an address by running an external command
19559 and acting on its output. This is an expensive way to route, and is intended
19560 mainly for use in lightly-loaded systems, or for performing experiments.
19561 However, if it is possible to use the precondition options (&%domains%&,
19562 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19563 be used in special cases, even on a busy host. There are the following private
19564 options:
19565 .cindex "options" "&(queryprogram)& router"
19566
19567 .option command queryprogram string&!! unset
19568 This option must be set. It specifies the command that is to be run. The
19569 command is split up into a command name and arguments, and then each is
19570 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19571 &<<CHAPpipetransport>>&).
19572
19573
19574 .option command_group queryprogram string unset
19575 .cindex "gid (group id)" "in &(queryprogram)& router"
19576 This option specifies a gid to be set when running the command while routing an
19577 address for deliver. It must be set if &%command_user%& specifies a numerical
19578 uid. If it begins with a digit, it is interpreted as the numerical value of the
19579 gid. Otherwise it is looked up using &[getgrnam()]&.
19580
19581
19582 .option command_user queryprogram string unset
19583 .cindex "uid (user id)" "for &(queryprogram)&"
19584 This option must be set. It specifies the uid which is set when running the
19585 command while routing an address for delivery. If the value begins with a digit,
19586 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19587 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19588 not set, a value for the gid also.
19589
19590 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19591 root, which it does during a normal delivery in a conventional configuration.
19592 However, when an address is being verified during message reception, Exim is
19593 usually running as the Exim user, not as root. If the &(queryprogram)& router
19594 is called from a non-root process, Exim cannot change uid or gid before running
19595 the command. In this circumstance the command runs under the current uid and
19596 gid.
19597
19598
19599 .option current_directory queryprogram string /
19600 This option specifies an absolute path which is made the current directory
19601 before running the command.
19602
19603
19604 .option timeout queryprogram time 1h
19605 If the command does not complete within the timeout period, its process group
19606 is killed and the message is frozen. A value of zero time specifies no
19607 timeout.
19608
19609
19610 The standard output of the command is connected to a pipe, which is read when
19611 the command terminates. It should consist of a single line of output,
19612 containing up to five fields, separated by white space. The maximum length of
19613 the line is 1023 characters. Longer lines are silently truncated. The first
19614 field is one of the following words (case-insensitive):
19615
19616 .ilist
19617 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19618 below).
19619 .next
19620 &'Decline'&: the router declines; pass the address to the next router, unless
19621 &%no_more%& is set.
19622 .next
19623 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19624 subsequent text on the line is an error message. If the router is run as part
19625 of address verification during an incoming SMTP message, the message is
19626 included in the SMTP response.
19627 .next
19628 &'Defer'&: routing could not be completed at this time; try again later. Any
19629 subsequent text on the line is an error message which is logged. It is not
19630 included in any SMTP response.
19631 .next
19632 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19633 .next
19634 &'Pass'&: pass the address to the next router (or the router specified by
19635 &%pass_router%&), overriding &%no_more%&.
19636 .next
19637 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19638 new addresses, which are routed independently, starting with the first router,
19639 or the router specified by &%redirect_router%&, if set.
19640 .endlist
19641
19642 When the first word is &'accept'&, the remainder of the line consists of a
19643 number of keyed data values, as follows (split into two lines here, to fit on
19644 the page):
19645 .code
19646 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19647 LOOKUP=byname|bydns DATA=<text>
19648 .endd
19649 The data items can be given in any order, and all are optional. If no transport
19650 is included, the transport specified by the generic &%transport%& option is
19651 used. The list of hosts and the lookup type are needed only if the transport is
19652 an &(smtp)& transport that does not itself supply a list of hosts.
19653
19654 The format of the list of hosts is the same as for the &(manualroute)& router.
19655 As well as host names and IP addresses with optional port numbers, as described
19656 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19657 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19658 (see section &<<SECThostshowused>>&).
19659
19660 If the lookup type is not specified, Exim behaves as follows when trying to
19661 find an IP address for each host: First, a DNS lookup is done. If this yields
19662 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19663 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19664 result of the lookup is the result of that call.
19665
19666 .vindex "&$address_data$&"
19667 If the DATA field is set, its value is placed in the &$address_data$&
19668 variable. For example, this return line
19669 .code
19670 accept hosts=x1.y.example:x2.y.example data="rule1"
19671 .endd
19672 routes the address to the default transport, passing a list of two hosts. When
19673 the transport runs, the string &"rule1"& is in &$address_data$&.
19674 .ecindex IIDquerou1
19675 .ecindex IIDquerou2
19676
19677
19678
19679
19680 . ////////////////////////////////////////////////////////////////////////////
19681 . ////////////////////////////////////////////////////////////////////////////
19682
19683 .chapter "The redirect router" "CHAPredirect"
19684 .scindex IIDredrou1 "&(redirect)& router"
19685 .scindex IIDredrou2 "routers" "&(redirect)&"
19686 .cindex "alias file" "in a &(redirect)& router"
19687 .cindex "address redirection" "&(redirect)& router"
19688 The &(redirect)& router handles several kinds of address redirection. Its most
19689 common uses are for resolving local part aliases from a central alias file
19690 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19691 files, but it has many other potential uses. The incoming address can be
19692 redirected in several different ways:
19693
19694 .ilist
19695 It can be replaced by one or more new addresses which are themselves routed
19696 independently.
19697 .next
19698 It can be routed to be delivered to a given file or directory.
19699 .next
19700 It can be routed to be delivered to a specified pipe command.
19701 .next
19702 It can cause an automatic reply to be generated.
19703 .next
19704 It can be forced to fail, optionally with a custom error message.
19705 .next
19706 It can be temporarily deferred, optionally with a custom message.
19707 .next
19708 It can be discarded.
19709 .endlist
19710
19711 The generic &%transport%& option must not be set for &(redirect)& routers.
19712 However, there are some private options which define transports for delivery to
19713 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19714 &%pipe_transport%& and &%reply_transport%& descriptions below.
19715
19716 If success DSNs have been requested
19717 .cindex "DSN" "success"
19718 .cindex "Delivery Status Notification" "success"
19719 redirection triggers one and the DSN options are not passed any further.
19720
19721
19722
19723 .section "Redirection data" "SECID124"
19724 The router operates by interpreting a text string which it obtains either by
19725 expanding the contents of the &%data%& option, or by reading the entire
19726 contents of a file whose name is given in the &%file%& option. These two
19727 options are mutually exclusive. The first is commonly used for handling system
19728 aliases, in a configuration like this:
19729 .code
19730 system_aliases:
19731   driver = redirect
19732   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19733 .endd
19734 If the lookup fails, the expanded string in this example is empty. When the
19735 expansion of &%data%& results in an empty string, the router declines. A forced
19736 expansion failure also causes the router to decline; other expansion failures
19737 cause delivery to be deferred.
19738
19739 A configuration using &%file%& is commonly used for handling users'
19740 &_.forward_& files, like this:
19741 .code
19742 userforward:
19743   driver = redirect
19744   check_local_user
19745   file = $home/.forward
19746   no_verify
19747 .endd
19748 If the file does not exist, or causes no action to be taken (for example, it is
19749 empty or consists only of comments), the router declines. &*Warning*&: This
19750 is not the case when the file contains syntactically valid items that happen to
19751 yield empty addresses, for example, items containing only RFC 2822 address
19752 comments.
19753
19754
19755
19756 .section "Forward files and address verification" "SECID125"
19757 .cindex "address redirection" "while verifying"
19758 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19759 &_.forward_& files, as in the example above. There are two reasons for this:
19760
19761 .ilist
19762 When Exim is receiving an incoming SMTP message from a remote host, it is
19763 running under the Exim uid, not as root. Exim is unable to change uid to read
19764 the file as the user, and it may not be able to read it as the Exim user. So in
19765 practice the router may not be able to operate.
19766 .next
19767 However, even when the router can operate, the existence of a &_.forward_& file
19768 is unimportant when verifying an address. What should be checked is whether the
19769 local part is a valid user name or not. Cutting out the redirection processing
19770 saves some resources.
19771 .endlist
19772
19773
19774
19775
19776
19777
19778 .section "Interpreting redirection data" "SECID126"
19779 .cindex "Sieve filter" "specifying in redirection data"
19780 .cindex "filter" "specifying in redirection data"
19781 The contents of the data string, whether obtained from &%data%& or &%file%&,
19782 can be interpreted in two different ways:
19783
19784 .ilist
19785 If the &%allow_filter%& option is set true, and the data begins with the text
19786 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19787 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19788 respectively. Details of the syntax and semantics of filter files are described
19789 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19790 document is intended for use by end users.
19791 .next
19792 Otherwise, the data must be a comma-separated list of redirection items, as
19793 described in the next section.
19794 .endlist
19795
19796 When a message is redirected to a file (a &"mail folder"&), the file name given
19797 in a non-filter redirection list must always be an absolute path. A filter may
19798 generate a relative path &-- how this is handled depends on the transport's
19799 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19800 for the &(appendfile)& transport.
19801
19802
19803
19804 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19805 .cindex "address redirection" "non-filter list items"
19806 When the redirection data is not an Exim or Sieve filter, for example, if it
19807 comes from a conventional alias or forward file, it consists of a list of
19808 addresses, file names, pipe commands, or certain special items (see section
19809 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19810 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19811 depending on their default values. The items in the list are separated by
19812 commas or newlines.
19813 If a comma is required in an item, the entire item must be enclosed in double
19814 quotes.
19815
19816 Lines starting with a # character are comments, and are ignored, and # may
19817 also appear following a comma, in which case everything between the # and the
19818 next newline character is ignored.
19819
19820 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19821 double quotes are retained because some forms of mail address require their use
19822 (but never to enclose the entire address). In the following description,
19823 &"item"& refers to what remains after any surrounding double quotes have been
19824 removed.
19825
19826 .vindex "&$local_part$&"
19827 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19828 and the expansion contains a reference to &$local_part$&, you should make use
19829 of the &%quote_local_part%& expansion operator, in case the local part contains
19830 special characters. For example, to redirect all mail for the domain
19831 &'obsolete.example'&, retaining the existing local part, you could use this
19832 setting:
19833 .code
19834 data = ${quote_local_part:$local_part}@newdomain.example
19835 .endd
19836
19837
19838 .section "Redirecting to a local mailbox" "SECTredlocmai"
19839 .cindex "routing" "loops in"
19840 .cindex "loop" "while routing, avoidance of"
19841 .cindex "address redirection" "to local mailbox"
19842 A redirection item may safely be the same as the address currently under
19843 consideration. This does not cause a routing loop, because a router is
19844 automatically skipped if any ancestor of the address that is being processed
19845 is the same as the current address and was processed by the current router.
19846 Such an address is therefore passed to the following routers, so it is handled
19847 as if there were no redirection. When making this loop-avoidance test, the
19848 complete local part, including any prefix or suffix, is used.
19849
19850 .cindex "address redirection" "local part without domain"
19851 Specifying the same local part without a domain is a common usage in personal
19852 filter files when the user wants to have messages delivered to the local
19853 mailbox and also forwarded elsewhere. For example, the user whose login is
19854 &'cleo'& might have a &_.forward_& file containing this:
19855 .code
19856 cleo, cleopatra@egypt.example
19857 .endd
19858 .cindex "backslash in alias file"
19859 .cindex "alias file" "backslash in"
19860 For compatibility with other MTAs, such unqualified local parts may be
19861 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19862 it does make a difference if more than one domain is being handled
19863 synonymously.
19864
19865 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19866 2822 address that does not include a domain, the item is qualified using the
19867 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19868 addresses are qualified using the value in &%qualify_recipient%&, but you can
19869 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19870
19871 Care must be taken if there are alias names for local users.
19872 Consider an MTA handling a single local domain where the system alias file
19873 contains:
19874 .code
19875 Sam.Reman: spqr
19876 .endd
19877 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19878 messages in the local mailbox, and also forward copies elsewhere. He creates
19879 this forward file:
19880 .code
19881 Sam.Reman, spqr@reme.elsewhere.example
19882 .endd
19883 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19884 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19885 second time round, because it has previously routed it,
19886 and the following routers presumably cannot handle the alias. The forward file
19887 should really contain
19888 .code
19889 spqr, spqr@reme.elsewhere.example
19890 .endd
19891 but because this is such a common error, the &%check_ancestor%& option (see
19892 below) exists to provide a way to get round it. This is normally set on a
19893 &(redirect)& router that is handling users' &_.forward_& files.
19894
19895
19896
19897 .section "Special items in redirection lists" "SECTspecitredli"
19898 In addition to addresses, the following types of item may appear in redirection
19899 lists (that is, in non-filter redirection data):
19900
19901 .ilist
19902 .cindex "pipe" "in redirection list"
19903 .cindex "address redirection" "to pipe"
19904 An item is treated as a pipe command if it begins with &"|"& and does not parse
19905 as a valid RFC 2822 address that includes a domain. A transport for running the
19906 command must be specified by the &%pipe_transport%& option.
19907 Normally, either the router or the transport specifies a user and a group under
19908 which to run the delivery. The default is to use the Exim user and group.
19909
19910 Single or double quotes can be used for enclosing the individual arguments of
19911 the pipe command; no interpretation of escapes is done for single quotes. If
19912 the command contains a comma character, it is necessary to put the whole item
19913 in double quotes, for example:
19914 .code
19915 "|/some/command ready,steady,go"
19916 .endd
19917 since items in redirection lists are terminated by commas. Do not, however,
19918 quote just the command. An item such as
19919 .code
19920 |"/some/command ready,steady,go"
19921 .endd
19922 is interpreted as a pipe with a rather strange command name, and no arguments.
19923
19924 Note that the above example assumes that the text comes from a lookup source
19925 of some sort, so that the quotes are part of the data.  If composing a
19926 redirect router with a &%data%& option directly specifying this command, the
19927 quotes will be used by the configuration parser to define the extent of one
19928 string, but will not be passed down into the redirect router itself.  There
19929 are two main approaches to get around this: escape quotes to be part of the
19930 data itself, or avoid using this mechanism and instead create a custom
19931 transport with the &%command%& option set and reference that transport from
19932 an &%accept%& router.
19933
19934 .next
19935 .cindex "file" "in redirection list"
19936 .cindex "address redirection" "to file"
19937 An item is interpreted as a path name if it begins with &"/"& and does not
19938 parse as a valid RFC 2822 address that includes a domain. For example,
19939 .code
19940 /home/world/minbari
19941 .endd
19942 is treated as a file name, but
19943 .code
19944 /s=molari/o=babylon/@x400gate.way
19945 .endd
19946 is treated as an address. For a file name, a transport must be specified using
19947 the &%file_transport%& option. However, if the generated path name ends with a
19948 forward slash character, it is interpreted as a directory name rather than a
19949 file name, and &%directory_transport%& is used instead.
19950
19951 Normally, either the router or the transport specifies a user and a group under
19952 which to run the delivery. The default is to use the Exim user and group.
19953
19954 .cindex "&_/dev/null_&"
19955 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19956 bypassed at a high level, and the log entry shows &"**bypassed**"&
19957 instead of a transport name. In this case the user and group are not used.
19958
19959 .next
19960 .cindex "included address list"
19961 .cindex "address redirection" "included external list"
19962 If an item is of the form
19963 .code
19964 :include:<path name>
19965 .endd
19966 a list of further items is taken from the given file and included at that
19967 point. &*Note*&: Such a file can not be a filter file; it is just an
19968 out-of-line addition to the list. The items in the included list are separated
19969 by commas or newlines and are not subject to expansion. If this is the first
19970 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19971 the alias name. This example is incorrect:
19972 .code
19973 list1    :include:/opt/lists/list1
19974 .endd
19975 It must be given as
19976 .code
19977 list1:   :include:/opt/lists/list1
19978 .endd
19979 .next
19980 .cindex "address redirection" "to black hole"
19981 .cindex "delivery" "discard"
19982 .cindex "delivery" "blackhole"
19983 .cindex "black hole"
19984 .cindex "abandoning mail"
19985 Sometimes you want to throw away mail to a particular local part.  Making the
19986 &%data%& option expand to an empty string does not work, because that causes
19987 the router to decline. Instead, the alias item
19988 .code
19989 :blackhole:
19990 .endd
19991 can be used. It does what its name implies. No delivery is
19992 done, and no error message is generated. This has the same effect as specifying
19993 &_/dev/null_& as a destination, but it can be independently disabled.
19994
19995 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19996 delivery is done for the original local part, even if other redirection items
19997 are present. If you are generating a multi-item list (for example, by reading a
19998 database) and need the ability to provide a no-op item, you must use
19999 &_/dev/null_&.
20000
20001 .next
20002 .cindex "delivery" "forcing failure"
20003 .cindex "delivery" "forcing deferral"
20004 .cindex "failing delivery" "forcing"
20005 .cindex "deferred delivery, forcing"
20006 .cindex "customizing" "failure message"
20007 An attempt to deliver a particular address can be deferred or forced to fail by
20008 redirection items of the form
20009 .code
20010 :defer:
20011 :fail:
20012 .endd
20013 respectively. When a redirection list contains such an item, it applies
20014 to the entire redirection; any other items in the list are ignored. Any
20015 text following &':fail:'& or &':defer:'& is placed in the error text
20016 associated with the failure. For example, an alias file might contain:
20017 .code
20018 X.Employee:  :fail: Gone away, no forwarding address
20019 .endd
20020 In the case of an address that is being verified from an ACL or as the subject
20021 of a
20022 .cindex "VRFY" "error text, display of"
20023 VRFY command, the text is included in the SMTP error response by
20024 default.
20025 .cindex "EXPN" "error text, display of"
20026 The text is not included in the response to an EXPN command. In non-SMTP cases
20027 the text is included in the error message that Exim generates.
20028
20029 .cindex "SMTP" "error codes"
20030 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20031 &':fail:'&. However, if the message starts with three digits followed by a
20032 space, optionally followed by an extended code of the form &'n.n.n'&, also
20033 followed by a space, and the very first digit is the same as the default error
20034 code, the code from the message is used instead. If the very first digit is
20035 incorrect, a panic error is logged, and the default code is used. You can
20036 suppress the use of the supplied code in a redirect router by setting the
20037 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20038 ignored.
20039
20040 .vindex "&$acl_verify_message$&"
20041 In an ACL, an explicitly provided message overrides the default, but the
20042 default message is available in the variable &$acl_verify_message$& and can
20043 therefore be included in a custom message if this is desired.
20044
20045 Normally the error text is the rest of the redirection list &-- a comma does
20046 not terminate it &-- but a newline does act as a terminator. Newlines are not
20047 normally present in alias expansions. In &(lsearch)& lookups they are removed
20048 as part of the continuation process, but they may exist in other kinds of
20049 lookup and in &':include:'& files.
20050
20051 During routing for message delivery (as opposed to verification), a redirection
20052 containing &':fail:'& causes an immediate failure of the incoming address,
20053 whereas &':defer:'& causes the message to remain on the queue so that a
20054 subsequent delivery attempt can happen at a later time. If an address is
20055 deferred for too long, it will ultimately fail, because the normal retry
20056 rules still apply.
20057
20058 .next
20059 .cindex "alias file" "exception to default"
20060 Sometimes it is useful to use a single-key search type with a default (see
20061 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20062 for exceptions to the default. These can be handled by aliasing them to
20063 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20064 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20065 results in an empty redirection list has the same effect.
20066 .endlist
20067
20068
20069 .section "Duplicate addresses" "SECTdupaddr"
20070 .cindex "duplicate addresses"
20071 .cindex "address duplicate, discarding"
20072 .cindex "pipe" "duplicated"
20073 Exim removes duplicate addresses from the list to which it is delivering, so as
20074 to deliver just one copy to each address. This does not apply to deliveries
20075 routed to pipes by different immediate parent addresses, but an indirect
20076 aliasing scheme of the type
20077 .code
20078 pipe:       |/some/command $local_part
20079 localpart1: pipe
20080 localpart2: pipe
20081 .endd
20082 does not work with a message that is addressed to both local parts, because
20083 when the second is aliased to the intermediate local part &"pipe"& it gets
20084 discarded as being the same as a previously handled address. However, a scheme
20085 such as
20086 .code
20087 localpart1: |/some/command $local_part
20088 localpart2: |/some/command $local_part
20089 .endd
20090 does result in two different pipe deliveries, because the immediate parents of
20091 the pipes are distinct.
20092
20093
20094
20095 .section "Repeated redirection expansion" "SECID128"
20096 .cindex "repeated redirection expansion"
20097 .cindex "address redirection" "repeated for each delivery attempt"
20098 When a message cannot be delivered to all of its recipients immediately,
20099 leading to two or more delivery attempts, redirection expansion is carried out
20100 afresh each time for those addresses whose children were not all previously
20101 delivered. If redirection is being used as a mailing list, this can lead to new
20102 members of the list receiving copies of old messages. The &%one_time%& option
20103 can be used to avoid this.
20104
20105
20106 .section "Errors in redirection lists" "SECID129"
20107 .cindex "address redirection" "errors"
20108 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20109 error is skipped, and an entry is written to the main log. This may be useful
20110 for mailing lists that are automatically managed. Otherwise, if an error is
20111 detected while generating the list of new addresses, the original address is
20112 deferred. See also &%syntax_errors_to%&.
20113
20114
20115
20116 .section "Private options for the redirect router" "SECID130"
20117
20118 .cindex "options" "&(redirect)& router"
20119 The private options for the &(redirect)& router are as follows:
20120
20121
20122 .option allow_defer redirect boolean false
20123 Setting this option allows the use of &':defer:'& in non-filter redirection
20124 data, or the &%defer%& command in an Exim filter file.
20125
20126
20127 .option allow_fail redirect boolean false
20128 .cindex "failing delivery" "from filter"
20129 If this option is true, the &':fail:'& item can be used in a redirection list,
20130 and the &%fail%& command may be used in an Exim filter file.
20131
20132
20133 .option allow_filter redirect boolean false
20134 .cindex "filter" "enabling use of"
20135 .cindex "Sieve filter" "enabling use of"
20136 Setting this option allows Exim to interpret redirection data that starts with
20137 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20138 are some features of Exim filter files that some administrators may wish to
20139 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20140
20141 It is also possible to lock out Exim filters or Sieve filters while allowing
20142 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20143
20144
20145 The filter is run using the uid and gid set by the generic &%user%& and
20146 &%group%& options. These take their defaults from the password data if
20147 &%check_local_user%& is set, so in the normal case of users' personal filter
20148 files, the filter is run as the relevant user. When &%allow_filter%& is set
20149 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20150
20151
20152
20153 .option allow_freeze redirect boolean false
20154 .cindex "freezing messages" "allowing in filter"
20155 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20156 This command is more normally encountered in system filters, and is disabled by
20157 default for redirection filters because it isn't something you usually want to
20158 let ordinary users do.
20159
20160
20161
20162 .option check_ancestor redirect boolean false
20163 This option is concerned with handling generated addresses that are the same
20164 as some address in the list of redirection ancestors of the current address.
20165 Although it is turned off by default in the code, it is set in the default
20166 configuration file for handling users' &_.forward_& files. It is recommended
20167 for this use of the &(redirect)& router.
20168
20169 When &%check_ancestor%& is set, if a generated address (including the domain)
20170 is the same as any ancestor of the current address, it is replaced by a copy of
20171 the current address. This helps in the case where local part A is aliased to B,
20172 and B has a &_.forward_& file pointing back to A. For example, within a single
20173 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20174 &_&~jb/.forward_& contains:
20175 .code
20176 \Joe.Bloggs, <other item(s)>
20177 .endd
20178 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20179 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20180 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20181 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20182 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20183 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20184 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20185 original address. See also the &%repeat_use%& option below.
20186
20187
20188 .option check_group redirect boolean "see below"
20189 When the &%file%& option is used, the group owner of the file is checked only
20190 when this option is set. The permitted groups are those listed in the
20191 &%owngroups%& option, together with the user's default group if
20192 &%check_local_user%& is set. If the file has the wrong group, routing is
20193 deferred. The default setting for this option is true if &%check_local_user%&
20194 is set and the &%modemask%& option permits the group write bit, or if the
20195 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20196
20197
20198
20199 .option check_owner redirect boolean "see below"
20200 When the &%file%& option is used, the owner of the file is checked only when
20201 this option is set. If &%check_local_user%& is set, the local user is
20202 permitted; otherwise the owner must be one of those listed in the &%owners%&
20203 option. The default value for this option is true if &%check_local_user%& or
20204 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20205
20206
20207 .option data redirect string&!! unset
20208 This option is mutually exclusive with &%file%&. One or other of them must be
20209 set, but not both. The contents of &%data%& are expanded, and then used as the
20210 list of forwarding items, or as a set of filtering instructions. If the
20211 expansion is forced to fail, or the result is an empty string or a string that
20212 has no effect (consists entirely of comments), the router declines.
20213
20214 When filtering instructions are used, the string must begin with &"#Exim
20215 filter"&, and all comments in the string, including this initial one, must be
20216 terminated with newline characters. For example:
20217 .code
20218 data = #Exim filter\n\
20219        if $h_to: contains Exim then save $home/mail/exim endif
20220 .endd
20221 If you are reading the data from a database where newlines cannot be included,
20222 you can use the &${sg}$& expansion item to turn the escape string of your
20223 choice into a newline.
20224
20225
20226 .option directory_transport redirect string&!! unset
20227 A &(redirect)& router sets up a direct delivery to a directory when a path name
20228 ending with a slash is specified as a new &"address"&. The transport used is
20229 specified by this option, which, after expansion, must be the name of a
20230 configured transport. This should normally be an &(appendfile)& transport.
20231
20232
20233 .option file redirect string&!! unset
20234 This option specifies the name of a file that contains the redirection data. It
20235 is mutually exclusive with the &%data%& option. The string is expanded before
20236 use; if the expansion is forced to fail, the router declines. Other expansion
20237 failures cause delivery to be deferred. The result of a successful expansion
20238 must be an absolute path. The entire file is read and used as the redirection
20239 data. If the data is an empty string or a string that has no effect (consists
20240 entirely of comments), the router declines.
20241
20242 .cindex "NFS" "checking for file existence"
20243 If the attempt to open the file fails with a &"does not exist"& error, Exim
20244 runs a check on the containing directory,
20245 unless &%ignore_enotdir%& is true (see below).
20246 If the directory does not appear to exist, delivery is deferred. This can
20247 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20248 is a mount problem. If the containing directory does exist, but the file does
20249 not, the router declines.
20250
20251
20252 .option file_transport redirect string&!! unset
20253 .vindex "&$address_file$&"
20254 A &(redirect)& router sets up a direct delivery to a file when a path name not
20255 ending in a slash is specified as a new &"address"&. The transport used is
20256 specified by this option, which, after expansion, must be the name of a
20257 configured transport. This should normally be an &(appendfile)& transport. When
20258 it is running, the file name is in &$address_file$&.
20259
20260
20261 .option filter_prepend_home redirect boolean true
20262 When this option is true, if a &(save)& command in an Exim filter specifies a
20263 relative path, and &$home$& is defined, it is automatically prepended to the
20264 relative path. If this option is set false, this action does not happen. The
20265 relative path is then passed to the transport unmodified.
20266
20267
20268 .option forbid_blackhole redirect boolean false
20269 If this option is true, the &':blackhole:'& item may not appear in a
20270 redirection list.
20271
20272
20273 .option forbid_exim_filter redirect boolean false
20274 If this option is set true, only Sieve filters are permitted when
20275 &%allow_filter%& is true.
20276
20277
20278
20279
20280 .option forbid_file redirect boolean false
20281 .cindex "delivery" "to file; forbidding"
20282 .cindex "Sieve filter" "forbidding delivery to a file"
20283 .cindex "Sieve filter" "&""keep""& facility; disabling"
20284 If this option is true, this router may not generate a new address that
20285 specifies delivery to a local file or directory, either from a filter or from a
20286 conventional forward file. This option is forced to be true if &%one_time%& is
20287 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20288 locks out the Sieve's &"keep"& facility.
20289
20290
20291 .option forbid_filter_dlfunc redirect boolean false
20292 .cindex "filter" "locking out certain features"
20293 If this option is true, string expansions in Exim filters are not allowed to
20294 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20295 functions.
20296
20297 .option forbid_filter_existstest redirect boolean false
20298 .cindex "expansion" "statting a file"
20299 If this option is true, string expansions in Exim filters are not allowed to
20300 make use of the &%exists%& condition or the &%stat%& expansion item.
20301
20302 .option forbid_filter_logwrite redirect boolean false
20303 If this option is true, use of the logging facility in Exim filters is not
20304 permitted. Logging is in any case available only if the filter is being run
20305 under some unprivileged uid (which is normally the case for ordinary users'
20306 &_.forward_& files).
20307
20308
20309 .option forbid_filter_lookup redirect boolean false
20310 If this option is true, string expansions in Exim filter files are not allowed
20311 to make use of &%lookup%& items.
20312
20313
20314 .option forbid_filter_perl redirect boolean false
20315 This option has an effect only if Exim is built with embedded Perl support. If
20316 it is true, string expansions in Exim filter files are not allowed to make use
20317 of the embedded Perl support.
20318
20319
20320 .option forbid_filter_readfile redirect boolean false
20321 If this option is true, string expansions in Exim filter files are not allowed
20322 to make use of &%readfile%& items.
20323
20324
20325 .option forbid_filter_readsocket redirect boolean false
20326 If this option is true, string expansions in Exim filter files are not allowed
20327 to make use of &%readsocket%& items.
20328
20329
20330 .option forbid_filter_reply redirect boolean false
20331 If this option is true, this router may not generate an automatic reply
20332 message. Automatic replies can be generated only from Exim or Sieve filter
20333 files, not from traditional forward files. This option is forced to be true if
20334 &%one_time%& is set.
20335
20336
20337 .option forbid_filter_run redirect boolean false
20338 If this option is true, string expansions in Exim filter files are not allowed
20339 to make use of &%run%& items.
20340
20341
20342 .option forbid_include redirect boolean false
20343 If this option is true, items of the form
20344 .code
20345 :include:<path name>
20346 .endd
20347 are not permitted in non-filter redirection lists.
20348
20349
20350 .option forbid_pipe redirect boolean false
20351 .cindex "delivery" "to pipe; forbidding"
20352 If this option is true, this router may not generate a new address which
20353 specifies delivery to a pipe, either from an Exim filter or from a conventional
20354 forward file. This option is forced to be true if &%one_time%& is set.
20355
20356
20357 .option forbid_sieve_filter redirect boolean false
20358 If this option is set true, only Exim filters are permitted when
20359 &%allow_filter%& is true.
20360
20361
20362 .cindex "SMTP" "error codes"
20363 .option forbid_smtp_code redirect boolean false
20364 If this option is set true, any SMTP error codes that are present at the start
20365 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20366 the default codes (451 and 550, respectively) are always used.
20367
20368
20369
20370
20371 .option hide_child_in_errmsg redirect boolean false
20372 .cindex "bounce message" "redirection details; suppressing"
20373 If this option is true, it prevents Exim from quoting a child address if it
20374 generates a bounce or delay message for it. Instead it says &"an address
20375 generated from <&'the top level address'&>"&. Of course, this applies only to
20376 bounces generated locally. If a message is forwarded to another host, &'its'&
20377 bounce may well quote the generated address.
20378
20379
20380 .option ignore_eacces redirect boolean false
20381 .cindex "EACCES"
20382 If this option is set and an attempt to open a redirection file yields the
20383 EACCES error (permission denied), the &(redirect)& router behaves as if the
20384 file did not exist.
20385
20386
20387 .option ignore_enotdir redirect boolean false
20388 .cindex "ENOTDIR"
20389 If this option is set and an attempt to open a redirection file yields the
20390 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20391 router behaves as if the file did not exist.
20392
20393 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20394 router that has the &%file%& option set discovers that the file does not exist
20395 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20396 against unmounted NFS directories. If the parent can not be statted, delivery
20397 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20398 is set, because that option tells Exim to ignore &"something on the path is not
20399 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20400 that some operating systems give ENOENT where others give ENOTDIR.
20401
20402
20403
20404 .option include_directory redirect string unset
20405 If this option is set, the path names of any &':include:'& items in a
20406 redirection list must start with this directory.
20407
20408
20409 .option modemask redirect "octal integer" 022
20410 This specifies mode bits which must not be set for a file specified by the
20411 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20412
20413
20414 .option one_time redirect boolean false
20415 .cindex "one-time aliasing/forwarding expansion"
20416 .cindex "alias file" "one-time expansion"
20417 .cindex "forward file" "one-time expansion"
20418 .cindex "mailing lists" "one-time expansion"
20419 .cindex "address redirection" "one-time expansion"
20420 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20421 files each time it tries to deliver a message causes a problem when one or more
20422 of the generated addresses fails be delivered at the first attempt. The problem
20423 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20424 but of what happens when the redirection list changes during the time that the
20425 message is on Exim's queue. This is particularly true in the case of mailing
20426 lists, where new subscribers might receive copies of messages that were posted
20427 before they subscribed.
20428
20429 If &%one_time%& is set and any addresses generated by the router fail to
20430 deliver at the first attempt, the failing addresses are added to the message as
20431 &"top level"& addresses, and the parent address that generated them is marked
20432 &"delivered"&. Thus, redirection does not happen again at the next delivery
20433 attempt.
20434
20435 &*Warning 1*&: Any header line addition or removal that is specified by this
20436 router would be lost if delivery did not succeed at the first attempt. For this
20437 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20438 permitted when &%one_time%& is set.
20439
20440 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20441 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20442 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20443
20444 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20445 &%one_time%&.
20446
20447 The original top-level address is remembered with each of the generated
20448 addresses, and is output in any log messages. However, any intermediate parent
20449 addresses are not recorded. This makes a difference to the log only if
20450 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20451 typically be used for mailing lists, where there is normally just one level of
20452 expansion.
20453
20454
20455 .option owners redirect "string list" unset
20456 .cindex "ownership" "alias file"
20457 .cindex "ownership" "forward file"
20458 .cindex "alias file" "ownership"
20459 .cindex "forward file" "ownership"
20460 This specifies a list of permitted owners for the file specified by &%file%&.
20461 This list is in addition to the local user when &%check_local_user%& is set.
20462 See &%check_owner%& above.
20463
20464
20465 .option owngroups redirect "string list" unset
20466 This specifies a list of permitted groups for the file specified by &%file%&.
20467 The list is in addition to the local user's primary group when
20468 &%check_local_user%& is set. See &%check_group%& above.
20469
20470
20471 .option pipe_transport redirect string&!! unset
20472 .vindex "&$address_pipe$&"
20473 A &(redirect)& router sets up a direct delivery to a pipe when a string
20474 starting with a vertical bar character is specified as a new &"address"&. The
20475 transport used is specified by this option, which, after expansion, must be the
20476 name of a configured transport. This should normally be a &(pipe)& transport.
20477 When the transport is run, the pipe command is in &$address_pipe$&.
20478
20479
20480 .option qualify_domain redirect string&!! unset
20481 .vindex "&$qualify_recipient$&"
20482 If this option is set, and an unqualified address (one without a domain) is
20483 generated, and that address would normally be qualified by the global setting
20484 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20485 expanding this string. If the expansion fails, the router declines. If you want
20486 to revert to the default, you can have the expansion generate
20487 &$qualify_recipient$&.
20488
20489 This option applies to all unqualified addresses generated by Exim filters,
20490 but for traditional &_.forward_& files, it applies only to addresses that are
20491 not preceded by a backslash. Sieve filters cannot generate unqualified
20492 addresses.
20493
20494 .option qualify_preserve_domain redirect boolean false
20495 .cindex "domain" "in redirection; preserving"
20496 .cindex "preserving domain in redirection"
20497 .cindex "address redirection" "domain; preserving"
20498 If this option is set, the router's local &%qualify_domain%& option must not be
20499 set (a configuration error occurs if it is). If an unqualified address (one
20500 without a domain) is generated, it is qualified with the domain of the parent
20501 address (the immediately preceding ancestor) instead of the global
20502 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20503 this applies whether or not the address is preceded by a backslash.
20504
20505
20506 .option repeat_use redirect boolean true
20507 If this option is set false, the router is skipped for a child address that has
20508 any ancestor that was routed by this router. This test happens before any of
20509 the other preconditions are tested. Exim's default anti-looping rules skip
20510 only when the ancestor is the same as the current address. See also
20511 &%check_ancestor%& above and the generic &%redirect_router%& option.
20512
20513
20514 .option reply_transport redirect string&!! unset
20515 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20516 &%vacation%& command is used in a filter file. The transport used is specified
20517 by this option, which, after expansion, must be the name of a configured
20518 transport. This should normally be an &(autoreply)& transport. Other transports
20519 are unlikely to do anything sensible or useful.
20520
20521
20522 .option rewrite redirect boolean true
20523 .cindex "address redirection" "disabling rewriting"
20524 If this option is set false, addresses generated by the router are not
20525 subject to address rewriting. Otherwise, they are treated like new addresses
20526 and are rewritten according to the global rewriting rules.
20527
20528
20529 .option sieve_subaddress redirect string&!! unset
20530 The value of this option is passed to a Sieve filter to specify the
20531 :subaddress part of an address.
20532
20533 .option sieve_useraddress redirect string&!! unset
20534 The value of this option is passed to a Sieve filter to specify the :user part
20535 of an address. However, if it is unset, the entire original local part
20536 (including any prefix or suffix) is used for :user.
20537
20538
20539 .option sieve_vacation_directory redirect string&!! unset
20540 .cindex "Sieve filter" "vacation directory"
20541 To enable the &"vacation"& extension for Sieve filters, you must set
20542 &%sieve_vacation_directory%& to the directory where vacation databases are held
20543 (do not put anything else in that directory), and ensure that the
20544 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20545 needs their own directory; Exim will create it if necessary.
20546
20547
20548
20549 .option skip_syntax_errors redirect boolean false
20550 .cindex "forward file" "broken"
20551 .cindex "address redirection" "broken files"
20552 .cindex "alias file" "broken"
20553 .cindex "broken alias or forward files"
20554 .cindex "ignoring faulty addresses"
20555 .cindex "skipping faulty addresses"
20556 .cindex "error" "skipping bad syntax"
20557 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20558 non-filter redirection data are skipped, and each failing address is logged. If
20559 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20560 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20561 are expanded and placed at the head of the error message generated by
20562 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20563 be the same address as the generic &%errors_to%& option. The
20564 &%skip_syntax_errors%& option is often used when handling mailing lists.
20565
20566 If all the addresses in a redirection list are skipped because of syntax
20567 errors, the router declines to handle the original address, and it is passed to
20568 the following routers.
20569
20570 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20571 error in the filter causes filtering to be abandoned without any action being
20572 taken. The incident is logged, and the router declines to handle the address,
20573 so it is passed to the following routers.
20574
20575 .cindex "Sieve filter" "syntax errors in"
20576 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20577 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20578 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20579
20580 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20581 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20582 option, used with an address that does not get redirected, can be used to
20583 notify users of these errors, by means of a router like this:
20584 .code
20585 userforward:
20586   driver = redirect
20587   allow_filter
20588   check_local_user
20589   file = $home/.forward
20590   file_transport = address_file
20591   pipe_transport = address_pipe
20592   reply_transport = address_reply
20593   no_verify
20594   skip_syntax_errors
20595   syntax_errors_to = real-$local_part@$domain
20596   syntax_errors_text = \
20597    This is an automatically generated message. An error has\n\
20598    been found in your .forward file. Details of the error are\n\
20599    reported below. While this error persists, you will receive\n\
20600    a copy of this message for every message that is addressed\n\
20601    to you. If your .forward file is a filter file, or if it is\n\
20602    a non-filter file containing no valid forwarding addresses,\n\
20603    a copy of each incoming message will be put in your normal\n\
20604    mailbox. If a non-filter file contains at least one valid\n\
20605    forwarding address, forwarding to the valid addresses will\n\
20606    happen, and those will be the only deliveries that occur.
20607 .endd
20608 You also need a router to ensure that local addresses that are prefixed by
20609 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20610 put this immediately before the &(userforward)& router:
20611 .code
20612 real_localuser:
20613   driver = accept
20614   check_local_user
20615   local_part_prefix = real-
20616   transport = local_delivery
20617 .endd
20618 For security, it would probably be a good idea to restrict the use of this
20619 router to locally-generated messages, using a condition such as this:
20620 .code
20621   condition = ${if match {$sender_host_address}\
20622                          {\N^(|127\.0\.0\.1)$\N}}
20623 .endd
20624
20625
20626 .option syntax_errors_text redirect string&!! unset
20627 See &%skip_syntax_errors%& above.
20628
20629
20630 .option syntax_errors_to redirect string unset
20631 See &%skip_syntax_errors%& above.
20632 .ecindex IIDredrou1
20633 .ecindex IIDredrou2
20634
20635
20636
20637
20638
20639
20640 . ////////////////////////////////////////////////////////////////////////////
20641 . ////////////////////////////////////////////////////////////////////////////
20642
20643 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20644          "Environment for local transports"
20645 .scindex IIDenvlotra1 "local transports" "environment for"
20646 .scindex IIDenvlotra2 "environment" "local transports"
20647 .scindex IIDenvlotra3 "transport" "local; environment for"
20648 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20649 transport can be thought of as similar to a pipe.) Exim always runs transports
20650 in subprocesses, under specified uids and gids. Typical deliveries to local
20651 mailboxes run under the uid and gid of the local user.
20652
20653 Exim also sets a specific current directory while running the transport; for
20654 some transports a home directory setting is also relevant. The &(pipe)&
20655 transport is the only one that sets up environment variables; see section
20656 &<<SECTpipeenv>>& for details.
20657
20658 The values used for the uid, gid, and the directories may come from several
20659 different places. In many cases, the router that handles the address associates
20660 settings with that address as a result of its &%check_local_user%&, &%group%&,
20661 or &%user%& options. However, values may also be given in the transport's own
20662 configuration, and these override anything that comes from the router.
20663
20664
20665
20666 .section "Concurrent deliveries" "SECID131"
20667 .cindex "concurrent deliveries"
20668 .cindex "simultaneous deliveries"
20669 If two different messages for the same local recipient arrive more or less
20670 simultaneously, the two delivery processes are likely to run concurrently. When
20671 the &(appendfile)& transport is used to write to a file, Exim applies locking
20672 rules to stop concurrent processes from writing to the same file at the same
20673 time.
20674
20675 However, when you use a &(pipe)& transport, it is up to you to arrange any
20676 locking that is needed. Here is a silly example:
20677 .code
20678 my_transport:
20679   driver = pipe
20680   command = /bin/sh -c 'cat >>/some/file'
20681 .endd
20682 This is supposed to write the message at the end of the file. However, if two
20683 messages arrive at the same time, the file will be scrambled. You can use the
20684 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20685 file using the same algorithm that Exim itself uses.
20686
20687
20688
20689
20690 .section "Uids and gids" "SECTenvuidgid"
20691 .cindex "local transports" "uid and gid"
20692 .cindex "transport" "local; uid and gid"
20693 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20694 overrides any group that the router set in the address, even if &%user%& is not
20695 set for the transport. This makes it possible, for example, to run local mail
20696 delivery under the uid of the recipient (set by the router), but in a special
20697 group (set by the transport). For example:
20698 .code
20699 # Routers ...
20700 # User/group are set by check_local_user in this router
20701 local_users:
20702   driver = accept
20703   check_local_user
20704   transport = group_delivery
20705
20706 # Transports ...
20707 # This transport overrides the group
20708 group_delivery:
20709   driver = appendfile
20710   file = /var/spool/mail/$local_part
20711   group = mail
20712 .endd
20713 If &%user%& is set for a transport, its value overrides what is set in the
20714 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20715 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20716 set.
20717
20718 .oindex "&%initgroups%&"
20719 When the uid is taken from the transport's configuration, the &[initgroups()]&
20720 function is called for the groups associated with that uid if the
20721 &%initgroups%& option is set for the transport. When the uid is not specified
20722 by the transport, but is associated with the address by a router, the option
20723 for calling &[initgroups()]& is taken from the router configuration.
20724
20725 .cindex "&(pipe)& transport" "uid for"
20726 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20727 is set and &%user%& is not set, the uid of the process that called Exim to
20728 receive the message is used, and if &%group%& is not set, the corresponding
20729 original gid is also used.
20730
20731 This is the detailed preference order for obtaining a gid; the first of the
20732 following that is set is used:
20733
20734 .ilist
20735 A &%group%& setting of the transport;
20736 .next
20737 A &%group%& setting of the router;
20738 .next
20739 A gid associated with a user setting of the router, either as a result of
20740 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20741 .next
20742 The group associated with a non-numeric &%user%& setting of the transport;
20743 .next
20744 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20745 the uid is the creator's uid;
20746 .next
20747 The Exim gid if the Exim uid is being used as a default.
20748 .endlist
20749
20750 If, for example, the user is specified numerically on the router and there are
20751 no group settings, no gid is available. In this situation, an error occurs.
20752 This is different for the uid, for which there always is an ultimate default.
20753 The first of the following that is set is used:
20754
20755 .ilist
20756 A &%user%& setting of the transport;
20757 .next
20758 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20759 .next
20760 A &%user%& setting of the router;
20761 .next
20762 A &%check_local_user%& setting of the router;
20763 .next
20764 The Exim uid.
20765 .endlist
20766
20767 Of course, an error will still occur if the uid that is chosen is on the
20768 &%never_users%& list.
20769
20770
20771
20772
20773
20774 .section "Current and home directories" "SECID132"
20775 .cindex "current directory for local transport"
20776 .cindex "home directory" "for local transport"
20777 .cindex "transport" "local; home directory for"
20778 .cindex "transport" "local; current directory for"
20779 Routers may set current and home directories for local transports by means of
20780 the &%transport_current_directory%& and &%transport_home_directory%& options.
20781 However, if the transport's &%current_directory%& or &%home_directory%& options
20782 are set, they override the router's values. In detail, the home directory
20783 for a local transport is taken from the first of these values that is set:
20784
20785 .ilist
20786 The &%home_directory%& option on the transport;
20787 .next
20788 The &%transport_home_directory%& option on the router;
20789 .next
20790 The password data if &%check_local_user%& is set on the router;
20791 .next
20792 The &%router_home_directory%& option on the router.
20793 .endlist
20794
20795 The current directory is taken from the first of these values that is set:
20796
20797 .ilist
20798 The &%current_directory%& option on the transport;
20799 .next
20800 The &%transport_current_directory%& option on the router.
20801 .endlist
20802
20803
20804 If neither the router nor the transport sets a current directory, Exim uses the
20805 value of the home directory, if it is set. Otherwise it sets the current
20806 directory to &_/_& before running a local transport.
20807
20808
20809
20810 .section "Expansion variables derived from the address" "SECID133"
20811 .vindex "&$domain$&"
20812 .vindex "&$local_part$&"
20813 .vindex "&$original_domain$&"
20814 Normally a local delivery is handling a single address, and in that case the
20815 variables such as &$domain$& and &$local_part$& are set during local
20816 deliveries. However, in some circumstances more than one address may be handled
20817 at once (for example, while writing batch SMTP for onward transmission by some
20818 other means). In this case, the variables associated with the local part are
20819 never set, &$domain$& is set only if all the addresses have the same domain,
20820 and &$original_domain$& is never set.
20821 .ecindex IIDenvlotra1
20822 .ecindex IIDenvlotra2
20823 .ecindex IIDenvlotra3
20824
20825
20826
20827
20828
20829
20830
20831 . ////////////////////////////////////////////////////////////////////////////
20832 . ////////////////////////////////////////////////////////////////////////////
20833
20834 .chapter "Generic options for transports" "CHAPtransportgeneric"
20835 .scindex IIDgenoptra1 "generic options" "transport"
20836 .scindex IIDgenoptra2 "options" "generic; for transports"
20837 .scindex IIDgenoptra3 "transport" "generic options for"
20838 The following generic options apply to all transports:
20839
20840
20841 .option body_only transports boolean false
20842 .cindex "transport" "body only"
20843 .cindex "message" "transporting body only"
20844 .cindex "body of message" "transporting"
20845 If this option is set, the message's headers are not transported. It is
20846 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20847 or &(pipe)& transports, the settings of &%message_prefix%& and
20848 &%message_suffix%& should be checked, because this option does not
20849 automatically suppress them.
20850
20851
20852 .option current_directory transports string&!! unset
20853 .cindex "transport" "current directory for"
20854 This specifies the current directory that is to be set while running the
20855 transport, overriding any value that may have been set by the router.
20856 If the expansion fails for any reason, including forced failure, an error is
20857 logged, and delivery is deferred.
20858
20859
20860 .option disable_logging transports boolean false
20861 If this option is set true, nothing is logged for any
20862 deliveries by the transport or for any
20863 transport errors. You should not set this option unless you really, really know
20864 what you are doing.
20865
20866
20867 .option debug_print transports string&!! unset
20868 .cindex "testing" "variables in drivers"
20869 If this option is set and debugging is enabled (see the &%-d%& command line
20870 option), the string is expanded and included in the debugging output when the
20871 transport is run.
20872 If expansion of the string fails, the error message is written to the debugging
20873 output, and Exim carries on processing.
20874 This facility is provided to help with checking out the values of variables and
20875 so on when debugging driver configurations. For example, if a &%headers_add%&
20876 option is not working properly, &%debug_print%& could be used to output the
20877 variables it references. A newline is added to the text if it does not end with
20878 one.
20879 The variables &$transport_name$& and &$router_name$& contain the name of the
20880 transport and the router that called it.
20881
20882 .option delivery_date_add transports boolean false
20883 .cindex "&'Delivery-date:'& header line"
20884 If this option is true, a &'Delivery-date:'& header is added to the message.
20885 This gives the actual time the delivery was made. As this is not a standard
20886 header, Exim has a configuration option (&%delivery_date_remove%&) which
20887 requests its removal from incoming messages, so that delivered messages can
20888 safely be resent to other recipients.
20889
20890
20891 .option driver transports string unset
20892 This specifies which of the available transport drivers is to be used.
20893 There is no default, and this option must be set for every transport.
20894
20895
20896 .option envelope_to_add transports boolean false
20897 .cindex "&'Envelope-to:'& header line"
20898 If this option is true, an &'Envelope-to:'& header is added to the message.
20899 This gives the original address(es) in the incoming envelope that caused this
20900 delivery to happen. More than one address may be present if the transport is
20901 configured to handle several addresses at once, or if more than one original
20902 address was redirected to the same final address. As this is not a standard
20903 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20904 its removal from incoming messages, so that delivered messages can safely be
20905 resent to other recipients.
20906
20907
20908 .option event_action transports string&!! unset
20909 .cindex events
20910 This option declares a string to be expanded for Exim's events mechanism.
20911 For details see &<<CHAPevents>>&.
20912
20913
20914 .option group transports string&!! "Exim group"
20915 .cindex "transport" "group; specifying"
20916 This option specifies a gid for running the transport process, overriding any
20917 value that the router supplies, and also overriding any value associated with
20918 &%user%& (see below).
20919
20920
20921 .option headers_add transports list&!! unset
20922 .cindex "header lines" "adding in transport"
20923 .cindex "transport" "header lines; adding"
20924 This option specifies a list of text headers,
20925 newline-separated (by default, changeable in the usual way),
20926 which are (separately) expanded and added to the header
20927 portion of a message as it is transported, as described in section
20928 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20929 routers. If the result of the expansion is an empty string, or if the expansion
20930 is forced to fail, no action is taken. Other expansion failures are treated as
20931 errors and cause the delivery to be deferred.
20932
20933 Unlike most options, &%headers_add%& can be specified multiple times
20934 for a transport; all listed headers are added.
20935
20936
20937 .option headers_only transports boolean false
20938 .cindex "transport" "header lines only"
20939 .cindex "message" "transporting headers only"
20940 .cindex "header lines" "transporting"
20941 If this option is set, the message's body is not transported. It is mutually
20942 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20943 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20944 checked, since this option does not automatically suppress them.
20945
20946
20947 .option headers_remove transports list&!! unset
20948 .cindex "header lines" "removing"
20949 .cindex "transport" "header lines; removing"
20950 This option specifies a list of header names,
20951 colon-separated (by default, changeable in the usual way);
20952 these headers are omitted from the message as it is transported, as described
20953 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20954 routers.
20955 Each list item is separately expanded.
20956 If the result of the expansion is an empty string, or if the expansion
20957 is forced to fail, no action is taken. Other expansion failures are treated as
20958 errors and cause the delivery to be deferred.
20959
20960 Unlike most options, &%headers_remove%& can be specified multiple times
20961 for a transport; all listed headers are removed.
20962
20963 &*Warning*&: Because of the separate expansion of the list items,
20964 items that contain a list separator must have it doubled.
20965 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20966
20967
20968
20969 .option headers_rewrite transports string unset
20970 .cindex "transport" "header lines; rewriting"
20971 .cindex "rewriting" "at transport time"
20972 This option allows addresses in header lines to be rewritten at transport time,
20973 that is, as the message is being copied to its destination. The contents of the
20974 option are a colon-separated list of rewriting rules. Each rule is in exactly
20975 the same form as one of the general rewriting rules that are applied when a
20976 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20977 example,
20978 .code
20979 headers_rewrite = a@b c@d f : \
20980                   x@y w@z
20981 .endd
20982 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20983 &'w@z'& in all address-bearing header lines. The rules are applied to the
20984 header lines just before they are written out at transport time, so they affect
20985 only those copies of the message that pass through the transport. However, only
20986 the message's original header lines, and any that were added by a system
20987 filter, are rewritten. If a router or transport adds header lines, they are not
20988 affected by this option. These rewriting rules are &'not'& applied to the
20989 envelope. You can change the return path using &%return_path%&, but you cannot
20990 change envelope recipients at this time.
20991
20992
20993 .option home_directory transports string&!! unset
20994 .cindex "transport" "home directory for"
20995 .vindex "&$home$&"
20996 This option specifies a home directory setting for a local transport,
20997 overriding any value that may be set by the router. The home directory is
20998 placed in &$home$& while expanding the transport's private options. It is also
20999 used as the current directory if no current directory is set by the
21000 &%current_directory%& option on the transport or the
21001 &%transport_current_directory%& option on the router. If the expansion fails
21002 for any reason, including forced failure, an error is logged, and delivery is
21003 deferred.
21004
21005
21006 .option initgroups transports boolean false
21007 .cindex "additional groups"
21008 .cindex "groups" "additional"
21009 .cindex "transport" "group; additional"
21010 If this option is true and the uid for the delivery process is provided by the
21011 transport, the &[initgroups()]& function is called when running the transport
21012 to ensure that any additional groups associated with the uid are set up.
21013
21014
21015 .option max_parallel transports integer&!! unset
21016 .cindex limit "transport parallelism"
21017 .cindex transport "parallel processes"
21018 .cindex transport "concurrency limit"
21019 .cindex "delivery" "parallelism for transport"
21020 If this option is set and expands to an integer greater than zero
21021 it limits the number of concurrent runs of the transport.
21022 The control does not apply to shadow transports.
21023
21024 .cindex "hints database" "transport concurrency control"
21025 Exim implements this control by means of a hints database in which a record is
21026 incremented whenever a transport process is beaing created. The record
21027 is decremented and possibly removed when the process terminates.
21028 Obviously there is scope for
21029 records to get left lying around if there is a system or program crash. To
21030 guard against this, Exim ignores any records that are more than six hours old.
21031
21032 If you use this option, you should also arrange to delete the
21033 relevant hints database whenever your system reboots. The names of the files
21034 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21035 may be one or two files, depending on the type of DBM in use. The same files
21036 are used for ETRN and smtp transport serialization.
21037
21038
21039 .option message_size_limit transports string&!! 0
21040 .cindex "limit" "message size per transport"
21041 .cindex "size" "of message, limit"
21042 .cindex "transport" "message size; limiting"
21043 This option controls the size of messages passed through the transport. It is
21044 expanded before use; the result of the expansion must be a sequence of decimal
21045 digits, optionally followed by K or M. If the expansion fails for any reason,
21046 including forced failure, or if the result is not of the required form,
21047 delivery is deferred. If the value is greater than zero and the size of a
21048 message exceeds this limit, the address is failed. If there is any chance that
21049 the resulting bounce message could be routed to the same transport, you should
21050 ensure that &%return_size_limit%& is less than the transport's
21051 &%message_size_limit%&, as otherwise the bounce message will fail to get
21052 delivered.
21053
21054
21055
21056 .option rcpt_include_affixes transports boolean false
21057 .cindex "prefix" "for local part, including in envelope"
21058 .cindex "suffix for local part" "including in envelope"
21059 .cindex "local part" "prefix"
21060 .cindex "local part" "suffix"
21061 When this option is false (the default), and an address that has had any
21062 affixes (prefixes or suffixes) removed from the local part is delivered by any
21063 form of SMTP or LMTP, the affixes are not included. For example, if a router
21064 that contains
21065 .code
21066 local_part_prefix = *-
21067 .endd
21068 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21069 is delivered with
21070 .code
21071 RCPT TO:<xyz@some.domain>
21072 .endd
21073 This is also the case when an ACL-time callout is being used to verify a
21074 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21075 whole local part is included in the RCPT command. This option applies to BSMTP
21076 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21077 &(lmtp)& and &(smtp)& transports.
21078
21079
21080 .option retry_use_local_part transports boolean "see below"
21081 .cindex "hints database" "retry keys"
21082 When a delivery suffers a temporary failure, a retry record is created
21083 in Exim's hints database. For remote deliveries, the key for the retry record
21084 is based on the name and/or IP address of the failing remote host. For local
21085 deliveries, the key is normally the entire address, including both the local
21086 part and the domain. This is suitable for most common cases of local delivery
21087 temporary failure &-- for example, exceeding a mailbox quota should delay only
21088 deliveries to that mailbox, not to the whole domain.
21089
21090 However, in some special cases you may want to treat a temporary local delivery
21091 as a failure associated with the domain, and not with a particular local part.
21092 (For example, if you are storing all mail for some domain in files.) You can do
21093 this by setting &%retry_use_local_part%& false.
21094
21095 For all the local transports, its default value is true. For remote transports,
21096 the default value is false for tidiness, but changing the value has no effect
21097 on a remote transport in the current implementation.
21098
21099
21100 .option return_path transports string&!! unset
21101 .cindex "envelope sender"
21102 .cindex "transport" "return path; changing"
21103 .cindex "return path" "changing in transport"
21104 If this option is set, the string is expanded at transport time and replaces
21105 the existing return path (envelope sender) value in the copy of the message
21106 that is being delivered. An empty return path is permitted. This feature is
21107 designed for remote deliveries, where the value of this option is used in the
21108 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21109 only effect is to change the address that is placed in the &'Return-path:'&
21110 header line, if one is added to the message (see the next option).
21111
21112 &*Note:*& A changed return path is not logged unless you add
21113 &%return_path_on_delivery%& to the log selector.
21114
21115 .vindex "&$return_path$&"
21116 The expansion can refer to the existing value via &$return_path$&. This is
21117 either the message's envelope sender, or an address set by the
21118 &%errors_to%& option on a router. If the expansion is forced to fail, no
21119 replacement occurs; if it fails for another reason, delivery is deferred. This
21120 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21121 section &<<SECTverp>>&.
21122
21123 &*Note*&: If a delivery error is detected locally, including the case when a
21124 remote server rejects a message at SMTP time, the bounce message is not sent to
21125 the value of this option. It is sent to the previously set errors address.
21126 This defaults to the incoming sender address, but can be changed by setting
21127 &%errors_to%& in a router.
21128
21129
21130
21131 .option return_path_add transports boolean false
21132 .cindex "&'Return-path:'& header line"
21133 If this option is true, a &'Return-path:'& header is added to the message.
21134 Although the return path is normally available in the prefix line of BSD
21135 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21136 have easy access to it.
21137
21138 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21139 the delivery SMTP server makes the final delivery"&. This implies that this
21140 header should not be present in incoming messages. Exim has a configuration
21141 option, &%return_path_remove%&, which requests removal of this header from
21142 incoming messages, so that delivered messages can safely be resent to other
21143 recipients.
21144
21145
21146 .option shadow_condition transports string&!! unset
21147 See &%shadow_transport%& below.
21148
21149
21150 .option shadow_transport transports string unset
21151 .cindex "shadow transport"
21152 .cindex "transport" "shadow"
21153 A local transport may set the &%shadow_transport%& option to the name of
21154 another local transport. Shadow remote transports are not supported.
21155
21156 Whenever a delivery to the main transport succeeds, and either
21157 &%shadow_condition%& is unset, or its expansion does not result in the empty
21158 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21159 passed to the shadow transport, with the same delivery address or addresses. If
21160 expansion fails, no action is taken except that non-forced expansion failures
21161 cause a log line to be written.
21162
21163 The result of the shadow transport is discarded and does not affect the
21164 subsequent processing of the message. Only a single level of shadowing is
21165 provided; the &%shadow_transport%& option is ignored on any transport when it
21166 is running as a shadow. Options concerned with output from pipes are also
21167 ignored. The log line for the successful delivery has an item added on the end,
21168 of the form
21169 .code
21170 ST=<shadow transport name>
21171 .endd
21172 If the shadow transport did not succeed, the error message is put in
21173 parentheses afterwards. Shadow transports can be used for a number of different
21174 purposes, including keeping more detailed log information than Exim normally
21175 provides, and implementing automatic acknowledgment policies based on message
21176 headers that some sites insist on.
21177
21178
21179 .option transport_filter transports string&!! unset
21180 .cindex "transport" "filter"
21181 .cindex "filter" "transport filter"
21182 This option sets up a filtering (in the Unix shell sense) process for messages
21183 at transport time. It should not be confused with mail filtering as set up by
21184 individual users or via a system filter.
21185 If unset, or expanding to an empty string, no filtering is done.
21186
21187 When the message is about to be written out, the command specified by
21188 &%transport_filter%& is started up in a separate, parallel process, and
21189 the entire message, including the header lines, is passed to it on its standard
21190 input (this in fact is done from a third process, to avoid deadlock). The
21191 command must be specified as an absolute path.
21192
21193 The lines of the message that are written to the transport filter are
21194 terminated by newline (&"\n"&). The message is passed to the filter before any
21195 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21196 lines beginning with a dot, and also before any processing implied by the
21197 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21198 &(pipe)& transports.
21199
21200 The standard error for the filter process is set to the same destination as its
21201 standard output; this is read and written to the message's ultimate
21202 destination. The process that writes the message to the filter, the
21203 filter itself, and the original process that reads the result and delivers it
21204 are all run in parallel, like a shell pipeline.
21205
21206 The filter can perform any transformations it likes, but of course should take
21207 care not to break RFC 2822 syntax. Exim does not check the result, except to
21208 test for a final newline when SMTP is in use. All messages transmitted over
21209 SMTP must end with a newline, so Exim supplies one if it is missing.
21210
21211 .cindex "content scanning" "per user"
21212 A transport filter can be used to provide content-scanning on a per-user basis
21213 at delivery time if the only required effect of the scan is to modify the
21214 message. For example, a content scan could insert a new header line containing
21215 a spam score. This could be interpreted by a filter in the user's MUA. It is
21216 not possible to discard a message at this stage.
21217
21218 .cindex "SMTP" "SIZE"
21219 A problem might arise if the filter increases the size of a message that is
21220 being sent down an SMTP connection. If the receiving SMTP server has indicated
21221 support for the SIZE parameter, Exim will have sent the size of the message
21222 at the start of the SMTP session. If what is actually sent is substantially
21223 more, the server might reject the message. This can be worked round by setting
21224 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21225 additions to the message, or to disable the use of SIZE altogether.
21226
21227 .vindex "&$pipe_addresses$&"
21228 The value of the &%transport_filter%& option is the command string for starting
21229 the filter, which is run directly from Exim, not under a shell. The string is
21230 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21231 Exim breaks it up into arguments and then expands each argument separately (see
21232 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21233 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21234 of arguments, one for each address that applies to this delivery. (This isn't
21235 an ideal name for this feature here, but as it was already implemented for the
21236 &(pipe)& transport, it seemed sensible not to change it.)
21237
21238 .vindex "&$host$&"
21239 .vindex "&$host_address$&"
21240 The expansion variables &$host$& and &$host_address$& are available when the
21241 transport is a remote one. They contain the name and IP address of the host to
21242 which the message is being sent. For example:
21243 .code
21244 transport_filter = /some/directory/transport-filter.pl \
21245   $host $host_address $sender_address $pipe_addresses
21246 .endd
21247
21248 Two problems arise if you want to use more complicated expansion items to
21249 generate transport filter commands, both of which due to the fact that the
21250 command is split up &'before'& expansion.
21251 .ilist
21252 If an expansion item contains white space, you must quote it, so that it is all
21253 part of the same command item. If the entire option setting is one such
21254 expansion item, you have to take care what kind of quoting you use. For
21255 example:
21256 .code
21257 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21258 .endd
21259 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21260 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21261 stripped by Exim when it read the option's value. When the value is used, if
21262 the single quotes were missing, the line would be split into two items,
21263 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21264 Exim tried to expand the first one.
21265 .next
21266 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21267 expansion cannot generate multiple arguments, or a command name followed by
21268 arguments. Consider this example:
21269 .code
21270 transport_filter = ${lookup{$host}lsearch{/a/file}\
21271                     {$value}{/bin/cat}}
21272 .endd
21273 The result of the lookup is interpreted as the name of the command, even
21274 if it contains white space. The simplest way round this is to use a shell:
21275 .code
21276 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21277                                {$value}{/bin/cat}}
21278 .endd
21279 .endlist
21280
21281 The filter process is run under the same uid and gid as the normal delivery.
21282 For remote deliveries this is the Exim uid/gid by default. The command should
21283 normally yield a zero return code. Transport filters are not supposed to fail.
21284 A non-zero code is taken to mean that the transport filter encountered some
21285 serious problem. Delivery of the message is deferred; the message remains on
21286 the queue and is tried again later. It is not possible to cause a message to be
21287 bounced from a transport filter.
21288
21289 If a transport filter is set on an autoreply transport, the original message is
21290 passed through the filter as it is being copied into the newly generated
21291 message, which happens if the &%return_message%& option is set.
21292
21293
21294 .option transport_filter_timeout transports time 5m
21295 .cindex "transport" "filter, timeout"
21296 When Exim is reading the output of a transport filter, it applies a timeout
21297 that can be set by this option. Exceeding the timeout is normally treated as a
21298 temporary delivery failure. However, if a transport filter is used with a
21299 &(pipe)& transport, a timeout in the transport filter is treated in the same
21300 way as a timeout in the pipe command itself. By default, a timeout is a hard
21301 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21302 becomes a temporary error.
21303
21304
21305 .option user transports string&!! "Exim user"
21306 .cindex "uid (user id)" "local delivery"
21307 .cindex "transport" "user, specifying"
21308 This option specifies the user under whose uid the delivery process is to be
21309 run, overriding any uid that may have been set by the router. If the user is
21310 given as a name, the uid is looked up from the password data, and the
21311 associated group is taken as the value of the gid to be used if the &%group%&
21312 option is not set.
21313
21314 For deliveries that use local transports, a user and group are normally
21315 specified explicitly or implicitly (for example, as a result of
21316 &%check_local_user%&) by the router or transport.
21317
21318 .cindex "hints database" "access by remote transport"
21319 For remote transports, you should leave this option unset unless you really are
21320 sure you know what you are doing. When a remote transport is running, it needs
21321 to be able to access Exim's hints databases, because each host may have its own
21322 retry data.
21323 .ecindex IIDgenoptra1
21324 .ecindex IIDgenoptra2
21325 .ecindex IIDgenoptra3
21326
21327
21328
21329
21330
21331
21332 . ////////////////////////////////////////////////////////////////////////////
21333 . ////////////////////////////////////////////////////////////////////////////
21334
21335 .chapter "Address batching in local transports" "CHAPbatching" &&&
21336          "Address batching"
21337 .cindex "transport" "local; address batching in"
21338 The only remote transport (&(smtp)&) is normally configured to handle more than
21339 one address at a time, so that when several addresses are routed to the same
21340 remote host, just one copy of the message is sent. Local transports, however,
21341 normally handle one address at a time. That is, a separate instance of the
21342 transport is run for each address that is routed to the transport. A separate
21343 copy of the message is delivered each time.
21344
21345 .cindex "batched local delivery"
21346 .oindex "&%batch_max%&"
21347 .oindex "&%batch_id%&"
21348 In special cases, it may be desirable to handle several addresses at once in a
21349 local transport, for example:
21350
21351 .ilist
21352 In an &(appendfile)& transport, when storing messages in files for later
21353 delivery by some other means, a single copy of the message with multiple
21354 recipients saves space.
21355 .next
21356 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21357 a single copy saves time, and is the normal way LMTP is expected to work.
21358 .next
21359 In a &(pipe)& transport, when passing the message
21360 to a scanner program or
21361 to some other delivery mechanism such as UUCP, multiple recipients may be
21362 acceptable.
21363 .endlist
21364
21365 These three local transports all have the same options for controlling multiple
21366 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21367 repeating the information for each transport, these options are described here.
21368
21369 The &%batch_max%& option specifies the maximum number of addresses that can be
21370 delivered together in a single run of the transport. Its default value is one
21371 (no batching). When more than one address is routed to a transport that has a
21372 &%batch_max%& value greater than one, the addresses are delivered in a batch
21373 (that is, in a single run of the transport with multiple recipients), subject
21374 to certain conditions:
21375
21376 .ilist
21377 .vindex "&$local_part$&"
21378 If any of the transport's options contain a reference to &$local_part$&, no
21379 batching is possible.
21380 .next
21381 .vindex "&$domain$&"
21382 If any of the transport's options contain a reference to &$domain$&, only
21383 addresses with the same domain are batched.
21384 .next
21385 .cindex "customizing" "batching condition"
21386 If &%batch_id%& is set, it is expanded for each address, and only those
21387 addresses with the same expanded value are batched. This allows you to specify
21388 customized batching conditions. Failure of the expansion for any reason,
21389 including forced failure, disables batching, but it does not stop the delivery
21390 from taking place.
21391 .next
21392 Batched addresses must also have the same errors address (where to send
21393 delivery errors), the same header additions and removals, the same user and
21394 group for the transport, and if a host list is present, the first host must
21395 be the same.
21396 .endlist
21397
21398 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21399 both when the file or pipe command is specified in the transport, and when it
21400 is specified by a &(redirect)& router, but all the batched addresses must of
21401 course be routed to the same file or pipe command. These two transports have an
21402 option called &%use_bsmtp%&, which causes them to deliver the message in
21403 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21404 &%check_string%& and &%escape_string%& options are forced to the values
21405 .code
21406 check_string = "."
21407 escape_string = ".."
21408 .endd
21409 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21410 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21411 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21412
21413 .cindex "&'Envelope-to:'& header line"
21414 If the generic &%envelope_to_add%& option is set for a batching transport, the
21415 &'Envelope-to:'& header that is added to the message contains all the addresses
21416 that are being processed together. If you are using a batching &(appendfile)&
21417 transport without &%use_bsmtp%&, the only way to preserve the recipient
21418 addresses is to set the &%envelope_to_add%& option.
21419
21420 .cindex "&(pipe)& transport" "with multiple addresses"
21421 .vindex "&$pipe_addresses$&"
21422 If you are using a &(pipe)& transport without BSMTP, and setting the
21423 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21424 the command. This is not a true variable; it is a bit of magic that causes each
21425 of the recipient addresses to be inserted into the command as a separate
21426 argument. This provides a way of accessing all the addresses that are being
21427 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21428 are specified by a &(redirect)& router.
21429
21430
21431
21432
21433 . ////////////////////////////////////////////////////////////////////////////
21434 . ////////////////////////////////////////////////////////////////////////////
21435
21436 .chapter "The appendfile transport" "CHAPappendfile"
21437 .scindex IIDapptra1 "&(appendfile)& transport"
21438 .scindex IIDapptra2 "transports" "&(appendfile)&"
21439 .cindex "directory creation"
21440 .cindex "creating directories"
21441 The &(appendfile)& transport delivers a message by appending it to an existing
21442 file, or by creating an entirely new file in a specified directory. Single
21443 files to which messages are appended can be in the traditional Unix mailbox
21444 format, or optionally in the MBX format supported by the Pine MUA and
21445 University of Washington IMAP daemon, &'inter alia'&. When each message is
21446 being delivered as a separate file, &"maildir"& format can optionally be used
21447 to give added protection against failures that happen part-way through the
21448 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21449 supported. For all file formats, Exim attempts to create as many levels of
21450 directory as necessary, provided that &%create_directory%& is set.
21451
21452 The code for the optional formats is not included in the Exim binary by
21453 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21454 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21455 included.
21456
21457 .cindex "quota" "system"
21458 Exim recognizes system quota errors, and generates an appropriate message. Exim
21459 also supports its own quota control within the transport, for use when the
21460 system facility is unavailable or cannot be used for some reason.
21461
21462 If there is an error while appending to a file (for example, quota exceeded or
21463 partition filled), Exim attempts to reset the file's length and last
21464 modification time back to what they were before. If there is an error while
21465 creating an entirely new file, the new file is removed.
21466
21467 Before appending to a file, a number of security checks are made, and the
21468 file is locked. A detailed description is given below, after the list of
21469 private options.
21470
21471 The &(appendfile)& transport is most commonly used for local deliveries to
21472 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21473 putting messages into files for remote delivery by some means other than Exim.
21474 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21475 option).
21476
21477
21478
21479 .section "The file and directory options" "SECTfildiropt"
21480 The &%file%& option specifies a single file, to which the message is appended;
21481 the &%directory%& option specifies a directory, in which a new file containing
21482 the message is created. Only one of these two options can be set, and for
21483 normal deliveries to mailboxes, one of them &'must'& be set.
21484
21485 .vindex "&$address_file$&"
21486 .vindex "&$local_part$&"
21487 However, &(appendfile)& is also used for delivering messages to files or
21488 directories whose names (or parts of names) are obtained from alias,
21489 forwarding, or filtering operations (for example, a &%save%& command in a
21490 user's Exim filter). When such a transport is running, &$local_part$& contains
21491 the local part that was aliased or forwarded, and &$address_file$& contains the
21492 name (or partial name) of the file or directory generated by the redirection
21493 operation. There are two cases:
21494
21495 .ilist
21496 If neither &%file%& nor &%directory%& is set, the redirection operation
21497 must specify an absolute path (one that begins with &`/`&). This is the most
21498 common case when users with local accounts use filtering to sort mail into
21499 different folders. See for example, the &(address_file)& transport in the
21500 default configuration. If the path ends with a slash, it is assumed to be the
21501 name of a directory. A delivery to a directory can also be forced by setting
21502 &%maildir_format%& or &%mailstore_format%&.
21503 .next
21504 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21505 used to determine the file or directory name for the delivery. Normally, the
21506 contents of &$address_file$& are used in some way in the string expansion.
21507 .endlist
21508
21509
21510 .cindex "Sieve filter" "configuring &(appendfile)&"
21511 .cindex "Sieve filter" "relative mailbox path handling"
21512 As an example of the second case, consider an environment where users do not
21513 have home directories. They may be permitted to use Exim filter commands of the
21514 form:
21515 .code
21516 save folder23
21517 .endd
21518 or Sieve filter commands of the form:
21519 .code
21520 require "fileinto";
21521 fileinto "folder23";
21522 .endd
21523 In this situation, the expansion of &%file%& or &%directory%& in the transport
21524 must transform the relative path into an appropriate absolute file name. In the
21525 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21526 is used as a result of a &"keep"& action in the filter. This example shows one
21527 way of handling this requirement:
21528 .code
21529 file = ${if eq{$address_file}{inbox} \
21530             {/var/mail/$local_part} \
21531             {${if eq{${substr_0_1:$address_file}}{/} \
21532                   {$address_file} \
21533                   {$home/mail/$address_file} \
21534             }} \
21535        }
21536 .endd
21537 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21538 location, absolute paths are used without change, and other folders are in the
21539 &_mail_& directory within the home directory.
21540
21541 &*Note 1*&: While processing an Exim filter, a relative path such as
21542 &_folder23_& is turned into an absolute path if a home directory is known to
21543 the router. In particular, this is the case if &%check_local_user%& is set. If
21544 you want to prevent this happening at routing time, you can set
21545 &%router_home_directory%& empty. This forces the router to pass the relative
21546 path to the transport.
21547
21548 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21549 the &%file%& or &%directory%& option is still used if it is set.
21550
21551
21552
21553
21554 .section "Private options for appendfile" "SECID134"
21555 .cindex "options" "&(appendfile)& transport"
21556
21557
21558
21559 .option allow_fifo appendfile boolean false
21560 .cindex "fifo (named pipe)"
21561 .cindex "named pipe (fifo)"
21562 .cindex "pipe" "named (fifo)"
21563 Setting this option permits delivery to named pipes (FIFOs) as well as to
21564 regular files. If no process is reading the named pipe at delivery time, the
21565 delivery is deferred.
21566
21567
21568 .option allow_symlink appendfile boolean false
21569 .cindex "symbolic link" "to mailbox"
21570 .cindex "mailbox" "symbolic link"
21571 By default, &(appendfile)& will not deliver if the path name for the file is
21572 that of a symbolic link. Setting this option relaxes that constraint, but there
21573 are security issues involved in the use of symbolic links. Be sure you know
21574 what you are doing if you set this. Details of exactly what this option affects
21575 are included in the discussion which follows this list of options.
21576
21577
21578 .option batch_id appendfile string&!! unset
21579 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21580 However, batching is automatically disabled for &(appendfile)& deliveries that
21581 happen as a result of forwarding or aliasing or other redirection directly to a
21582 file.
21583
21584
21585 .option batch_max appendfile integer 1
21586 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21587
21588
21589 .option check_group appendfile boolean false
21590 When this option is set, the group owner of the file defined by the &%file%&
21591 option is checked to see that it is the same as the group under which the
21592 delivery process is running. The default setting is false because the default
21593 file mode is 0600, which means that the group is irrelevant.
21594
21595
21596 .option check_owner appendfile boolean true
21597 When this option is set, the owner of the file defined by the &%file%& option
21598 is checked to ensure that it is the same as the user under which the delivery
21599 process is running.
21600
21601
21602 .option check_string appendfile string "see below"
21603 .cindex "&""From""& line"
21604 As &(appendfile)& writes the message, the start of each line is tested for
21605 matching &%check_string%&, and if it does, the initial matching characters are
21606 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21607 a literal string, not a regular expression, and the case of any letters it
21608 contains is significant.
21609
21610 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21611 are forced to &"."& and &".."& respectively, and any settings in the
21612 configuration are ignored. Otherwise, they default to &"From&~"& and
21613 &">From&~"& when the &%file%& option is set, and unset when any of the
21614 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21615
21616 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21617 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21618 &"From&~"& indicates the start of a new message. All four options need changing
21619 if another format is used. For example, to deliver to mailboxes in MMDF format:
21620 .cindex "MMDF format mailbox"
21621 .cindex "mailbox" "MMDF format"
21622 .code
21623 check_string = "\1\1\1\1\n"
21624 escape_string = "\1\1\1\1 \n"
21625 message_prefix = "\1\1\1\1\n"
21626 message_suffix = "\1\1\1\1\n"
21627 .endd
21628 .option create_directory appendfile boolean true
21629 .cindex "directory creation"
21630 When this option is true, Exim attempts to create any missing superior
21631 directories for the file that it is about to write. A created directory's mode
21632 is given by the &%directory_mode%& option.
21633
21634 The group ownership of a newly created directory is highly dependent on the
21635 operating system (and possibly the file system) that is being used. For
21636 example, in Solaris, if the parent directory has the setgid bit set, its group
21637 is propagated to the child; if not, the currently set group is used. However,
21638 in FreeBSD, the parent's group is always used.
21639
21640
21641
21642 .option create_file appendfile string anywhere
21643 This option constrains the location of files and directories that are created
21644 by this transport. It applies to files defined by the &%file%& option and
21645 directories defined by the &%directory%& option. In the case of maildir
21646 delivery, it applies to the top level directory, not the maildir directories
21647 beneath.
21648
21649 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21650 &"belowhome"&. In the second and third cases, a home directory must have been
21651 set for the transport. This option is not useful when an explicit file name is
21652 given for normal mailbox deliveries. It is intended for the case when file
21653 names are generated from users' &_.forward_& files. These are usually handled
21654 by an &(appendfile)& transport called &%address_file%&. See also
21655 &%file_must_exist%&.
21656
21657
21658 .option directory appendfile string&!! unset
21659 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21660 or &%directory%& must be set, unless the delivery is the direct result of a
21661 redirection (see section &<<SECTfildiropt>>&).
21662
21663 When &%directory%& is set, the string is expanded, and the message is delivered
21664 into a new file or files in or below the given directory, instead of being
21665 appended to a single mailbox file. A number of different formats are provided
21666 (see &%maildir_format%& and &%mailstore_format%&), and see section
21667 &<<SECTopdir>>& for further details of this form of delivery.
21668
21669
21670 .option directory_file appendfile string&!! "see below"
21671 .cindex "base62"
21672 .vindex "&$inode$&"
21673 When &%directory%& is set, but neither &%maildir_format%& nor
21674 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21675 whose name is obtained by expanding this string. The default value is:
21676 .code
21677 q${base62:$tod_epoch}-$inode
21678 .endd
21679 This generates a unique name from the current time, in base 62 form, and the
21680 inode of the file. The variable &$inode$& is available only when expanding this
21681 option.
21682
21683
21684 .option directory_mode appendfile "octal integer" 0700
21685 If &(appendfile)& creates any directories as a result of the
21686 &%create_directory%& option, their mode is specified by this option.
21687
21688
21689 .option escape_string appendfile string "see description"
21690 See &%check_string%& above.
21691
21692
21693 .option file appendfile string&!! unset
21694 This option is mutually exclusive with the &%directory%& option, but one of
21695 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21696 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21697 specifies a single file, to which the message is appended. One or more of
21698 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21699 &%file%&.
21700
21701 .cindex "NFS" "lock file"
21702 .cindex "locking files"
21703 .cindex "lock files"
21704 If you are using more than one host to deliver over NFS into the same
21705 mailboxes, you should always use lock files.
21706
21707 The string value is expanded for each delivery, and must yield an absolute
21708 path. The most common settings of this option are variations on one of these
21709 examples:
21710 .code
21711 file = /var/spool/mail/$local_part
21712 file = /home/$local_part/inbox
21713 file = $home/inbox
21714 .endd
21715 .cindex "&""sticky""& bit"
21716 In the first example, all deliveries are done into the same directory. If Exim
21717 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21718 create a file in the directory, so the &"sticky"& bit must be turned on for
21719 deliveries to be possible, or alternatively the &%group%& option can be used to
21720 run the delivery under a group id which has write access to the directory.
21721
21722
21723
21724 .option file_format appendfile string unset
21725 .cindex "file" "mailbox; checking existing format"
21726 This option requests the transport to check the format of an existing file
21727 before adding to it. The check consists of matching a specific string at the
21728 start of the file. The value of the option consists of an even number of
21729 colon-separated strings. The first of each pair is the test string, and the
21730 second is the name of a transport. If the transport associated with a matched
21731 string is not the current transport, control is passed over to the other
21732 transport. For example, suppose the standard &(local_delivery)& transport has
21733 this added to it:
21734 .code
21735 file_format = "From       : local_delivery :\
21736                \1\1\1\1\n : local_mmdf_delivery"
21737 .endd
21738 Mailboxes that begin with &"From"& are still handled by this transport, but if
21739 a mailbox begins with four binary ones followed by a newline, control is passed
21740 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21741 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21742 is assumed to match the current transport. If the start of a mailbox doesn't
21743 match any string, or if the transport named for a given string is not defined,
21744 delivery is deferred.
21745
21746
21747 .option file_must_exist appendfile boolean false
21748 If this option is true, the file specified by the &%file%& option must exist.
21749 A temporary error occurs if it does not, causing delivery to be deferred.
21750 If this option is false, the file is created if it does not exist.
21751
21752
21753 .option lock_fcntl_timeout appendfile time 0s
21754 .cindex "timeout" "mailbox locking"
21755 .cindex "mailbox" "locking, blocking and non-blocking"
21756 .cindex "locking files"
21757 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21758 when locking an open mailbox file. If the call fails, the delivery process
21759 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21760 Non-blocking calls are used so that the file is not kept open during the wait
21761 for the lock; the reason for this is to make it as safe as possible for
21762 deliveries over NFS in the case when processes might be accessing an NFS
21763 mailbox without using a lock file. This should not be done, but
21764 misunderstandings and hence misconfigurations are not unknown.
21765
21766 On a busy system, however, the performance of a non-blocking lock approach is
21767 not as good as using a blocking lock with a timeout. In this case, the waiting
21768 is done inside the system call, and Exim's delivery process acquires the lock
21769 and can proceed as soon as the previous lock holder releases it.
21770
21771 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21772 timeout, are used. There may still be some retrying: the maximum number of
21773 retries is
21774 .code
21775 (lock_retries * lock_interval) / lock_fcntl_timeout
21776 .endd
21777 rounded up to the next whole number. In other words, the total time during
21778 which &(appendfile)& is trying to get a lock is roughly the same, unless
21779 &%lock_fcntl_timeout%& is set very large.
21780
21781 You should consider setting this option if you are getting a lot of delayed
21782 local deliveries because of errors of the form
21783 .code
21784 failed to lock mailbox /some/file (fcntl)
21785 .endd
21786
21787 .option lock_flock_timeout appendfile time 0s
21788 This timeout applies to file locking when using &[flock()]& (see
21789 &%use_flock%&); the timeout operates in a similar manner to
21790 &%lock_fcntl_timeout%&.
21791
21792
21793 .option lock_interval appendfile time 3s
21794 This specifies the time to wait between attempts to lock the file. See below
21795 for details of locking.
21796
21797
21798 .option lock_retries appendfile integer 10
21799 This specifies the maximum number of attempts to lock the file. A value of zero
21800 is treated as 1. See below for details of locking.
21801
21802
21803 .option lockfile_mode appendfile "octal integer" 0600
21804 This specifies the mode of the created lock file, when a lock file is being
21805 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21806
21807
21808 .option lockfile_timeout appendfile time 30m
21809 .cindex "timeout" "mailbox locking"
21810 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21811 exists and is older than this value, it is assumed to have been left behind by
21812 accident, and Exim attempts to remove it.
21813
21814
21815 .option mailbox_filecount appendfile string&!! unset
21816 .cindex "mailbox" "specifying size of"
21817 .cindex "size" "of mailbox"
21818 If this option is set, it is expanded, and the result is taken as the current
21819 number of files in the mailbox. It must be a decimal number, optionally
21820 followed by K or M. This provides a way of obtaining this information from an
21821 external source that maintains the data.
21822
21823
21824 .option mailbox_size appendfile string&!! unset
21825 .cindex "mailbox" "specifying size of"
21826 .cindex "size" "of mailbox"
21827 If this option is set, it is expanded, and the result is taken as the current
21828 size the mailbox. It must be a decimal number, optionally followed by K or M.
21829 This provides a way of obtaining this information from an external source that
21830 maintains the data. This is likely to be helpful for maildir deliveries where
21831 it is computationally expensive to compute the size of a mailbox.
21832
21833
21834
21835 .option maildir_format appendfile boolean false
21836 .cindex "maildir format" "specifying"
21837 If this option is set with the &%directory%& option, the delivery is into a new
21838 file, in the &"maildir"& format that is used by other mail software. When the
21839 transport is activated directly from a &(redirect)& router (for example, the
21840 &(address_file)& transport in the default configuration), setting
21841 &%maildir_format%& causes the path received from the router to be treated as a
21842 directory, whether or not it ends with &`/`&. This option is available only if
21843 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21844 &<<SECTmaildirdelivery>>& below for further details.
21845
21846
21847 .option maildir_quota_directory_regex appendfile string "See below"
21848 .cindex "maildir format" "quota; directories included in"
21849 .cindex "quota" "maildir; directories included in"
21850 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21851 a regular expression for specifying directories, relative to the quota
21852 directory (see &%quota_directory%&), that should be included in the quota
21853 calculation. The default value is:
21854 .code
21855 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21856 .endd
21857 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21858 (directories whose names begin with a dot). If you want to exclude the
21859 &_Trash_&
21860 folder from the count (as some sites do), you need to change this setting to
21861 .code
21862 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21863 .endd
21864 This uses a negative lookahead in the regular expression to exclude the
21865 directory whose name is &_.Trash_&. When a directory is excluded from quota
21866 calculations, quota processing is bypassed for any messages that are delivered
21867 directly into that directory.
21868
21869
21870 .option maildir_retries appendfile integer 10
21871 This option specifies the number of times to retry when writing a file in
21872 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21873
21874
21875 .option maildir_tag appendfile string&!! unset
21876 This option applies only to deliveries in maildir format, and is described in
21877 section &<<SECTmaildirdelivery>>& below.
21878
21879
21880 .option maildir_use_size_file appendfile&!! boolean false
21881 .cindex "maildir format" "&_maildirsize_& file"
21882 The result of string expansion for this option must be a valid boolean value.
21883 If it is true, it enables support for &_maildirsize_& files. Exim
21884 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21885 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21886 value is zero. See &%maildir_quota_directory_regex%& above and section
21887 &<<SECTmaildirdelivery>>& below for further details.
21888
21889 .option maildirfolder_create_regex appendfile string unset
21890 .cindex "maildir format" "&_maildirfolder_& file"
21891 .cindex "&_maildirfolder_&, creating"
21892 The value of this option is a regular expression. If it is unset, it has no
21893 effect. Otherwise, before a maildir delivery takes place, the pattern is
21894 matched against the name of the maildir directory, that is, the directory
21895 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21896 delivery. If there is a match, Exim checks for the existence of a file called
21897 &_maildirfolder_& in the directory, and creates it if it does not exist.
21898 See section &<<SECTmaildirdelivery>>& for more details.
21899
21900
21901 .option mailstore_format appendfile boolean false
21902 .cindex "mailstore format" "specifying"
21903 If this option is set with the &%directory%& option, the delivery is into two
21904 new files in  &"mailstore"& format. The option is available only if
21905 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21906 below for further details.
21907
21908
21909 .option mailstore_prefix appendfile string&!! unset
21910 This option applies only to deliveries in mailstore format, and is described in
21911 section &<<SECTopdir>>& below.
21912
21913
21914 .option mailstore_suffix appendfile string&!! unset
21915 This option applies only to deliveries in mailstore format, and is described in
21916 section &<<SECTopdir>>& below.
21917
21918
21919 .option mbx_format appendfile boolean false
21920 .cindex "locking files"
21921 .cindex "file" "locking"
21922 .cindex "file" "MBX format"
21923 .cindex "MBX format, specifying"
21924 This option is available only if Exim has been compiled with SUPPORT_MBX
21925 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21926 the message is appended to the mailbox file in MBX format instead of
21927 traditional Unix format. This format is supported by Pine4 and its associated
21928 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21929
21930 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21931 automatically changed by the use of &%mbx_format%&. They should normally be set
21932 empty when using MBX format, so this option almost always appears in this
21933 combination:
21934 .code
21935 mbx_format = true
21936 message_prefix =
21937 message_suffix =
21938 .endd
21939 If none of the locking options are mentioned in the configuration,
21940 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21941 is possible to specify the other kinds of locking with &%mbx_format%&, but
21942 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21943 interworks with &'c-client'&, providing for shared access to the mailbox. It
21944 should not be used if any program that does not use this form of locking is
21945 going to access the mailbox, nor should it be used if the mailbox file is NFS
21946 mounted, because it works only when the mailbox is accessed from a single host.
21947
21948 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21949 the standard version of &'c-client'&, because as long as it has a mailbox open
21950 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21951 append messages to it.
21952
21953
21954 .option message_prefix appendfile string&!! "see below"
21955 .cindex "&""From""& line"
21956 The string specified here is expanded and output at the start of every message.
21957 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21958 in which case it is:
21959 .code
21960 message_prefix = "From ${if def:return_path{$return_path}\
21961   {MAILER-DAEMON}} $tod_bsdinbox\n"
21962 .endd
21963 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21964 &`\n`& to &`\r\n`& in &%message_prefix%&.
21965
21966 .option message_suffix appendfile string&!! "see below"
21967 The string specified here is expanded and output at the end of every message.
21968 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21969 in which case it is a single newline character. The suffix can be suppressed by
21970 setting
21971 .code
21972 message_suffix =
21973 .endd
21974 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21975 &`\n`& to &`\r\n`& in &%message_suffix%&.
21976
21977 .option mode appendfile "octal integer" 0600
21978 If the output file is created, it is given this mode. If it already exists and
21979 has wider permissions, they are reduced to this mode. If it has narrower
21980 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21981 if the delivery is the result of a &%save%& command in a filter file specifying
21982 a particular mode, the mode of the output file is always forced to take that
21983 value, and this option is ignored.
21984
21985
21986 .option mode_fail_narrower appendfile boolean true
21987 This option applies in the case when an existing mailbox file has a narrower
21988 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21989 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21990 continues with the delivery attempt, using the existing mode of the file.
21991
21992
21993 .option notify_comsat appendfile boolean false
21994 If this option is true, the &'comsat'& daemon is notified after every
21995 successful delivery to a user mailbox. This is the daemon that notifies logged
21996 on users about incoming mail.
21997
21998
21999 .option quota appendfile string&!! unset
22000 .cindex "quota" "imposed by Exim"
22001 This option imposes a limit on the size of the file to which Exim is appending,
22002 or to the total space used in the directory tree when the &%directory%& option
22003 is set. In the latter case, computation of the space used is expensive, because
22004 all the files in the directory (and any sub-directories) have to be
22005 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22006 &%maildir_use_size_file%& for ways to avoid this in environments where users
22007 have no shell access to their mailboxes).
22008
22009 As there is no interlock against two simultaneous deliveries into a
22010 multi-file mailbox, it is possible for the quota to be overrun in this case.
22011 For single-file mailboxes, of course, an interlock is a necessity.
22012
22013 A file's size is taken as its &'used'& value. Because of blocking effects, this
22014 may be a lot less than the actual amount of disk space allocated to the file.
22015 If the sizes of a number of files are being added up, the rounding effect can
22016 become quite noticeable, especially on systems that have large block sizes.
22017 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22018 the obvious value which users understand most easily.
22019
22020 The value of the option is expanded, and must then be a numerical value
22021 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22022 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
22023 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22024 be handled.
22025
22026 &*Note*&: A value of zero is interpreted as &"no quota"&.
22027
22028 The expansion happens while Exim is running as root, before it changes uid for
22029 the delivery. This means that files that are inaccessible to the end user can
22030 be used to hold quota values that are looked up in the expansion. When delivery
22031 fails because this quota is exceeded, the handling of the error is as for
22032 system quota failures.
22033
22034 By default, Exim's quota checking mimics system quotas, and restricts the
22035 mailbox to the specified maximum size, though the value is not accurate to the
22036 last byte, owing to separator lines and additional headers that may get added
22037 during message delivery. When a mailbox is nearly full, large messages may get
22038 refused even though small ones are accepted, because the size of the current
22039 message is added to the quota when the check is made. This behaviour can be
22040 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22041 for exceeding the quota does not include the current message. Thus, deliveries
22042 continue until the quota has been exceeded; thereafter, no further messages are
22043 delivered. See also &%quota_warn_threshold%&.
22044
22045
22046 .option quota_directory appendfile string&!! unset
22047 This option defines the directory to check for quota purposes when delivering
22048 into individual files. The default is the delivery directory, or, if a file
22049 called &_maildirfolder_& exists in a maildir directory, the parent of the
22050 delivery directory.
22051
22052
22053 .option quota_filecount appendfile string&!! 0
22054 This option applies when the &%directory%& option is set. It limits the total
22055 number of files in the directory (compare the inode limit in system quotas). It
22056 can only be used if &%quota%& is also set. The value is expanded; an expansion
22057 failure causes delivery to be deferred. A value of zero is interpreted as
22058 &"no quota"&.
22059
22060
22061 .option quota_is_inclusive appendfile boolean true
22062 See &%quota%& above.
22063
22064
22065 .option quota_size_regex appendfile string unset
22066 This option applies when one of the delivery modes that writes a separate file
22067 for each message is being used. When Exim wants to find the size of one of
22068 these files in order to test the quota, it first checks &%quota_size_regex%&.
22069 If this is set to a regular expression that matches the file name, and it
22070 captures one string, that string is interpreted as a representation of the
22071 file's size. The value of &%quota_size_regex%& is not expanded.
22072
22073 This feature is useful only when users have no shell access to their mailboxes
22074 &-- otherwise they could defeat the quota simply by renaming the files. This
22075 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22076 the file length to the file name. For example:
22077 .code
22078 maildir_tag = ,S=$message_size
22079 quota_size_regex = ,S=(\d+)
22080 .endd
22081 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22082 number of lines in the message.
22083
22084 The regular expression should not assume that the length is at the end of the
22085 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22086 sometimes add other information onto the ends of message file names.
22087
22088 Section &<<SECID136>>& contains further information.
22089
22090
22091 .option quota_warn_message appendfile string&!! "see below"
22092 See below for the use of this option. If it is not set when
22093 &%quota_warn_threshold%& is set, it defaults to
22094 .code
22095 quota_warn_message = "\
22096   To: $local_part@$domain\n\
22097   Subject: Your mailbox\n\n\
22098   This message is automatically created \
22099   by mail delivery software.\n\n\
22100   The size of your mailbox has exceeded \
22101   a warning threshold that is\n\
22102   set by the system administrator.\n"
22103 .endd
22104
22105
22106 .option quota_warn_threshold appendfile string&!! 0
22107 .cindex "quota" "warning threshold"
22108 .cindex "mailbox" "size warning"
22109 .cindex "size" "of mailbox"
22110 This option is expanded in the same way as &%quota%& (see above). If the
22111 resulting value is greater than zero, and delivery of the message causes the
22112 size of the file or total space in the directory tree to cross the given
22113 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22114 may be specified as a percentage of it by following the value with a percent
22115 sign. For example:
22116 .code
22117 quota = 10M
22118 quota_warn_threshold = 75%
22119 .endd
22120 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22121 percent sign is ignored.
22122
22123 The warning message itself is specified by the &%quota_warn_message%& option,
22124 and it must start with a &'To:'& header line containing the recipient(s) of the
22125 warning message. These do not necessarily have to include the recipient(s) of
22126 the original message. A &'Subject:'& line should also normally be supplied. You
22127 can include any other header lines that you want. If you do not include a
22128 &'From:'& line, the default is:
22129 .code
22130 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22131 .endd
22132 .oindex &%errors_reply_to%&
22133 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22134 option.
22135
22136 The &%quota%& option does not have to be set in order to use this option; they
22137 are independent of one another except when the threshold is specified as a
22138 percentage.
22139
22140
22141 .option use_bsmtp appendfile boolean false
22142 .cindex "envelope sender"
22143 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22144 format, with the envelope sender and recipient(s) included as SMTP commands. If
22145 you want to include a leading HELO command with such messages, you can do
22146 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22147 for details of batch SMTP.
22148
22149
22150 .option use_crlf appendfile boolean false
22151 .cindex "carriage return"
22152 .cindex "linefeed"
22153 This option causes lines to be terminated with the two-character CRLF sequence
22154 (carriage return, linefeed) instead of just a linefeed character. In the case
22155 of batched SMTP, the byte sequence written to the file is then an exact image
22156 of what would be sent down a real SMTP connection.
22157
22158 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22159 (which are used to supply the traditional &"From&~"& and blank line separators
22160 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22161 carriage return characters if these are needed. In cases where these options
22162 have non-empty defaults, the values end with a single linefeed, so they must be
22163 changed to end with &`\r\n`& if &%use_crlf%& is set.
22164
22165
22166 .option use_fcntl_lock appendfile boolean "see below"
22167 This option controls the use of the &[fcntl()]& function to lock a file for
22168 exclusive use when a message is being appended. It is set by default unless
22169 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22170 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22171 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22172
22173
22174 .option use_flock_lock appendfile boolean false
22175 This option is provided to support the use of &[flock()]& for file locking, for
22176 the few situations where it is needed. Most modern operating systems support
22177 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22178 each other. Exim uses &[fcntl()]& locking by default.
22179
22180 This option is required only if you are using an operating system where
22181 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22182 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22183 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22184
22185 .cindex "Solaris" "&[flock()]& support"
22186 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22187 have it (and some, I think, provide a not quite right version built on top of
22188 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22189 the ability to use it, and any attempt to do so will cause a configuration
22190 error.
22191
22192 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22193 is just being mapped onto &[fcntl()]& by the OS).
22194
22195
22196 .option use_lockfile appendfile boolean "see below"
22197 If this option is turned off, Exim does not attempt to create a lock file when
22198 appending to a mailbox file. In this situation, the only locking is by
22199 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22200 sure that every MUA that is ever going to look at your users' mailboxes uses
22201 &[fcntl()]& rather than a lock file, and even then only when you are not
22202 delivering over NFS from more than one host.
22203
22204 .cindex "NFS" "lock file"
22205 In order to append to an NFS file safely from more than one host, it is
22206 necessary to take out a lock &'before'& opening the file, and the lock file
22207 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22208 file corruption.
22209
22210 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22211 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22212 except when &%mbx_format%& is set.
22213
22214
22215 .option use_mbx_lock appendfile boolean "see below"
22216 This option is available only if Exim has been compiled with SUPPORT_MBX
22217 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22218 locking rules be used. It is set by default if &%mbx_format%& is set and none
22219 of the locking options are mentioned in the configuration. The locking rules
22220 are the same as are used by the &'c-client'& library that underlies Pine and
22221 the IMAP4 and POP daemons that come with it (see the discussion below). The
22222 rules allow for shared access to the mailbox. However, this kind of locking
22223 does not work when the mailbox is NFS mounted.
22224
22225 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22226 &%use_flock_lock%& to control what kind of locking is used in implementing the
22227 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22228 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22229
22230
22231
22232
22233 .section "Operational details for appending" "SECTopappend"
22234 .cindex "appending to a file"
22235 .cindex "file" "appending"
22236 Before appending to a file, the following preparations are made:
22237
22238 .ilist
22239 If the name of the file is &_/dev/null_&, no action is taken, and a success
22240 return is given.
22241
22242 .next
22243 .cindex "directory creation"
22244 If any directories on the file's path are missing, Exim creates them if the
22245 &%create_directory%& option is set. A created directory's mode is given by the
22246 &%directory_mode%& option.
22247
22248 .next
22249 If &%file_format%& is set, the format of an existing file is checked. If this
22250 indicates that a different transport should be used, control is passed to that
22251 transport.
22252
22253 .next
22254 .cindex "file" "locking"
22255 .cindex "locking files"
22256 .cindex "NFS" "lock file"
22257 If &%use_lockfile%& is set, a lock file is built in a way that will work
22258 reliably over NFS, as follows:
22259
22260 .olist
22261 Create a &"hitching post"& file whose name is that of the lock file with the
22262 current time, primary host name, and process id added, by opening for writing
22263 as a new file. If this fails with an access error, delivery is deferred.
22264 .next
22265 Close the hitching post file, and hard link it to the lock file name.
22266 .next
22267 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22268 Unlink the hitching post name.
22269 .next
22270 Otherwise, use &[stat()]& to get information about the hitching post file, and
22271 then unlink hitching post name. If the number of links is exactly two, creation
22272 of the lock file succeeded but something (for example, an NFS server crash and
22273 restart) caused this fact not to be communicated to the &[link()]& call.
22274 .next
22275 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22276 up to &%lock_retries%& times. However, since any program that writes to a
22277 mailbox should complete its task very quickly, it is reasonable to time out old
22278 lock files that are normally the result of user agent and system crashes. If an
22279 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22280 it before trying again.
22281 .endlist olist
22282
22283 .next
22284 A call is made to &[lstat()]& to discover whether the main file exists, and if
22285 so, what its characteristics are. If &[lstat()]& fails for any reason other
22286 than non-existence, delivery is deferred.
22287
22288 .next
22289 .cindex "symbolic link" "to mailbox"
22290 .cindex "mailbox" "symbolic link"
22291 If the file does exist and is a symbolic link, delivery is deferred, unless the
22292 &%allow_symlink%& option is set, in which case the ownership of the link is
22293 checked, and then &[stat()]& is called to find out about the real file, which
22294 is then subjected to the checks below. The check on the top-level link
22295 ownership prevents one user creating a link for another's mailbox in a sticky
22296 directory, though allowing symbolic links in this case is definitely not a good
22297 idea. If there is a chain of symbolic links, the intermediate ones are not
22298 checked.
22299
22300 .next
22301 If the file already exists but is not a regular file, or if the file's owner
22302 and group (if the group is being checked &-- see &%check_group%& above) are
22303 different from the user and group under which the delivery is running,
22304 delivery is deferred.
22305
22306 .next
22307 If the file's permissions are more generous than specified, they are reduced.
22308 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22309 is set false, in which case the delivery is tried using the existing
22310 permissions.
22311
22312 .next
22313 The file's inode number is saved, and the file is then opened for appending.
22314 If this fails because the file has vanished, &(appendfile)& behaves as if it
22315 hadn't existed (see below). For any other failures, delivery is deferred.
22316
22317 .next
22318 If the file is opened successfully, check that the inode number hasn't
22319 changed, that it is still a regular file, and that the owner and permissions
22320 have not changed. If anything is wrong, defer delivery and freeze the message.
22321
22322 .next
22323 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22324 option is set. Otherwise, check that the file is being created in a permitted
22325 directory if the &%create_file%& option is set (deferring on failure), and then
22326 open for writing as a new file, with the O_EXCL and O_CREAT options,
22327 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22328 set). In this case, which can happen if the link points to a non-existent file,
22329 the file is opened for writing using O_CREAT but not O_EXCL, because
22330 that prevents link following.
22331
22332 .next
22333 .cindex "loop" "while file testing"
22334 If opening fails because the file exists, obey the tests given above for
22335 existing files. However, to avoid looping in a situation where the file is
22336 being continuously created and destroyed, the exists/not-exists loop is broken
22337 after 10 repetitions, and the message is then frozen.
22338
22339 .next
22340 If opening fails with any other error, defer delivery.
22341
22342 .next
22343 .cindex "file" "locking"
22344 .cindex "locking files"
22345 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22346 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22347 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22348 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22349 file, and an exclusive lock on the file whose name is
22350 .code
22351 /tmp/.<device-number>.<inode-number>
22352 .endd
22353 using the device and inode numbers of the open mailbox file, in accordance with
22354 the MBX locking rules. This file is created with a mode that is specified by
22355 the &%lockfile_mode%& option.
22356
22357 If Exim fails to lock the file, there are two possible courses of action,
22358 depending on the value of the locking timeout. This is obtained from
22359 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22360
22361 If the timeout value is zero, the file is closed, Exim waits for
22362 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22363 to lock it again. This happens up to &%lock_retries%& times, after which the
22364 delivery is deferred.
22365
22366 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22367 &[flock()]& are used (with the given timeout), so there has already been some
22368 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22369 immediately. It retries up to
22370 .code
22371 (lock_retries * lock_interval) / <timeout>
22372 .endd
22373 times (rounded up).
22374 .endlist
22375
22376 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22377 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22378
22379
22380 .section "Operational details for delivery to a new file" "SECTopdir"
22381 .cindex "delivery" "to single file"
22382 .cindex "&""From""& line"
22383 When the &%directory%& option is set instead of &%file%&, each message is
22384 delivered into a newly-created file or set of files. When &(appendfile)& is
22385 activated directly from a &(redirect)& router, neither &%file%& nor
22386 &%directory%& is normally set, because the path for delivery is supplied by the
22387 router. (See for example, the &(address_file)& transport in the default
22388 configuration.) In this case, delivery is to a new file if either the path name
22389 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22390
22391 No locking is required while writing the message to a new file, so the various
22392 locking options of the transport are ignored. The &"From"& line that by default
22393 separates messages in a single file is not normally needed, nor is the escaping
22394 of message lines that start with &"From"&, and there is no need to ensure a
22395 newline at the end of each message. Consequently, the default values for
22396 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22397 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22398
22399 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22400 the files in the delivery directory by default. However, you can specify a
22401 different directory by setting &%quota_directory%&. Also, for maildir
22402 deliveries (see below) the &_maildirfolder_& convention is honoured.
22403
22404
22405 .cindex "maildir format"
22406 .cindex "mailstore format"
22407 There are three different ways in which delivery to individual files can be
22408 done, controlled by the settings of the &%maildir_format%& and
22409 &%mailstore_format%& options. Note that code to support maildir or mailstore
22410 formats is not included in the binary unless SUPPORT_MAILDIR or
22411 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22412
22413 .cindex "directory creation"
22414 In all three cases an attempt is made to create the directory and any necessary
22415 sub-directories if they do not exist, provided that the &%create_directory%&
22416 option is set (the default). The location of a created directory can be
22417 constrained by setting &%create_file%&. A created directory's mode is given by
22418 the &%directory_mode%& option. If creation fails, or if the
22419 &%create_directory%& option is not set when creation is required, delivery is
22420 deferred.
22421
22422
22423
22424 .section "Maildir delivery" "SECTmaildirdelivery"
22425 .cindex "maildir format" "description of"
22426 If the &%maildir_format%& option is true, Exim delivers each message by writing
22427 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22428 directory that is defined by the &%directory%& option (the &"delivery
22429 directory"&). If the delivery is successful, the file is renamed into the
22430 &_new_& subdirectory.
22431
22432 In the file name, <&'stime'&> is the current time of day in seconds, and
22433 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22434 Exim checks that the time-of-day clock has moved on by at least one microsecond
22435 before terminating the delivery process. This guarantees uniqueness for the
22436 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22437 opening it. If any response other than ENOENT (does not exist) is given,
22438 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22439
22440 Before Exim carries out a maildir delivery, it ensures that subdirectories
22441 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22442 do not exist, Exim tries to create them and any superior directories in their
22443 path, subject to the &%create_directory%& and &%create_file%& options. If the
22444 &%maildirfolder_create_regex%& option is set, and the regular expression it
22445 contains matches the delivery directory, Exim also ensures that a file called
22446 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22447 &_maildirfolder_& file cannot be created, delivery is deferred.
22448
22449 These features make it possible to use Exim to create all the necessary files
22450 and directories in a maildir mailbox, including subdirectories for maildir++
22451 folders. Consider this example:
22452 .code
22453 maildir_format = true
22454 directory = /var/mail/$local_part\
22455            ${if eq{$local_part_suffix}{}{}\
22456            {/.${substr_1:$local_part_suffix}}}
22457 maildirfolder_create_regex = /\.[^/]+$
22458 .endd
22459 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22460 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22461 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22462 not match this name, so Exim will not look for or create the file
22463 &_/var/mail/pimbo/maildirfolder_&, though it will create
22464 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22465
22466 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22467 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22468 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22469 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22470 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22471
22472 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22473 not inadvertently match the toplevel maildir directory, because a
22474 &_maildirfolder_& file at top level would completely break quota calculations.
22475
22476 .cindex "quota" "in maildir delivery"
22477 .cindex "maildir++"
22478 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22479 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22480 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22481 Exim assumes the directory is a maildir++ folder directory, which is one level
22482 down from the user's top level mailbox directory. This causes it to start at
22483 the parent directory instead of the current directory when calculating the
22484 amount of space used.
22485
22486 One problem with delivering into a multi-file mailbox is that it is
22487 computationally expensive to compute the size of the mailbox for quota
22488 checking. Various approaches have been taken to reduce the amount of work
22489 needed. The next two sections describe two of them. A third alternative is to
22490 use some external process for maintaining the size data, and use the expansion
22491 of the &%mailbox_size%& option as a way of importing it into Exim.
22492
22493
22494
22495
22496 .section "Using tags to record message sizes" "SECID135"
22497 If &%maildir_tag%& is set, the string is expanded for each delivery.
22498 When the maildir file is renamed into the &_new_& sub-directory, the
22499 tag is added to its name. However, if adding the tag takes the length of the
22500 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22501 the tag is dropped and the maildir file is created with no tag.
22502
22503
22504 .vindex "&$message_size$&"
22505 Tags can be used to encode the size of files in their names; see
22506 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22507 happens after the message has been written. The value of the &$message_size$&
22508 variable is set to the number of bytes actually written. If the expansion is
22509 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22510 be deferred. The expanded tag may contain any printing characters except &"/"&.
22511 Non-printing characters in the string are ignored; if the resulting string is
22512 empty, it is ignored. If it starts with an alphanumeric character, a leading
22513 colon is inserted; this default has not proven to be the path that popular
22514 maildir implementations have chosen (but changing it in Exim would break
22515 backwards compatibility).
22516
22517 For one common implementation, you might set:
22518 .code
22519 maildir_tag = ,S=${message_size}
22520 .endd
22521 but you should check the documentation of the other software to be sure.
22522
22523 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22524 as this allows Exim to extract the size from your tag, instead of having to
22525 &[stat()]& each message file.
22526
22527
22528 .section "Using a maildirsize file" "SECID136"
22529 .cindex "quota" "in maildir delivery"
22530 .cindex "maildir format" "&_maildirsize_& file"
22531 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22532 storing quota and message size information in a file called &_maildirsize_&
22533 within the toplevel maildir directory. If this file does not exist, Exim
22534 creates it, setting the quota from the &%quota%& option of the transport. If
22535 the maildir directory itself does not exist, it is created before any attempt
22536 to write a &_maildirsize_& file.
22537
22538 The &_maildirsize_& file is used to hold information about the sizes of
22539 messages in the maildir, thus speeding up quota calculations. The quota value
22540 in the file is just a cache; if the quota is changed in the transport, the new
22541 value overrides the cached value when the next message is delivered. The cache
22542 is maintained for the benefit of other programs that access the maildir and
22543 need to know the quota.
22544
22545 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22546 file is maintained (with a zero quota setting), but no quota is imposed.
22547
22548 A regular expression is available for controlling which directories in the
22549 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22550 See the description of the &%maildir_quota_directory_regex%& option above for
22551 details.
22552
22553
22554 .section "Mailstore delivery" "SECID137"
22555 .cindex "mailstore format" "description of"
22556 If the &%mailstore_format%& option is true, each message is written as two
22557 files in the given directory. A unique base name is constructed from the
22558 message id and the current delivery process, and the files that are written use
22559 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22560 contains the message's envelope, and the &_.msg_& file contains the message
22561 itself. The base name is placed in the variable &$mailstore_basename$&.
22562
22563 During delivery, the envelope is first written to a file with the suffix
22564 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22565 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22566 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22567 file before accessing either of them. An alternative approach is to wait for
22568 the absence of a &_.tmp_& file.
22569
22570 The envelope file starts with any text defined by the &%mailstore_prefix%&
22571 option, expanded and terminated by a newline if there isn't one. Then follows
22572 the sender address on one line, then all the recipient addresses, one per line.
22573 There can be more than one recipient only if the &%batch_max%& option is set
22574 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22575 appended to the file, followed by a newline if it does not end with one.
22576
22577 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22578 failure, it is ignored. Other expansion errors are treated as serious
22579 configuration errors, and delivery is deferred. The variable
22580 &$mailstore_basename$& is available for use during these expansions.
22581
22582
22583 .section "Non-special new file delivery" "SECID138"
22584 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22585 file is created directly in the named directory. For example, when delivering
22586 messages into files in batched SMTP format for later delivery to some host (see
22587 section &<<SECTbatchSMTP>>&), a setting such as
22588 .code
22589 directory = /var/bsmtp/$host
22590 .endd
22591 might be used. A message is written to a file with a temporary name, which is
22592 then renamed when the delivery is complete. The final name is obtained by
22593 expanding the contents of the &%directory_file%& option.
22594 .ecindex IIDapptra1
22595 .ecindex IIDapptra2
22596
22597
22598
22599
22600
22601
22602 . ////////////////////////////////////////////////////////////////////////////
22603 . ////////////////////////////////////////////////////////////////////////////
22604
22605 .chapter "The autoreply transport" "CHID8"
22606 .scindex IIDauttra1 "transports" "&(autoreply)&"
22607 .scindex IIDauttra2 "&(autoreply)& transport"
22608 The &(autoreply)& transport is not a true transport in that it does not cause
22609 the message to be transmitted. Instead, it generates a new mail message as an
22610 automatic reply to the incoming message. &'References:'& and
22611 &'Auto-Submitted:'& header lines are included. These are constructed according
22612 to the rules in RFCs 2822 and 3834, respectively.
22613
22614 If the router that passes the message to this transport does not have the
22615 &%unseen%& option set, the original message (for the current recipient) is not
22616 delivered anywhere. However, when the &%unseen%& option is set on the router
22617 that passes the message to this transport, routing of the address continues, so
22618 another router can set up a normal message delivery.
22619
22620
22621 The &(autoreply)& transport is usually run as the result of mail filtering, a
22622 &"vacation"& message being the standard example. However, it can also be run
22623 directly from a router like any other transport. To reduce the possibility of
22624 message cascades, messages created by the &(autoreply)& transport always have
22625 empty envelope sender addresses, like bounce messages.
22626
22627 The parameters of the message to be sent can be specified in the configuration
22628 by options described below. However, these are used only when the address
22629 passed to the transport does not contain its own reply information. When the
22630 transport is run as a consequence of a
22631 &%mail%&
22632 or &%vacation%& command in a filter file, the parameters of the message are
22633 supplied by the filter, and passed with the address. The transport's options
22634 that define the message are then ignored (so they are not usually set in this
22635 case). The message is specified entirely by the filter or by the transport; it
22636 is never built from a mixture of options. However, the &%file_optional%&,
22637 &%mode%&, and &%return_message%& options apply in all cases.
22638
22639 &(Autoreply)& is implemented as a local transport. When used as a result of a
22640 command in a user's filter file, &(autoreply)& normally runs under the uid and
22641 gid of the user, and with appropriate current and home directories (see chapter
22642 &<<CHAPenvironment>>&).
22643
22644 There is a subtle difference between routing a message to a &(pipe)& transport
22645 that generates some text to be returned to the sender, and routing it to an
22646 &(autoreply)& transport. This difference is noticeable only if more than one
22647 address from the same message is so handled. In the case of a pipe, the
22648 separate outputs from the different addresses are gathered up and returned to
22649 the sender in a single message, whereas if &(autoreply)& is used, a separate
22650 message is generated for each address that is passed to it.
22651
22652 Non-printing characters are not permitted in the header lines generated for the
22653 message that &(autoreply)& creates, with the exception of newlines that are
22654 immediately followed by white space. If any non-printing characters are found,
22655 the transport defers.
22656 Whether characters with the top bit set count as printing characters or not is
22657 controlled by the &%print_topbitchars%& global option.
22658
22659 If any of the generic options for manipulating headers (for example,
22660 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22661 of the original message that is included in the generated message when
22662 &%return_message%& is set. They do not apply to the generated message itself.
22663
22664 .vindex "&$sender_address$&"
22665 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22666 the message, indicating that there were no recipients, it does not treat this
22667 as an error. This means that autoreplies sent to &$sender_address$& when this
22668 is empty (because the incoming message is a bounce message) do not cause
22669 problems. They are just discarded.
22670
22671
22672
22673 .section "Private options for autoreply" "SECID139"
22674 .cindex "options" "&(autoreply)& transport"
22675
22676 .option bcc autoreply string&!! unset
22677 This specifies the addresses that are to receive &"blind carbon copies"& of the
22678 message when the message is specified by the transport.
22679
22680
22681 .option cc autoreply string&!! unset
22682 This specifies recipients of the message and the contents of the &'Cc:'& header
22683 when the message is specified by the transport.
22684
22685
22686 .option file autoreply string&!! unset
22687 The contents of the file are sent as the body of the message when the message
22688 is specified by the transport. If both &%file%& and &%text%& are set, the text
22689 string comes first.
22690
22691
22692 .option file_expand autoreply boolean false
22693 If this is set, the contents of the file named by the &%file%& option are
22694 subjected to string expansion as they are added to the message.
22695
22696
22697 .option file_optional autoreply boolean false
22698 If this option is true, no error is generated if the file named by the &%file%&
22699 option or passed with the address does not exist or cannot be read.
22700
22701
22702 .option from autoreply string&!! unset
22703 This specifies the contents of the &'From:'& header when the message is
22704 specified by the transport.
22705
22706
22707 .option headers autoreply string&!! unset
22708 This specifies additional RFC 2822 headers that are to be added to the message
22709 when the message is specified by the transport. Several can be given by using
22710 &"\n"& to separate them. There is no check on the format.
22711
22712
22713 .option log autoreply string&!! unset
22714 This option names a file in which a record of every message sent is logged when
22715 the message is specified by the transport.
22716
22717
22718 .option mode autoreply "octal integer" 0600
22719 If either the log file or the &"once"& file has to be created, this mode is
22720 used.
22721
22722
22723 .option never_mail autoreply "address list&!!" unset
22724 If any run of the transport creates a message with a recipient that matches any
22725 item in the list, that recipient is quietly discarded. If all recipients are
22726 discarded, no message is created. This applies both when the recipients are
22727 generated by a filter and when they are specified in the transport.
22728
22729
22730
22731 .option once autoreply string&!! unset
22732 This option names a file or DBM database in which a record of each &'To:'&
22733 recipient is kept when the message is specified by the transport. &*Note*&:
22734 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22735
22736 If &%once%& is unset, or is set to an empty string, the message is always sent.
22737 By default, if &%once%& is set to a non-empty file name, the message
22738 is not sent if a potential recipient is already listed in the database.
22739 However, if the &%once_repeat%& option specifies a time greater than zero, the
22740 message is sent if that much time has elapsed since a message was last sent to
22741 this recipient. A setting of zero time for &%once_repeat%& (the default)
22742 prevents a message from being sent a second time &-- in this case, zero means
22743 infinity.
22744
22745 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22746 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22747 greater than zero, it changes the way Exim implements the &%once%& option.
22748 Instead of using a DBM file to record every recipient it sends to, it uses a
22749 regular file, whose size will never get larger than the given value.
22750
22751 In the file, Exim keeps a linear list of recipient addresses and the times at
22752 which they were sent messages. If the file is full when a new address needs to
22753 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22754 means that a given recipient may receive multiple messages, but at
22755 unpredictable intervals that depend on the rate of turnover of addresses in the
22756 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22757
22758
22759 .option once_file_size autoreply integer 0
22760 See &%once%& above.
22761
22762
22763 .option once_repeat autoreply time&!! 0s
22764 See &%once%& above.
22765 After expansion, the value of this option must be a valid time value.
22766
22767
22768 .option reply_to autoreply string&!! unset
22769 This specifies the contents of the &'Reply-To:'& header when the message is
22770 specified by the transport.
22771
22772
22773 .option return_message autoreply boolean false
22774 If this is set, a copy of the original message is returned with the new
22775 message, subject to the maximum size set in the &%return_size_limit%& global
22776 configuration option.
22777
22778
22779 .option subject autoreply string&!! unset
22780 This specifies the contents of the &'Subject:'& header when the message is
22781 specified by the transport. It is tempting to quote the original subject in
22782 automatic responses. For example:
22783 .code
22784 subject = Re: $h_subject:
22785 .endd
22786 There is a danger in doing this, however. It may allow a third party to
22787 subscribe your users to an opt-in mailing list, provided that the list accepts
22788 bounce messages as subscription confirmations. Well-managed lists require a
22789 non-bounce message to confirm a subscription, so the danger is relatively
22790 small.
22791
22792
22793
22794 .option text autoreply string&!! unset
22795 This specifies a single string to be used as the body of the message when the
22796 message is specified by the transport. If both &%text%& and &%file%& are set,
22797 the text comes first.
22798
22799
22800 .option to autoreply string&!! unset
22801 This specifies recipients of the message and the contents of the &'To:'& header
22802 when the message is specified by the transport.
22803 .ecindex IIDauttra1
22804 .ecindex IIDauttra2
22805
22806
22807
22808
22809 . ////////////////////////////////////////////////////////////////////////////
22810 . ////////////////////////////////////////////////////////////////////////////
22811
22812 .chapter "The lmtp transport" "CHAPLMTP"
22813 .cindex "transports" "&(lmtp)&"
22814 .cindex "&(lmtp)& transport"
22815 .cindex "LMTP" "over a pipe"
22816 .cindex "LMTP" "over a socket"
22817 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22818 specified command
22819 or by interacting with a Unix domain socket.
22820 This transport is something of a cross between the &(pipe)& and &(smtp)&
22821 transports. Exim also has support for using LMTP over TCP/IP; this is
22822 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22823 to be of minority interest, the default build-time configure in &_src/EDITME_&
22824 has it commented out. You need to ensure that
22825 .code
22826 TRANSPORT_LMTP=yes
22827 .endd
22828 .cindex "options" "&(lmtp)& transport"
22829 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22830 included in the Exim binary. The private options of the &(lmtp)& transport are
22831 as follows:
22832
22833 .option batch_id lmtp string&!! unset
22834 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22835
22836
22837 .option batch_max lmtp integer 1
22838 This limits the number of addresses that can be handled in a single delivery.
22839 Most LMTP servers can handle several addresses at once, so it is normally a
22840 good idea to increase this value. See the description of local delivery
22841 batching in chapter &<<CHAPbatching>>&.
22842
22843
22844 .option command lmtp string&!! unset
22845 This option must be set if &%socket%& is not set. The string is a command which
22846 is run in a separate process. It is split up into a command name and list of
22847 arguments, each of which is separately expanded (so expansion cannot change the
22848 number of arguments). The command is run directly, not via a shell. The message
22849 is passed to the new process using the standard input and output to operate the
22850 LMTP protocol.
22851
22852 .option ignore_quota lmtp boolean false
22853 .cindex "LMTP" "ignoring quota errors"
22854 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22855 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22856 in its response to the LHLO command.
22857
22858 .option socket lmtp string&!! unset
22859 This option must be set if &%command%& is not set. The result of expansion must
22860 be the name of a Unix domain socket. The transport connects to the socket and
22861 delivers the message to it using the LMTP protocol.
22862
22863
22864 .option timeout lmtp time 5m
22865 The transport is aborted if the created process or Unix domain socket does not
22866 respond to LMTP commands or message input within this timeout. Delivery
22867 is deferred, and will be tried again later. Here is an example of a typical
22868 LMTP transport:
22869 .code
22870 lmtp:
22871   driver = lmtp
22872   command = /some/local/lmtp/delivery/program
22873   batch_max = 20
22874   user = exim
22875 .endd
22876 This delivers up to 20 addresses at a time, in a mixture of domains if
22877 necessary, running as the user &'exim'&.
22878
22879
22880
22881 . ////////////////////////////////////////////////////////////////////////////
22882 . ////////////////////////////////////////////////////////////////////////////
22883
22884 .chapter "The pipe transport" "CHAPpipetransport"
22885 .scindex IIDpiptra1 "transports" "&(pipe)&"
22886 .scindex IIDpiptra2 "&(pipe)& transport"
22887 The &(pipe)& transport is used to deliver messages via a pipe to a command
22888 running in another process. One example is the use of &(pipe)& as a
22889 pseudo-remote transport for passing messages to some other delivery mechanism
22890 (such as UUCP). Another is the use by individual users to automatically process
22891 their incoming messages. The &(pipe)& transport can be used in one of the
22892 following ways:
22893
22894 .ilist
22895 .vindex "&$local_part$&"
22896 A router routes one address to a transport in the normal way, and the
22897 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22898 contains the local part of the address (as usual), and the command that is run
22899 is specified by the &%command%& option on the transport.
22900 .next
22901 .vindex "&$pipe_addresses$&"
22902 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22903 transport can handle more than one address in a single run. In this case, when
22904 more than one address is routed to the transport, &$local_part$& is not set
22905 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22906 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22907 that are routed to the transport.
22908 .next
22909 .vindex "&$address_pipe$&"
22910 A router redirects an address directly to a pipe command (for example, from an
22911 alias or forward file). In this case, &$address_pipe$& contains the text of the
22912 pipe command, and the &%command%& option on the transport is ignored unless
22913 &%force_command%& is set. If only one address is being transported
22914 (&%batch_max%& is not greater than one, or only one address was redirected to
22915 this pipe command), &$local_part$& contains the local part that was redirected.
22916 .endlist
22917
22918
22919 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22920 deliver messages over pipes using the LMTP interactive protocol. This is
22921 implemented by the &(lmtp)& transport.
22922
22923 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22924 &_.forward_& file, the command runs under the uid and gid of that user. In
22925 other cases, the uid and gid have to be specified explicitly, either on the
22926 transport or on the router that handles the address. Current and &"home"&
22927 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22928 details of the local delivery environment and chapter &<<CHAPbatching>>&
22929 for a discussion of local delivery batching.
22930
22931
22932 .section "Concurrent delivery" "SECID140"
22933 If two messages arrive at almost the same time, and both are routed to a pipe
22934 delivery, the two pipe transports may be run concurrently. You must ensure that
22935 any pipe commands you set up are robust against this happening. If the commands
22936 write to a file, the &%exim_lock%& utility might be of use.
22937 Alternatively the &%max_parallel%& option could be used with a value
22938 of "1" to enforce serialization.
22939
22940
22941
22942
22943 .section "Returned status and data" "SECID141"
22944 .cindex "&(pipe)& transport" "returned data"
22945 If the command exits with a non-zero return code, the delivery is deemed to
22946 have failed, unless either the &%ignore_status%& option is set (in which case
22947 the return code is treated as zero), or the return code is one of those listed
22948 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22949 later"&. In this case, delivery is deferred. Details of a permanent failure are
22950 logged, but are not included in the bounce message, which merely contains
22951 &"local delivery failed"&.
22952
22953 If the command exits on a signal and the &%freeze_signal%& option is set then
22954 the message will be frozen in the queue. If that option is not set, a bounce
22955 will be sent as normal.
22956
22957 If the return code is greater than 128 and the command being run is a shell
22958 script, it normally means that the script was terminated by a signal whose
22959 value is the return code minus 128. The &%freeze_signal%& option does not
22960 apply in this case.
22961
22962 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22963 return code is set to 127. This is the value that a shell returns if it is
22964 asked to run a non-existent command. The wording for the log line suggests that
22965 a non-existent command may be the problem.
22966
22967 The &%return_output%& option can affect the result of a pipe delivery. If it is
22968 set and the command produces any output on its standard output or standard
22969 error streams, the command is considered to have failed, even if it gave a zero
22970 return code or if &%ignore_status%& is set. The output from the command is
22971 included as part of the bounce message. The &%return_fail_output%& option is
22972 similar, except that output is returned only when the command exits with a
22973 failure return code, that is, a value other than zero or a code that matches
22974 &%temp_errors%&.
22975
22976
22977
22978 .section "How the command is run" "SECThowcommandrun"
22979 .cindex "&(pipe)& transport" "path for command"
22980 The command line is (by default) broken down into a command name and arguments
22981 by the &(pipe)& transport itself. The &%allow_commands%& and
22982 &%restrict_to_path%& options can be used to restrict the commands that may be
22983 run.
22984
22985 .cindex "quoting" "in pipe command"
22986 Unquoted arguments are delimited by white space. If an argument appears in
22987 double quotes, backslash is interpreted as an escape character in the usual
22988 way. If an argument appears in single quotes, no escaping is done.
22989
22990 String expansion is applied to the command line except when it comes from a
22991 traditional &_.forward_& file (commands from a filter file are expanded). The
22992 expansion is applied to each argument in turn rather than to the whole line.
22993 For this reason, any string expansion item that contains white space must be
22994 quoted so as to be contained within a single argument. A setting such as
22995 .code
22996 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22997 .endd
22998 will not work, because the expansion item gets split between several
22999 arguments. You have to write
23000 .code
23001 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23002 .endd
23003 to ensure that it is all in one argument. The expansion is done in this way,
23004 argument by argument, so that the number of arguments cannot be changed as a
23005 result of expansion, and quotes or backslashes in inserted variables do not
23006 interact with external quoting. However, this leads to problems if you want to
23007 generate multiple arguments (or the command name plus arguments) from a single
23008 expansion. In this situation, the simplest solution is to use a shell. For
23009 example:
23010 .code
23011 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23012 .endd
23013
23014 .cindex "transport" "filter"
23015 .cindex "filter" "transport filter"
23016 .vindex "&$pipe_addresses$&"
23017 Special handling takes place when an argument consists of precisely the text
23018 &`$pipe_addresses`&. This is not a general expansion variable; the only
23019 place this string is recognized is when it appears as an argument for a pipe or
23020 transport filter command. It causes each address that is being handled to be
23021 inserted in the argument list at that point &'as a separate argument'&. This
23022 avoids any problems with spaces or shell metacharacters, and is of use when a
23023 &(pipe)& transport is handling groups of addresses in a batch.
23024
23025 If &%force_command%& is enabled on the transport, Special handling takes place
23026 for an argument that consists of precisely the text &`$address_pipe`&.  It
23027 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23028 argument is inserted in the argument list at that point
23029 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23030 the only item in the argument; in fact, if it were then &%force_command%&
23031 should behave as a no-op.  Rather, it should be used to adjust the command
23032 run while preserving the argument vector separation.
23033
23034 After splitting up into arguments and expansion, the resulting command is run
23035 in a subprocess directly from the transport, &'not'& under a shell. The
23036 message that is being delivered is supplied on the standard input, and the
23037 standard output and standard error are both connected to a single pipe that is
23038 read by Exim. The &%max_output%& option controls how much output the command
23039 may produce, and the &%return_output%& and &%return_fail_output%& options
23040 control what is done with it.
23041
23042 Not running the command under a shell (by default) lessens the security risks
23043 in cases when a command from a user's filter file is built out of data that was
23044 taken from an incoming message. If a shell is required, it can of course be
23045 explicitly specified as the command to be run. However, there are circumstances
23046 where existing commands (for example, in &_.forward_& files) expect to be run
23047 under a shell and cannot easily be modified. To allow for these cases, there is
23048 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23049 works. Instead of breaking up the command line as just described, it expands it
23050 as a single string and passes the result to &_/bin/sh_&. The
23051 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23052 with &%use_shell%&, and the whole mechanism is inherently less secure.
23053
23054
23055
23056 .section "Environment variables" "SECTpipeenv"
23057 .cindex "&(pipe)& transport" "environment for command"
23058 .cindex "environment" "&(pipe)& transport"
23059 The environment variables listed below are set up when the command is invoked.
23060 This list is a compromise for maximum compatibility with other MTAs. Note that
23061 the &%environment%& option can be used to add additional variables to this
23062 environment. The environment for the &(pipe)& transport is not subject
23063 to the &%add_environment%& and &%keep_environment%& main config options.
23064 .display
23065 &`DOMAIN            `&   the domain of the address
23066 &`HOME              `&   the home directory, if set
23067 &`HOST              `&   the host name when called from a router (see below)
23068 &`LOCAL_PART        `&   see below
23069 &`LOCAL_PART_PREFIX `&   see below
23070 &`LOCAL_PART_SUFFIX `&   see below
23071 &`LOGNAME           `&   see below
23072 &`MESSAGE_ID        `&   Exim's local ID for the message
23073 &`PATH              `&   as specified by the &%path%& option below
23074 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23075 &`RECIPIENT         `&   the complete recipient address
23076 &`SENDER            `&   the sender of the message (empty if a bounce)
23077 &`SHELL             `&   &`/bin/sh`&
23078 &`TZ                `&   the value of the &%timezone%& option, if set
23079 &`USER              `&   see below
23080 .endd
23081 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23082 router, LOCAL_PART is set to the local part of the address. When it is
23083 called as a result of a forward or alias expansion, LOCAL_PART is set to
23084 the local part of the address that was expanded. In both cases, any affixes are
23085 removed from the local part, and made available in LOCAL_PART_PREFIX and
23086 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23087 same value as LOCAL_PART for compatibility with other MTAs.
23088
23089 .cindex "HOST"
23090 HOST is set only when a &(pipe)& transport is called from a router that
23091 associates hosts with an address, typically when using &(pipe)& as a
23092 pseudo-remote transport. HOST is set to the first host name specified by
23093 the router.
23094
23095 .cindex "HOME"
23096 If the transport's generic &%home_directory%& option is set, its value is used
23097 for the HOME environment variable. Otherwise, a home directory may be set
23098 by the router's &%transport_home_directory%& option, which defaults to the
23099 user's home directory if &%check_local_user%& is set.
23100
23101
23102 .section "Private options for pipe" "SECID142"
23103 .cindex "options" "&(pipe)& transport"
23104
23105
23106
23107 .option allow_commands pipe "string list&!!" unset
23108 .cindex "&(pipe)& transport" "permitted commands"
23109 The string is expanded, and is then interpreted as a colon-separated list of
23110 permitted commands. If &%restrict_to_path%& is not set, the only commands
23111 permitted are those in the &%allow_commands%& list. They need not be absolute
23112 paths; the &%path%& option is still used for relative paths. If
23113 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23114 in the &%allow_commands%& list, or a name without any slashes that is found on
23115 the path. In other words, if neither &%allow_commands%& nor
23116 &%restrict_to_path%& is set, there is no restriction on the command, but
23117 otherwise only commands that are permitted by one or the other are allowed. For
23118 example, if
23119 .code
23120 allow_commands = /usr/bin/vacation
23121 .endd
23122 and &%restrict_to_path%& is not set, the only permitted command is
23123 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23124 &%use_shell%& is set.
23125
23126
23127 .option batch_id pipe string&!! unset
23128 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23129
23130
23131 .option batch_max pipe integer 1
23132 This limits the number of addresses that can be handled in a single delivery.
23133 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23134
23135
23136 .option check_string pipe string unset
23137 As &(pipe)& writes the message, the start of each line is tested for matching
23138 &%check_string%&, and if it does, the initial matching characters are replaced
23139 by the contents of &%escape_string%&, provided both are set. The value of
23140 &%check_string%& is a literal string, not a regular expression, and the case of
23141 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23142 of &%check_string%& and &%escape_string%& are forced to values that implement
23143 the SMTP escaping protocol. Any settings made in the configuration file are
23144 ignored.
23145
23146
23147 .option command pipe string&!! unset
23148 This option need not be set when &(pipe)& is being used to deliver to pipes
23149 obtained directly from address redirections. In other cases, the option must be
23150 set, to provide a command to be run. It need not yield an absolute path (see
23151 the &%path%& option below). The command is split up into separate arguments by
23152 Exim, and each argument is separately expanded, as described in section
23153 &<<SECThowcommandrun>>& above.
23154
23155
23156 .option environment pipe string&!! unset
23157 .cindex "&(pipe)& transport" "environment for command"
23158 .cindex "environment" "&(pipe)& transport"
23159 This option is used to add additional variables to the environment in which the
23160 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23161 a string which is expanded, and then interpreted as a colon-separated list of
23162 environment settings of the form <&'name'&>=<&'value'&>.
23163
23164
23165 .option escape_string pipe string unset
23166 See &%check_string%& above.
23167
23168
23169 .option freeze_exec_fail pipe boolean false
23170 .cindex "exec failure"
23171 .cindex "failure of exec"
23172 .cindex "&(pipe)& transport" "failure of exec"
23173 Failure to exec the command in a pipe transport is by default treated like
23174 any other failure while running the command. However, if &%freeze_exec_fail%&
23175 is set, failure to exec is treated specially, and causes the message to be
23176 frozen, whatever the setting of &%ignore_status%&.
23177
23178
23179 .option freeze_signal pipe boolean false
23180 .cindex "signal exit"
23181 .cindex "&(pipe)& transport", "signal exit"
23182 Normally if the process run by a command in a pipe transport exits on a signal,
23183 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23184 frozen in Exim's queue instead.
23185
23186
23187 .option force_command pipe boolean false
23188 .cindex "force command"
23189 .cindex "&(pipe)& transport", "force command"
23190 Normally when a router redirects an address directly to a pipe command
23191 the &%command%& option on the transport is ignored.  If &%force_command%&
23192 is set, the &%command%& option will used. This is especially
23193 useful for forcing a wrapper or additional argument to be added to the
23194 command. For example:
23195 .code
23196 command = /usr/bin/remote_exec myhost -- $address_pipe
23197 force_command
23198 .endd
23199
23200 Note that &$address_pipe$& is handled specially in &%command%& when
23201 &%force_command%& is set, expanding out to the original argument vector as
23202 separate items, similarly to a Unix shell &`"$@"`& construct.
23203
23204
23205 .option ignore_status pipe boolean false
23206 If this option is true, the status returned by the subprocess that is set up to
23207 run the command is ignored, and Exim behaves as if zero had been returned.
23208 Otherwise, a non-zero status or termination by signal causes an error return
23209 from the transport unless the status value is one of those listed in
23210 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23211
23212 &*Note*&: This option does not apply to timeouts, which do not return a status.
23213 See the &%timeout_defer%& option for how timeouts are handled.
23214
23215
23216 .option log_defer_output pipe boolean false
23217 .cindex "&(pipe)& transport" "logging output"
23218 If this option is set, and the status returned by the command is
23219 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23220 and any output was produced on stdout or stderr, the first line of it is
23221 written to the main log.
23222
23223
23224 .option log_fail_output pipe boolean false
23225 If this option is set, and the command returns any output on stdout or
23226 stderr, and also ends with a return code that is neither zero nor one of
23227 the return codes listed in &%temp_errors%& (that is, the delivery
23228 failed), the first line of output is written to the main log. This
23229 option and &%log_output%& are mutually exclusive.  Only one of them may
23230 be set.
23231
23232
23233 .option log_output pipe boolean false
23234 If this option is set and the command returns any output on stdout or
23235 stderr, the first line of output is written to the main log, whatever
23236 the return code. This option and &%log_fail_output%& are mutually
23237 exclusive. Only one of them may be set.
23238
23239
23240 .option max_output pipe integer 20K
23241 This specifies the maximum amount of output that the command may produce on its
23242 standard output and standard error file combined. If the limit is exceeded, the
23243 process running the command is killed. This is intended as a safety measure to
23244 catch runaway processes. The limit is applied independently of the settings of
23245 the options that control what is done with such output (for example,
23246 &%return_output%&). Because of buffering effects, the amount of output may
23247 exceed the limit by a small amount before Exim notices.
23248
23249
23250 .option message_prefix pipe string&!! "see below"
23251 The string specified here is expanded and output at the start of every message.
23252 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23253 .code
23254 message_prefix = \
23255   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23256   ${tod_bsdinbox}\n
23257 .endd
23258 .cindex "Cyrus"
23259 .cindex "&%tmail%&"
23260 .cindex "&""From""& line"
23261 This is required by the commonly used &_/usr/bin/vacation_& program.
23262 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23263 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23264 setting
23265 .code
23266 message_prefix =
23267 .endd
23268 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23269 &`\n`& to &`\r\n`& in &%message_prefix%&.
23270
23271
23272 .option message_suffix pipe string&!! "see below"
23273 The string specified here is expanded and output at the end of every message.
23274 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23275 The suffix can be suppressed by setting
23276 .code
23277 message_suffix =
23278 .endd
23279 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23280 &`\n`& to &`\r\n`& in &%message_suffix%&.
23281
23282
23283 .option path pipe string "see below"
23284 This option specifies the string that is set up in the PATH environment
23285 variable of the subprocess. The default is:
23286 .code
23287 /bin:/usr/bin
23288 .endd
23289 If the &%command%& option does not yield an absolute path name, the command is
23290 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23291 apply to a command specified as a transport filter.
23292
23293
23294 .option permit_coredump pipe boolean false
23295 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23296 a core-dump of a pipe command, enable this command.  This enables core-dumps
23297 during delivery and affects both the Exim binary and the pipe command run.
23298 It is recommended that this option remain off unless and until you have a need
23299 for it and that this only be enabled when needed, as the risk of excessive
23300 resource consumption can be quite high.  Note also that Exim is typically
23301 installed as a setuid binary and most operating systems will inhibit coredumps
23302 of these by default, so further OS-specific action may be required.
23303
23304
23305 .option pipe_as_creator pipe boolean false
23306 .cindex "uid (user id)" "local delivery"
23307 If the generic &%user%& option is not set and this option is true, the delivery
23308 process is run under the uid that was in force when Exim was originally called
23309 to accept the message. If the group id is not otherwise set (via the generic
23310 &%group%& option), the gid that was in force when Exim was originally called to
23311 accept the message is used.
23312
23313
23314 .option restrict_to_path pipe boolean false
23315 When this option is set, any command name not listed in &%allow_commands%& must
23316 contain no slashes. The command is searched for only in the directories listed
23317 in the &%path%& option. This option is intended for use in the case when a pipe
23318 command has been generated from a user's &_.forward_& file. This is usually
23319 handled by a &(pipe)& transport called &%address_pipe%&.
23320
23321
23322 .option return_fail_output pipe boolean false
23323 If this option is true, and the command produced any output and ended with a
23324 return code other than zero or one of the codes listed in &%temp_errors%& (that
23325 is, the delivery failed), the output is returned in the bounce message.
23326 However, if the message has a null sender (that is, it is itself a bounce
23327 message), output from the command is discarded. This option and
23328 &%return_output%& are mutually exclusive. Only one of them may be set.
23329
23330
23331
23332 .option return_output pipe boolean false
23333 If this option is true, and the command produced any output, the delivery is
23334 deemed to have failed whatever the return code from the command, and the output
23335 is returned in the bounce message. Otherwise, the output is just discarded.
23336 However, if the message has a null sender (that is, it is a bounce message),
23337 output from the command is always discarded, whatever the setting of this
23338 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23339 of them may be set.
23340
23341
23342
23343 .option temp_errors pipe "string list" "see below"
23344 .cindex "&(pipe)& transport" "temporary failure"
23345 This option contains either a colon-separated list of numbers, or a single
23346 asterisk. If &%ignore_status%& is false
23347 and &%return_output%& is not set,
23348 and the command exits with a non-zero return code, the failure is treated as
23349 temporary and the delivery is deferred if the return code matches one of the
23350 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23351 codes are treated as permanent errors. The default setting contains the codes
23352 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23353 compiled on a system that does not define these macros, it assumes values of 75
23354 and 73, respectively.
23355
23356
23357 .option timeout pipe time 1h
23358 If the command fails to complete within this time, it is killed. This normally
23359 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23360 specifies no timeout. In order to ensure that any subprocesses created by the
23361 command are also killed, Exim makes the initial process a process group leader,
23362 and kills the whole process group on a timeout. However, this can be defeated
23363 if one of the processes starts a new process group.
23364
23365 .option timeout_defer pipe boolean false
23366 A timeout in a &(pipe)& transport, either in the command that the transport
23367 runs, or in a transport filter that is associated with it, is by default
23368 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23369 is set true, both kinds of timeout become temporary errors, causing the
23370 delivery to be deferred.
23371
23372 .option umask pipe "octal integer" 022
23373 This specifies the umask setting for the subprocess that runs the command.
23374
23375
23376 .option use_bsmtp pipe boolean false
23377 .cindex "envelope sender"
23378 If this option is set true, the &(pipe)& transport writes messages in &"batch
23379 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23380 commands. If you want to include a leading HELO command with such messages,
23381 you can do so by setting the &%message_prefix%& option. See section
23382 &<<SECTbatchSMTP>>& for details of batch SMTP.
23383
23384 .option use_classresources pipe boolean false
23385 .cindex "class resources (BSD)"
23386 This option is available only when Exim is running on FreeBSD, NetBSD, or
23387 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23388 resource limits when a &(pipe)& transport is run to perform a delivery. The
23389 limits for the uid under which the pipe is to run are obtained from the login
23390 class database.
23391
23392
23393 .option use_crlf pipe boolean false
23394 .cindex "carriage return"
23395 .cindex "linefeed"
23396 This option causes lines to be terminated with the two-character CRLF sequence
23397 (carriage return, linefeed) instead of just a linefeed character. In the case
23398 of batched SMTP, the byte sequence written to the pipe is then an exact image
23399 of what would be sent down a real SMTP connection.
23400
23401 The contents of the &%message_prefix%& and &%message_suffix%& options are
23402 written verbatim, so must contain their own carriage return characters if these
23403 are needed. When &%use_bsmtp%& is not set, the default values for both
23404 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23405 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23406
23407
23408 .option use_shell pipe boolean false
23409 .vindex "&$pipe_addresses$&"
23410 If this option is set, it causes the command to be passed to &_/bin/sh_&
23411 instead of being run directly from the transport, as described in section
23412 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23413 where the command is expected to be run under a shell and cannot easily be
23414 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23415 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23416 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23417 its &%-c%& option.
23418
23419
23420
23421 .section "Using an external local delivery agent" "SECID143"
23422 .cindex "local delivery" "using an external agent"
23423 .cindex "&'procmail'&"
23424 .cindex "external local delivery"
23425 .cindex "delivery" "&'procmail'&"
23426 .cindex "delivery" "by external agent"
23427 The &(pipe)& transport can be used to pass all messages that require local
23428 delivery to a separate local delivery agent such as &%procmail%&. When doing
23429 this, care must be taken to ensure that the pipe is run under an appropriate
23430 uid and gid. In some configurations one wants this to be a uid that is trusted
23431 by the delivery agent to supply the correct sender of the message. It may be
23432 necessary to recompile or reconfigure the delivery agent so that it trusts an
23433 appropriate user. The following is an example transport and router
23434 configuration for &%procmail%&:
23435 .code
23436 # transport
23437 procmail_pipe:
23438   driver = pipe
23439   command = /usr/local/bin/procmail -d $local_part
23440   return_path_add
23441   delivery_date_add
23442   envelope_to_add
23443   check_string = "From "
23444   escape_string = ">From "
23445   umask = 077
23446   user = $local_part
23447   group = mail
23448
23449 # router
23450 procmail:
23451   driver = accept
23452   check_local_user
23453   transport = procmail_pipe
23454 .endd
23455 In this example, the pipe is run as the local user, but with the group set to
23456 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23457 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23458 user to supply a correct sender address. If you do not specify either a
23459 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23460 home directory is the user's home directory by default.
23461
23462 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23463 .code
23464 IFS=" "
23465 .endd
23466 as shown in some &%procmail%& documentation, because Exim does not by default
23467 use a shell to run pipe commands.
23468
23469 .cindex "Cyrus"
23470 The next example shows a transport and a router for a system where local
23471 deliveries are handled by the Cyrus IMAP server.
23472 .code
23473 # transport
23474 local_delivery_cyrus:
23475   driver = pipe
23476   command = /usr/cyrus/bin/deliver \
23477             -m ${substr_1:$local_part_suffix} -- $local_part
23478   user = cyrus
23479   group = mail
23480   return_output
23481   log_output
23482   message_prefix =
23483   message_suffix =
23484
23485 # router
23486 local_user_cyrus:
23487   driver = accept
23488   check_local_user
23489   local_part_suffix = .*
23490   transport = local_delivery_cyrus
23491 .endd
23492 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23493 &%return_output%& to cause any text written by Cyrus to be returned to the
23494 sender.
23495 .ecindex IIDpiptra1
23496 .ecindex IIDpiptra2
23497
23498
23499 . ////////////////////////////////////////////////////////////////////////////
23500 . ////////////////////////////////////////////////////////////////////////////
23501
23502 .chapter "The smtp transport" "CHAPsmtptrans"
23503 .scindex IIDsmttra1 "transports" "&(smtp)&"
23504 .scindex IIDsmttra2 "&(smtp)& transport"
23505 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23506 or LMTP protocol. The list of hosts to try can either be taken from the address
23507 that is being processed (having been set up by the router), or specified
23508 explicitly for the transport. Timeout and retry processing (see chapter
23509 &<<CHAPretry>>&) is applied to each IP address independently.
23510
23511
23512 .section "Multiple messages on a single connection" "SECID144"
23513 The sending of multiple messages over a single TCP/IP connection can arise in
23514 two ways:
23515
23516 .ilist
23517 If a message contains more than &%max_rcpt%& (see below) addresses that are
23518 routed to the same host, more than one copy of the message has to be sent to
23519 that host. In this situation, multiple copies may be sent in a single run of
23520 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23521 does when it has too many addresses to send in one message also depends on the
23522 value of the global &%remote_max_parallel%& option. Details are given in
23523 section &<<SECToutSMTPTCP>>&.)
23524 .next
23525 .cindex "hints database" "remembering routing"
23526 When a message has been successfully delivered over a TCP/IP connection, Exim
23527 looks in its hints database to see if there are any other messages awaiting a
23528 connection to the same host. If there are, a new delivery process is started
23529 for one of them, and the current TCP/IP connection is passed on to it. The new
23530 process may in turn send multiple copies and possibly create yet another
23531 process.
23532 .endlist
23533
23534
23535 For each copy sent over the same TCP/IP connection, a sequence counter is
23536 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23537 no further messages are sent over that connection.
23538
23539
23540
23541 .section "Use of the $host and $host_address variables" "SECID145"
23542 .vindex "&$host$&"
23543 .vindex "&$host_address$&"
23544 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23545 &$host_address$& are the name and IP address of the first host on the host list
23546 passed by the router. However, when the transport is about to connect to a
23547 specific host, and while it is connected to that host, &$host$& and
23548 &$host_address$& are set to the values for that host. These are the values
23549 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23550 &%serialize_hosts%&, and the various TLS options are expanded.
23551
23552
23553 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23554 .vindex &$tls_bits$&
23555 .vindex &$tls_cipher$&
23556 .vindex &$tls_peerdn$&
23557 .vindex &$tls_sni$&
23558 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23559 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23560 are the values that were set when the message was received.
23561 These are the values that are used for options that are expanded before any
23562 SMTP connections are made. Just before each connection is made, these four
23563 variables are emptied. If TLS is subsequently started, they are set to the
23564 appropriate values for the outgoing connection, and these are the values that
23565 are in force when any authenticators are run and when the
23566 &%authenticated_sender%& option is expanded.
23567
23568 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23569 and will be removed in a future release.
23570
23571
23572 .section "Private options for smtp" "SECID146"
23573 .cindex "options" "&(smtp)& transport"
23574 The private options of the &(smtp)& transport are as follows:
23575
23576
23577 .option address_retry_include_sender smtp boolean true
23578 .cindex "4&'xx'& responses" "retrying after"
23579 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23580 is the combination of sender and recipient that is delayed in subsequent queue
23581 runs until the retry time is reached. You can delay the recipient without
23582 reference to the sender (which is what earlier versions of Exim did), by
23583 setting &%address_retry_include_sender%& false. However, this can lead to
23584 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23585
23586 .option allow_localhost smtp boolean false
23587 .cindex "local host" "sending to"
23588 .cindex "fallback" "hosts specified on transport"
23589 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23590 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23591 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23592 the delivery anyway. This should be used only in special cases when the
23593 configuration ensures that no looping will result (for example, a differently
23594 configured Exim is listening on the port to which the message is sent).
23595
23596
23597 .option authenticated_sender smtp string&!! unset
23598 .cindex "Cyrus"
23599 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23600 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23601 overriding any existing authenticated sender value. If the string expansion is
23602 forced to fail, the option is ignored. Other expansion failures cause delivery
23603 to be deferred. If the result of expansion is an empty string, that is also
23604 ignored.
23605
23606 The expansion happens after the outgoing connection has been made and TLS
23607 started, if required. This means that the &$host$&, &$host_address$&,
23608 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23609 particular connection.
23610
23611 If the SMTP session is not authenticated, the expansion of
23612 &%authenticated_sender%& still happens (and can cause the delivery to be
23613 deferred if it fails), but no AUTH= item is added to MAIL commands
23614 unless &%authenticated_sender_force%& is true.
23615
23616 This option allows you to use the &(smtp)& transport in LMTP mode to
23617 deliver mail to Cyrus IMAP and provide the proper local part as the
23618 &"authenticated sender"&, via a setting such as:
23619 .code
23620 authenticated_sender = $local_part
23621 .endd
23622 This removes the need for IMAP subfolders to be assigned special ACLs to
23623 allow direct delivery to those subfolders.
23624
23625 Because of expected uses such as that just described for Cyrus (when no
23626 domain is involved), there is no checking on the syntax of the provided
23627 value.
23628
23629
23630 .option authenticated_sender_force smtp boolean false
23631 If this option is set true, the &%authenticated_sender%& option's value
23632 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23633 authenticated as a client.
23634
23635
23636 .option command_timeout smtp time 5m
23637 This sets a timeout for receiving a response to an SMTP command that has been
23638 sent out. It is also used when waiting for the initial banner line from the
23639 remote host. Its value must not be zero.
23640
23641
23642 .option connect_timeout smtp time 5m
23643 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23644 to a remote host. A setting of zero allows the system timeout (typically
23645 several minutes) to act. To have any effect, the value of this option must be
23646 less than the system timeout. However, it has been observed that on some
23647 systems there is no system timeout, which is why the default value for this
23648 option is 5 minutes, a value recommended by RFC 1123.
23649
23650
23651 .option connection_max_messages smtp integer 500
23652 .cindex "SMTP" "passed connection"
23653 .cindex "SMTP" "multiple deliveries"
23654 .cindex "multiple SMTP deliveries"
23655 This controls the maximum number of separate message deliveries that are sent
23656 over a single TCP/IP connection. If the value is zero, there is no limit.
23657 For testing purposes, this value can be overridden by the &%-oB%& command line
23658 option.
23659
23660
23661 .option data_timeout smtp time 5m
23662 This sets a timeout for the transmission of each block in the data portion of
23663 the message. As a result, the overall timeout for a message depends on the size
23664 of the message. Its value must not be zero. See also &%final_timeout%&.
23665
23666
23667 .option dkim_domain smtp string&!! unset
23668 .option dkim_selector smtp string&!! unset
23669 .option dkim_private_key smtp string&!! unset
23670 .option dkim_canon smtp string&!! unset
23671 .option dkim_strict smtp string&!! unset
23672 .option dkim_sign_headers smtp string&!! unset
23673 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23674
23675
23676 .option delay_after_cutoff smtp boolean true
23677 This option controls what happens when all remote IP addresses for a given
23678 domain have been inaccessible for so long that they have passed their retry
23679 cutoff times.
23680
23681 In the default state, if the next retry time has not been reached for any of
23682 them, the address is bounced without trying any deliveries. In other words,
23683 Exim delays retrying an IP address after the final cutoff time until a new
23684 retry time is reached, and can therefore bounce an address without ever trying
23685 a delivery, when machines have been down for a long time. Some people are
23686 unhappy at this prospect, so...
23687
23688 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23689 addresses are past their final cutoff time, Exim tries to deliver to those
23690 IP addresses that have not been tried since the message arrived. If there are
23691 none, of if they all fail, the address is bounced. In other words, it does not
23692 delay when a new message arrives, but immediately tries those expired IP
23693 addresses that haven't been tried since the message arrived. If there is a
23694 continuous stream of messages for the dead hosts, unsetting
23695 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23696 to them.
23697
23698
23699 .option dns_qualify_single smtp boolean true
23700 If the &%hosts%& or &%fallback_hosts%& option is being used,
23701 and the &%gethostbyname%& option is false,
23702 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23703 in chapter &<<CHAPdnslookup>>& for more details.
23704
23705
23706 .option dns_search_parents smtp boolean false
23707 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23708 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23709 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23710 details.
23711
23712
23713 .option dnssec_request_domains smtp "domain list&!!" unset
23714 .cindex "MX record" "security"
23715 .cindex "DNSSEC" "MX lookup"
23716 .cindex "security" "MX lookup"
23717 .cindex "DNS" "DNSSEC"
23718 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23719 the dnssec request bit set.
23720 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23721
23722
23723
23724 .option dnssec_require_domains smtp "domain list&!!" unset
23725 .cindex "MX record" "security"
23726 .cindex "DNSSEC" "MX lookup"
23727 .cindex "security" "MX lookup"
23728 .cindex "DNS" "DNSSEC"
23729 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23730 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23731 (AD bit) set will be ignored and logged as a host-lookup failure.
23732 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23733
23734
23735
23736 .option dscp smtp string&!! unset
23737 .cindex "DCSP" "outbound"
23738 This option causes the DSCP value associated with a socket to be set to one
23739 of a number of fixed strings or to numeric value.
23740 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23741 Common values include &`throughput`&, &`mincost`&, and on newer systems
23742 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23743
23744 The outbound packets from Exim will be marked with this value in the header
23745 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23746 that these values will have any effect, not be stripped by networking
23747 equipment, or do much of anything without cooperation with your Network
23748 Engineer and those of all network operators between the source and destination.
23749
23750
23751 .option fallback_hosts smtp "string list" unset
23752 .cindex "fallback" "hosts specified on transport"
23753 String expansion is not applied to this option. The argument must be a
23754 colon-separated list of host names or IP addresses, optionally also including
23755 port numbers, though the separator can be changed, as described in section
23756 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23757 item in a &%route_list%& setting for the &(manualroute)& router, as described
23758 in section &<<SECTformatonehostitem>>&.
23759
23760 Fallback hosts can also be specified on routers, which associate them with the
23761 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23762 &%fallback_hosts%& specified on the transport is used only if the address does
23763 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23764 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23765 However, &%hosts_randomize%& does apply to fallback host lists.
23766
23767 If Exim is unable to deliver to any of the hosts for a particular address, and
23768 the errors are not permanent rejections, the address is put on a separate
23769 transport queue with its host list replaced by the fallback hosts, unless the
23770 address was routed via MX records and the current host was in the original MX
23771 list. In that situation, the fallback host list is not used.
23772
23773 Once normal deliveries are complete, the fallback queue is delivered by
23774 re-running the same transports with the new host lists. If several failing
23775 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23776 copy of the message is sent.
23777
23778 The resolution of the host names on the fallback list is controlled by the
23779 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23780 both to cases when the host list comes with the address and when it is taken
23781 from &%hosts%&. This option provides a &"use a smart host only if delivery
23782 fails"& facility.
23783
23784
23785 .option final_timeout smtp time 10m
23786 This is the timeout that applies while waiting for the response to the final
23787 line containing just &"."& that terminates a message. Its value must not be
23788 zero.
23789
23790 .option gethostbyname smtp boolean false
23791 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23792 being used, names are looked up using &[gethostbyname()]&
23793 (or &[getipnodebyname()]& when available)
23794 instead of using the DNS. Of course, that function may in fact use the DNS, but
23795 it may also consult other sources of information such as &_/etc/hosts_&.
23796
23797 .option gnutls_compat_mode smtp boolean unset
23798 This option controls whether GnuTLS is used in compatibility mode in an Exim
23799 server. This reduces security slightly, but improves interworking with older
23800 implementations of TLS.
23801
23802 .option helo_data smtp string&!! "see below"
23803 .cindex "HELO" "argument, setting"
23804 .cindex "EHLO" "argument, setting"
23805 .cindex "LHLO argument setting"
23806 The value of this option is expanded after a connection to a another host has
23807 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23808 command that starts the outgoing SMTP or LMTP session. The default value of the
23809 option is:
23810 .code
23811 $primary_hostname
23812 .endd
23813 During the expansion, the variables &$host$& and &$host_address$& are set to
23814 the identity of the remote host, and the variables &$sending_ip_address$& and
23815 &$sending_port$& are set to the local IP address and port number that are being
23816 used. These variables can be used to generate different values for different
23817 servers or different local IP addresses. For example, if you want the string
23818 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23819 interface address, you could use this:
23820 .code
23821 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23822   {$primary_hostname}}
23823 .endd
23824 The use of &%helo_data%& applies both to sending messages and when doing
23825 callouts.
23826
23827 .option hosts smtp "string list&!!" unset
23828 Hosts are associated with an address by a router such as &(dnslookup)&, which
23829 finds the hosts by looking up the address domain in the DNS, or by
23830 &(manualroute)&, which has lists of hosts in its configuration. However,
23831 email addresses can be passed to the &(smtp)& transport by any router, and not
23832 all of them can provide an associated list of hosts.
23833
23834 The &%hosts%& option specifies a list of hosts to be used if the address being
23835 processed does not have any hosts associated with it. The hosts specified by
23836 &%hosts%& are also used, whether or not the address has its own hosts, if
23837 &%hosts_override%& is set.
23838
23839 The string is first expanded, before being interpreted as a colon-separated
23840 list of host names or IP addresses, possibly including port numbers. The
23841 separator may be changed to something other than colon, as described in section
23842 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23843 item in a &%route_list%& setting for the &(manualroute)& router, as described
23844 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23845 of the &(manualroute)& router is not available here.
23846
23847 If the expansion fails, delivery is deferred. Unless the failure was caused by
23848 the inability to complete a lookup, the error is logged to the panic log as
23849 well as the main log. Host names are looked up either by searching directly for
23850 address records in the DNS or by calling &[gethostbyname()]& (or
23851 &[getipnodebyname()]& when available), depending on the setting of the
23852 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23853 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23854 address are used.
23855
23856 During delivery, the hosts are tried in order, subject to their retry status,
23857 unless &%hosts_randomize%& is set.
23858
23859
23860 .option hosts_avoid_esmtp smtp "host list&!!" unset
23861 .cindex "ESMTP, avoiding use of"
23862 .cindex "HELO" "forcing use of"
23863 .cindex "EHLO" "avoiding use of"
23864 .cindex "PIPELINING" "avoiding the use of"
23865 This option is for use with broken hosts that announce ESMTP facilities (for
23866 example, PIPELINING) and then fail to implement them properly. When a host
23867 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23868 start of the SMTP session. This means that it cannot use any of the ESMTP
23869 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23870
23871
23872 .option hosts_avoid_pipelining smtp "host list&!!" unset
23873 .cindex "PIPELINING" "avoiding the use of"
23874 Exim will not use the SMTP PIPELINING extension when delivering to any host
23875 that matches this list, even if the server host advertises PIPELINING support.
23876
23877
23878 .option hosts_avoid_tls smtp "host list&!!" unset
23879 .cindex "TLS" "avoiding for certain hosts"
23880 Exim will not try to start a TLS session when delivering to any host that
23881 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23882
23883 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23884 .cindex "TLS" "avoiding for certain hosts"
23885 Exim will not try to start a TLS session for a verify callout,
23886 or when delivering in cutthrough mode,
23887 to any host that matches this list.
23888
23889
23890 .option hosts_max_try smtp integer 5
23891 .cindex "host" "maximum number to try"
23892 .cindex "limit" "number of hosts tried"
23893 .cindex "limit" "number of MX tried"
23894 .cindex "MX record" "maximum tried"
23895 This option limits the number of IP addresses that are tried for any one
23896 delivery in cases where there are temporary delivery errors. Section
23897 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23898
23899
23900 .option hosts_max_try_hardlimit smtp integer 50
23901 This is an additional check on the maximum number of IP addresses that Exim
23902 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23903 why it exists.
23904
23905
23906
23907 .option hosts_nopass_tls smtp "host list&!!" unset
23908 .cindex "TLS" "passing connection"
23909 .cindex "multiple SMTP deliveries"
23910 .cindex "TLS" "multiple message deliveries"
23911 For any host that matches this list, a connection on which a TLS session has
23912 been started will not be passed to a new delivery process for sending another
23913 message on the same connection. See section &<<SECTmulmessam>>& for an
23914 explanation of when this might be needed.
23915
23916
23917 .option hosts_override smtp boolean false
23918 If this option is set and the &%hosts%& option is also set, any hosts that are
23919 attached to the address are ignored, and instead the hosts specified by the
23920 &%hosts%& option are always used. This option does not apply to
23921 &%fallback_hosts%&.
23922
23923
23924 .option hosts_randomize smtp boolean false
23925 .cindex "randomized host list"
23926 .cindex "host" "list of; randomized"
23927 .cindex "fallback" "randomized hosts"
23928 If this option is set, and either the list of hosts is taken from the
23929 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23930 were not obtained from MX records (this includes fallback hosts from the
23931 router), and were not randomized by the router, the order of trying the hosts
23932 is randomized each time the transport runs. Randomizing the order of a host
23933 list can be used to do crude load sharing.
23934
23935 When &%hosts_randomize%& is true, a host list may be split into groups whose
23936 order is separately randomized. This makes it possible to set up MX-like
23937 behaviour. The boundaries between groups are indicated by an item that is just
23938 &`+`& in the host list. For example:
23939 .code
23940 hosts = host1:host2:host3:+:host4:host5
23941 .endd
23942 The order of the first three hosts and the order of the last two hosts is
23943 randomized for each use, but the first three always end up before the last two.
23944 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23945
23946 .option hosts_require_auth smtp "host list&!!" unset
23947 .cindex "authentication" "required by client"
23948 This option provides a list of servers for which authentication must succeed
23949 before Exim will try to transfer a message. If authentication fails for
23950 servers which are not in this list, Exim tries to send unauthenticated. If
23951 authentication fails for one of these servers, delivery is deferred. This
23952 temporary error is detectable in the retry rules, so it can be turned into a
23953 hard failure if required. See also &%hosts_try_auth%&, and chapter
23954 &<<CHAPSMTPAUTH>>& for details of authentication.
23955
23956
23957 .option hosts_request_ocsp smtp "host list&!!" *
23958 .cindex "TLS" "requiring for certain servers"
23959 Exim will request a Certificate Status on a
23960 TLS session for any host that matches this list.
23961 &%tls_verify_certificates%& should also be set for the transport.
23962
23963 .option hosts_require_ocsp smtp "host list&!!" unset
23964 .cindex "TLS" "requiring for certain servers"
23965 Exim will request, and check for a valid Certificate Status being given, on a
23966 TLS session for any host that matches this list.
23967 &%tls_verify_certificates%& should also be set for the transport.
23968
23969 .option hosts_require_tls smtp "host list&!!" unset
23970 .cindex "TLS" "requiring for certain servers"
23971 Exim will insist on using a TLS session when delivering to any host that
23972 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23973 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23974 incoming messages, use an appropriate ACL.
23975
23976 .option hosts_try_auth smtp "host list&!!" unset
23977 .cindex "authentication" "optional in client"
23978 This option provides a list of servers to which, provided they announce
23979 authentication support, Exim will attempt to authenticate as a client when it
23980 connects. If authentication fails, Exim will try to transfer the message
23981 unauthenticated. See also &%hosts_require_auth%&, and chapter
23982 &<<CHAPSMTPAUTH>>& for details of authentication.
23983
23984 .new
23985 .option hosts_try_chunking smtp "host list&!!" *
23986 .cindex CHUNKING "enabling, in client"
23987 .cindex BDAT "SMTP command"
23988 .cindex "RFC 3030" "CHUNKING"
23989 This option provides a list of server to which, provided they announce
23990 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
23991 BDAT will not be used in conjuction with a transport filter.
23992 .wen
23993
23994 .option hosts_try_prdr smtp "host list&!!" *
23995 .cindex "PRDR" "enabling, optional in client"
23996 This option provides a list of servers to which, provided they announce
23997 PRDR support, Exim will attempt to negotiate PRDR
23998 for multi-recipient messages.
23999 The option can usually be left as default.
24000
24001 .option interface smtp "string list&!!" unset
24002 .cindex "bind IP address"
24003 .cindex "IP address" "binding"
24004 .vindex "&$host$&"
24005 .vindex "&$host_address$&"
24006 This option specifies which interface to bind to when making an outgoing SMTP
24007 call. The value is an IP address, not an interface name such as
24008 &`eth0`&. Do not confuse this with the interface address that was used when a
24009 message was received, which is in &$received_ip_address$&, formerly known as
24010 &$interface_address$&. The name was changed to minimize confusion with the
24011 outgoing interface address. There is no variable that contains an outgoing
24012 interface address because, unless it is set by this option, its value is
24013 unknown.
24014
24015 During the expansion of the &%interface%& option the variables &$host$& and
24016 &$host_address$& refer to the host to which a connection is about to be made
24017 during the expansion of the string. Forced expansion failure, or an empty
24018 string result causes the option to be ignored. Otherwise, after expansion, the
24019 string must be a list of IP addresses, colon-separated by default, but the
24020 separator can be changed in the usual way. For example:
24021 .code
24022 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24023 .endd
24024 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24025 connection. If none of them are the correct type, the option is ignored. If
24026 &%interface%& is not set, or is ignored, the system's IP functions choose which
24027 interface to use if the host has more than one.
24028
24029
24030 .option keepalive smtp boolean true
24031 .cindex "keepalive" "on outgoing connection"
24032 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24033 connections. When set, it causes the kernel to probe idle connections
24034 periodically, by sending packets with &"old"& sequence numbers. The other end
24035 of the connection should send a acknowledgment if the connection is still okay
24036 or a reset if the connection has been aborted. The reason for doing this is
24037 that it has the beneficial effect of freeing up certain types of connection
24038 that can get stuck when the remote host is disconnected without tidying up the
24039 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24040 unreachable hosts.
24041
24042
24043 .option lmtp_ignore_quota smtp boolean false
24044 .cindex "LMTP" "ignoring quota errors"
24045 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24046 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24047 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24048
24049 .option max_rcpt smtp integer 100
24050 .cindex "RCPT" "maximum number of outgoing"
24051 This option limits the number of RCPT commands that are sent in a single
24052 SMTP message transaction. Each set of addresses is treated independently, and
24053 so can cause parallel connections to the same host if &%remote_max_parallel%&
24054 permits this.
24055
24056
24057 .option multi_domain smtp boolean&!! true
24058 .vindex "&$domain$&"
24059 When this option is set, the &(smtp)& transport can handle a number of
24060 addresses containing a mixture of different domains provided they all resolve
24061 to the same list of hosts. Turning the option off restricts the transport to
24062 handling only one domain at a time. This is useful if you want to use
24063 &$domain$& in an expansion for the transport, because it is set only when there
24064 is a single domain involved in a remote delivery.
24065
24066 It is expanded per-address and can depend on any of
24067 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24068 &$host$&, &$host_address$& and &$host_port$&.
24069
24070 .option port smtp string&!! "see below"
24071 .cindex "port" "sending TCP/IP"
24072 .cindex "TCP/IP" "setting outgoing port"
24073 This option specifies the TCP/IP port on the server to which Exim connects.
24074 &*Note:*& Do not confuse this with the port that was used when a message was
24075 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24076 The name was changed to minimize confusion with the outgoing port. There is no
24077 variable that contains an outgoing port.
24078
24079 If the value of this option begins with a digit it is taken as a port number;
24080 otherwise it is looked up using &[getservbyname()]&. The default value is
24081 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24082 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24083 is deferred.
24084
24085
24086
24087 .option protocol smtp string smtp
24088 .cindex "LMTP" "over TCP/IP"
24089 .cindex "ssmtp protocol" "outbound"
24090 .cindex "TLS" "SSL-on-connect outbound"
24091 .vindex "&$port$&"
24092 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24093 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24094 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24095 deliveries into closed message stores. Exim also has support for running LMTP
24096 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24097
24098 If this option is set to &"smtps"&, the default value for the &%port%& option
24099 changes to &"smtps"&, and the transport initiates TLS immediately after
24100 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24101 The Internet standards bodies strongly discourage use of this mode.
24102
24103
24104 .option retry_include_ip_address smtp boolean&!! true
24105 Exim normally includes both the host name and the IP address in the key it
24106 constructs for indexing retry data after a temporary delivery failure. This
24107 means that when one of several IP addresses for a host is failing, it gets
24108 tried periodically (controlled by the retry rules), but use of the other IP
24109 addresses is not affected.
24110
24111 However, in some dialup environments hosts are assigned a different IP address
24112 each time they connect. In this situation the use of the IP address as part of
24113 the retry key leads to undesirable behaviour. Setting this option false causes
24114 Exim to use only the host name.
24115 Since it is expanded it can be made to depend on the host or domain.
24116
24117
24118 .option serialize_hosts smtp "host list&!!" unset
24119 .cindex "serializing connections"
24120 .cindex "host" "serializing connections"
24121 Because Exim operates in a distributed manner, if several messages for the same
24122 host arrive at around the same time, more than one simultaneous connection to
24123 the remote host can occur. This is not usually a problem except when there is a
24124 slow link between the hosts. In that situation it may be helpful to restrict
24125 Exim to one connection at a time. This can be done by setting
24126 &%serialize_hosts%& to match the relevant hosts.
24127
24128 .cindex "hints database" "serializing deliveries to a host"
24129 Exim implements serialization by means of a hints database in which a record is
24130 written whenever a process connects to one of the restricted hosts. The record
24131 is deleted when the connection is completed. Obviously there is scope for
24132 records to get left lying around if there is a system or program crash. To
24133 guard against this, Exim ignores any records that are more than six hours old.
24134
24135 If you set up this kind of serialization, you should also arrange to delete the
24136 relevant hints database whenever your system reboots. The names of the files
24137 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24138 may be one or two files, depending on the type of DBM in use. The same files
24139 are used for ETRN serialization.
24140
24141 See also the &%max_parallel%& generic transport option.
24142
24143
24144 .option size_addition smtp integer 1024
24145 .cindex "SMTP" "SIZE"
24146 .cindex "message" "size issue for transport filter"
24147 .cindex "size" "of message"
24148 .cindex "transport" "filter"
24149 .cindex "filter" "transport filter"
24150 If a remote SMTP server indicates that it supports the SIZE option of the
24151 MAIL command, Exim uses this to pass over the message size at the start of
24152 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24153 sends, to allow for headers and other text that may be added during delivery by
24154 configuration options or in a transport filter. It may be necessary to increase
24155 this if a lot of text is added to messages.
24156
24157 Alternatively, if the value of &%size_addition%& is set negative, it disables
24158 the use of the SIZE option altogether.
24159
24160
24161 .option socks_proxy smtp string&!! unset
24162 .cindex proxy SOCKS
24163 This option enables use of SOCKS proxies for connections made by the
24164 transport.  For details see &<<SECTproxySOCKS>>&.
24165
24166
24167 .option tls_certificate smtp string&!! unset
24168 .cindex "TLS" "client certificate, location of"
24169 .cindex "certificate" "client, location of"
24170 .vindex "&$host$&"
24171 .vindex "&$host_address$&"
24172 The value of this option must be the absolute path to a file which contains the
24173 client's certificate, for possible use when sending a message over an encrypted
24174 connection. The values of &$host$& and &$host_address$& are set to the name and
24175 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24176 details of TLS.
24177
24178 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24179 certificate when sending messages as a client. The global option of the same
24180 name specifies the certificate for Exim as a server; it is not automatically
24181 assumed that the same certificate should be used when Exim is operating as a
24182 client.
24183
24184
24185 .option tls_crl smtp string&!! unset
24186 .cindex "TLS" "client certificate revocation list"
24187 .cindex "certificate" "revocation list for client"
24188 This option specifies a certificate revocation list. The expanded value must
24189 be the name of a file that contains a CRL in PEM format.
24190
24191
24192 .option tls_dh_min_bits smtp integer 1024
24193 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24194 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24195 key agreement is negotiated, the server will provide a large prime number
24196 for use.  This option establishes the minimum acceptable size of that number.
24197 If the parameter offered by the server is too small, then the TLS handshake
24198 will fail.
24199
24200 Only supported when using GnuTLS.
24201
24202
24203 .option tls_privatekey smtp string&!! unset
24204 .cindex "TLS" "client private key, location of"
24205 .vindex "&$host$&"
24206 .vindex "&$host_address$&"
24207 The value of this option must be the absolute path to a file which contains the
24208 client's private key. This is used when sending a message over an encrypted
24209 connection using a client certificate. The values of &$host$& and
24210 &$host_address$& are set to the name and address of the server during the
24211 expansion. If this option is unset, or the expansion is forced to fail, or the
24212 result is an empty string, the private key is assumed to be in the same file as
24213 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24214
24215
24216 .option tls_require_ciphers smtp string&!! unset
24217 .cindex "TLS" "requiring specific ciphers"
24218 .cindex "cipher" "requiring specific"
24219 .vindex "&$host$&"
24220 .vindex "&$host_address$&"
24221 The value of this option must be a list of permitted cipher suites, for use
24222 when setting up an outgoing encrypted connection. (There is a global option of
24223 the same name for controlling incoming connections.) The values of &$host$& and
24224 &$host_address$& are set to the name and address of the server during the
24225 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24226 is used in different ways by OpenSSL and GnuTLS (see sections
24227 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24228 ciphers is a preference order.
24229
24230
24231
24232 .option tls_sni smtp string&!! unset
24233 .cindex "TLS" "Server Name Indication"
24234 .vindex "&$tls_sni$&"
24235 If this option is set then it sets the $tls_out_sni variable and causes any
24236 TLS session to pass this value as the Server Name Indication extension to
24237 the remote side, which can be used by the remote side to select an appropriate
24238 certificate and private key for the session.
24239
24240 See &<<SECTtlssni>>& for more information.
24241
24242 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24243 TLS extensions.
24244
24245
24246
24247
24248 .option tls_tempfail_tryclear smtp boolean true
24249 .cindex "4&'xx'& responses" "to STARTTLS"
24250 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24251 setting up a TLS session, this option determines whether or not Exim should try
24252 to deliver the message unencrypted. If it is set false, delivery to the
24253 current host is deferred; if there are other hosts, they are tried. If this
24254 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24255 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24256 TLS negotiation fails, Exim closes the current connection (because it is in an
24257 unknown state), opens a new one to the same host, and then tries the delivery
24258 in clear.
24259
24260
24261 .option tls_try_verify_hosts smtp "host list&!!" *
24262 .cindex "TLS" "server certificate verification"
24263 .cindex "certificate" "verification of server"
24264 This option gives a list of hosts for which, on encrypted connections,
24265 certificate verification will be tried but need not succeed.
24266 The &%tls_verify_certificates%& option must also be set.
24267 Note that unless the host is in this list
24268 TLS connections will be denied to hosts using self-signed certificates
24269 when &%tls_verify_certificates%& is matched.
24270 The &$tls_out_certificate_verified$& variable is set when
24271 certificate verification succeeds.
24272
24273
24274 .option tls_verify_cert_hostnames smtp "host list&!!" *
24275 .cindex "TLS" "server certificate hostname verification"
24276 .cindex "certificate" "verification of server"
24277 This option give a list of hosts for which,
24278 while verifying the server certificate,
24279 checks will be included on the host name
24280 (note that this will generally be the result of a DNS MX lookup)
24281 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24282 limited to being the initial component of a 3-or-more component FQDN.
24283
24284 There is no equivalent checking on client certificates.
24285
24286
24287 .option tls_verify_certificates smtp string&!! system
24288 .cindex "TLS" "server certificate verification"
24289 .cindex "certificate" "verification of server"
24290 .vindex "&$host$&"
24291 .vindex "&$host_address$&"
24292 The value of this option must be either the
24293 word "system"
24294 or the absolute path to
24295 a file or directory containing permitted certificates for servers,
24296 for use when setting up an encrypted connection.
24297
24298 The "system" value for the option will use a location compiled into the SSL library.
24299 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24300 is taken as empty and an explicit location
24301 must be specified.
24302
24303 The use of a directory for the option value is not available for GnuTLS versions
24304 preceding 3.3.6 and a single file must be used.
24305
24306 With OpenSSL the certificates specified
24307 explicitly
24308 either by file or directory
24309 are added to those given by the system default location.
24310
24311 The values of &$host$& and
24312 &$host_address$& are set to the name and address of the server during the
24313 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24314
24315 For back-compatibility,
24316 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24317 (a single-colon empty list counts as being set)
24318 and certificate verification fails the TLS connection is closed.
24319
24320
24321 .option tls_verify_hosts smtp "host list&!!" unset
24322 .cindex "TLS" "server certificate verification"
24323 .cindex "certificate" "verification of server"
24324 This option gives a list of hosts for which, on encrypted connections,
24325 certificate verification must succeed.
24326 The &%tls_verify_certificates%& option must also be set.
24327 If both this option and &%tls_try_verify_hosts%& are unset
24328 operation is as if this option selected all hosts.
24329
24330
24331
24332
24333 .section "How the limits for the number of hosts to try are used" &&&
24334          "SECTvalhosmax"
24335 .cindex "host" "maximum number to try"
24336 .cindex "limit" "hosts; maximum number tried"
24337 There are two options that are concerned with the number of hosts that are
24338 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24339 &%hosts_max_try_hardlimit%&.
24340
24341
24342 The &%hosts_max_try%& option limits the number of hosts that are tried
24343 for a single delivery. However, despite the term &"host"& in its name, the
24344 option actually applies to each IP address independently. In other words, a
24345 multihomed host is treated as several independent hosts, just as it is for
24346 retrying.
24347
24348 Many of the larger ISPs have multiple MX records which often point to
24349 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24350 created as a result of routing one of these domains.
24351
24352 Trying every single IP address on such a long list does not seem sensible; if
24353 several at the top of the list fail, it is reasonable to assume there is some
24354 problem that is likely to affect all of them. Roughly speaking, the value of
24355 &%hosts_max_try%& is the maximum number that are tried before deferring the
24356 delivery. However, the logic cannot be quite that simple.
24357
24358 Firstly, IP addresses that are skipped because their retry times have not
24359 arrived do not count, and in addition, addresses that are past their retry
24360 limits are also not counted, even when they are tried. This means that when
24361 some IP addresses are past their retry limits, more than the value of
24362 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24363 that all IP addresses are considered before timing out an email address (but
24364 see below for an exception).
24365
24366 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24367 list to see if there is a subsequent host with a different (higher valued) MX.
24368 If there is, that host is considered next, and the current IP address is used
24369 but not counted. This behaviour helps in the case of a domain with a retry rule
24370 that hardly ever delays any hosts, as is now explained:
24371
24372 Consider the case of a long list of hosts with one MX value, and a few with a
24373 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24374 hosts at the top of the list are tried at first. With the default retry rule,
24375 which specifies increasing retry times, the higher MX hosts are eventually
24376 tried when those at the top of the list are skipped because they have not
24377 reached their retry times.
24378
24379 However, it is common practice to put a fixed short retry time on domains for
24380 large ISPs, on the grounds that their servers are rarely down for very long.
24381 Unfortunately, these are exactly the domains that tend to resolve to long lists
24382 of hosts. The short retry time means that the lowest MX hosts are tried every
24383 time. The attempts may be in a different order because of random sorting, but
24384 without the special MX check, the higher MX hosts would never be tried until
24385 all the lower MX hosts had timed out (which might be several days), because
24386 there are always some lower MX hosts that have reached their retry times. With
24387 the special check, Exim considers at least one IP address from each MX value at
24388 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24389 reached.
24390
24391 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24392 particular, Exim normally eventually tries all the IP addresses before timing
24393 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24394 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24395 been set up with hundreds of IP addresses for some domains. It can
24396 take a very long time indeed for an address to time out in these cases.
24397
24398 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24399 Exim never tries more than this number of IP addresses; if it hits this limit
24400 and they are all timed out, the email address is bounced, even though not all
24401 possible IP addresses have been tried.
24402 .ecindex IIDsmttra1
24403 .ecindex IIDsmttra2
24404
24405
24406
24407
24408
24409 . ////////////////////////////////////////////////////////////////////////////
24410 . ////////////////////////////////////////////////////////////////////////////
24411
24412 .chapter "Address rewriting" "CHAPrewrite"
24413 .scindex IIDaddrew "rewriting" "addresses"
24414 There are some circumstances in which Exim automatically rewrites domains in
24415 addresses. The two most common are when an address is given without a domain
24416 (referred to as an &"unqualified address"&) or when an address contains an
24417 abbreviated domain that is expanded by DNS lookup.
24418
24419 Unqualified envelope addresses are accepted only for locally submitted
24420 messages, or for messages that are received from hosts matching
24421 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24422 appropriate. Unqualified addresses in header lines are qualified if they are in
24423 locally submitted messages, or messages from hosts that are permitted to send
24424 unqualified envelope addresses. Otherwise, unqualified addresses in header
24425 lines are neither qualified nor rewritten.
24426
24427 One situation in which Exim does &'not'& automatically rewrite a domain is
24428 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24429 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24430 do this. The new RFCs do not contain this suggestion.
24431
24432
24433 .section "Explicitly configured address rewriting" "SECID147"
24434 This chapter describes the rewriting rules that can be used in the
24435 main rewrite section of the configuration file, and also in the generic
24436 &%headers_rewrite%& option that can be set on any transport.
24437
24438 Some people believe that configured address rewriting is a Mortal Sin.
24439 Others believe that life is not possible without it. Exim provides the
24440 facility; you do not have to use it.
24441
24442 The main rewriting rules that appear in the &"rewrite"& section of the
24443 configuration file are applied to addresses in incoming messages, both envelope
24444 addresses and addresses in header lines. Each rule specifies the types of
24445 address to which it applies.
24446
24447 Whether or not addresses in header lines are rewritten depends on the origin of
24448 the headers and the type of rewriting. Global rewriting, that is, rewriting
24449 rules from the rewrite section of the configuration file, is applied only to
24450 those headers that were received with the message. Header lines that are added
24451 by ACLs or by a system filter or by individual routers or transports (which
24452 are specific to individual recipient addresses) are not rewritten by the global
24453 rules.
24454
24455 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24456 applies all headers except those added by routers and transports. That is, as
24457 well as the headers that were received with the message, it also applies to
24458 headers that were added by an ACL or a system filter.
24459
24460
24461 In general, rewriting addresses from your own system or domain has some
24462 legitimacy. Rewriting other addresses should be done only with great care and
24463 in special circumstances. The author of Exim believes that rewriting should be
24464 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24465 Although it can sometimes be used as a routing tool, this is very strongly
24466 discouraged.
24467
24468 There are two commonly encountered circumstances where rewriting is used, as
24469 illustrated by these examples:
24470
24471 .ilist
24472 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24473 exchange mail with each other behind a firewall, but there is only a single
24474 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24475 &'hitch.fict.example'& when sending mail off-site.
24476 .next
24477 A host rewrites the local parts of its own users so that, for example,
24478 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24479 .endlist
24480
24481
24482
24483 .section "When does rewriting happen?" "SECID148"
24484 .cindex "rewriting" "timing of"
24485 .cindex "&ACL;" "rewriting addresses in"
24486 Configured address rewriting can take place at several different stages of a
24487 message's processing.
24488
24489 .vindex "&$sender_address$&"
24490 At the start of an ACL for MAIL, the sender address may have been rewritten
24491 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24492 ordinary rewrite rules have yet been applied. If, however, the sender address
24493 is verified in the ACL, it is rewritten before verification, and remains
24494 rewritten thereafter. The subsequent value of &$sender_address$& is the
24495 rewritten address. This also applies if sender verification happens in a
24496 RCPT ACL. Otherwise, when the sender address is not verified, it is
24497 rewritten as soon as a message's header lines have been received.
24498
24499 .vindex "&$domain$&"
24500 .vindex "&$local_part$&"
24501 Similarly, at the start of an ACL for RCPT, the current recipient's address
24502 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24503 rewrite rules have yet been applied to it. However, the behaviour is different
24504 from the sender address when a recipient is verified. The address is rewritten
24505 for the verification, but the rewriting is not remembered at this stage. The
24506 value of &$local_part$& and &$domain$& after verification are always the same
24507 as they were before (that is, they contain the unrewritten &-- except for
24508 SMTP-time rewriting &-- address).
24509
24510 As soon as a message's header lines have been received, all the envelope
24511 recipient addresses are permanently rewritten, and rewriting is also applied to
24512 the addresses in the header lines (if configured). This happens before adding
24513 any header lines that were specified in MAIL or RCPT ACLs, and
24514 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24515 before the DATA ACL and &[local_scan()]& functions are run.
24516
24517 When an address is being routed, either for delivery or for verification,
24518 rewriting is applied immediately to child addresses that are generated by
24519 redirection, unless &%no_rewrite%& is set on the router.
24520
24521 .cindex "envelope sender" "rewriting at transport time"
24522 .cindex "rewriting" "at transport time"
24523 .cindex "header lines" "rewriting at transport time"
24524 At transport time, additional rewriting of addresses in header lines can be
24525 specified by setting the generic &%headers_rewrite%& option on a transport.
24526 This option contains rules that are identical in form to those in the rewrite
24527 section of the configuration file. They are applied to the original message
24528 header lines and any that were added by ACLs or a system filter. They are not
24529 applied to header lines that are added by routers or the transport.
24530
24531 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24532 transport option. However, it is not possible to rewrite envelope recipients at
24533 transport time.
24534
24535
24536
24537
24538 .section "Testing the rewriting rules that apply on input" "SECID149"
24539 .cindex "rewriting" "testing"
24540 .cindex "testing" "rewriting"
24541 Exim's input rewriting configuration appears in a part of the run time
24542 configuration file headed by &"begin rewrite"&. It can be tested by the
24543 &%-brw%& command line option. This takes an address (which can be a full RFC
24544 2822 address) as its argument. The output is a list of how the address would be
24545 transformed by the rewriting rules for each of the different places it might
24546 appear in an incoming message, that is, for each different header and for the
24547 envelope sender and recipient fields. For example,
24548 .code
24549 exim -brw ph10@exim.workshop.example
24550 .endd
24551 might produce the output
24552 .code
24553 sender: Philip.Hazel@exim.workshop.example
24554 from: Philip.Hazel@exim.workshop.example
24555 to: ph10@exim.workshop.example
24556 cc: ph10@exim.workshop.example
24557 bcc: ph10@exim.workshop.example
24558 reply-to: Philip.Hazel@exim.workshop.example
24559 env-from: Philip.Hazel@exim.workshop.example
24560 env-to: ph10@exim.workshop.example
24561 .endd
24562 which shows that rewriting has been set up for that address when used in any of
24563 the source fields, but not when it appears as a recipient address. At the
24564 present time, there is no equivalent way of testing rewriting rules that are
24565 set for a particular transport.
24566
24567
24568 .section "Rewriting rules" "SECID150"
24569 .cindex "rewriting" "rules"
24570 The rewrite section of the configuration file consists of lines of rewriting
24571 rules in the form
24572 .display
24573 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24574 .endd
24575 Rewriting rules that are specified for the &%headers_rewrite%& generic
24576 transport option are given as a colon-separated list. Each item in the list
24577 takes the same form as a line in the main rewriting configuration (except that
24578 any colons must be doubled, of course).
24579
24580 The formats of source patterns and replacement strings are described below.
24581 Each is terminated by white space, unless enclosed in double quotes, in which
24582 case normal quoting conventions apply inside the quotes. The flags are single
24583 characters which may appear in any order. Spaces and tabs between them are
24584 ignored.
24585
24586 For each address that could potentially be rewritten, the rules are scanned in
24587 order, and replacements for the address from earlier rules can themselves be
24588 replaced by later rules (but see the &"q"& and &"R"& flags).
24589
24590 The order in which addresses are rewritten is undefined, may change between
24591 releases, and must not be relied on, with one exception: when a message is
24592 received, the envelope sender is always rewritten first, before any header
24593 lines are rewritten. For example, the replacement string for a rewrite of an
24594 address in &'To:'& must not assume that the message's address in &'From:'& has
24595 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24596 that the envelope sender has already been rewritten.
24597
24598 .vindex "&$domain$&"
24599 .vindex "&$local_part$&"
24600 The variables &$local_part$& and &$domain$& can be used in the replacement
24601 string to refer to the address that is being rewritten. Note that lookup-driven
24602 rewriting can be done by a rule of the form
24603 .code
24604 *@*   ${lookup ...
24605 .endd
24606 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24607 refer to the address that is being rewritten.
24608
24609
24610 .section "Rewriting patterns" "SECID151"
24611 .cindex "rewriting" "patterns"
24612 .cindex "address list" "in a rewriting pattern"
24613 The source pattern in a rewriting rule is any item which may appear in an
24614 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24615 single-item address list, which means that it is expanded before being tested
24616 against the address. As always, if you use a regular expression as a pattern,
24617 you must take care to escape dollar and backslash characters, or use the &`\N`&
24618 facility to suppress string expansion within the regular expression.
24619
24620 Domains in patterns should be given in lower case. Local parts in patterns are
24621 case-sensitive. If you want to do case-insensitive matching of local parts, you
24622 can use a regular expression that starts with &`^(?i)`&.
24623
24624 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24625 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24626 depending on the type of match which occurred. These can be used in the
24627 replacement string to insert portions of the incoming address. &$0$& always
24628 refers to the complete incoming address. When a regular expression is used, the
24629 numerical variables are set from its capturing subexpressions. For other types
24630 of pattern they are set as follows:
24631
24632 .ilist
24633 If a local part or domain starts with an asterisk, the numerical variables
24634 refer to the character strings matched by asterisks, with &$1$& associated with
24635 the first asterisk, and &$2$& with the second, if present. For example, if the
24636 pattern
24637 .code
24638 *queen@*.fict.example
24639 .endd
24640 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24641 .code
24642 $0 = hearts-queen@wonderland.fict.example
24643 $1 = hearts-
24644 $2 = wonderland
24645 .endd
24646 Note that if the local part does not start with an asterisk, but the domain
24647 does, it is &$1$& that contains the wild part of the domain.
24648
24649 .next
24650 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24651 of the domain are placed in the next available numerical variables. Suppose,
24652 for example, that the address &'foo@bar.baz.example'& is processed by a
24653 rewriting rule of the form
24654 .display
24655 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24656 .endd
24657 and the key in the file that matches the domain is &`*.baz.example`&. Then
24658 .code
24659 $1 = foo
24660 $2 = bar
24661 $3 = baz.example
24662 .endd
24663 If the address &'foo@baz.example'& is looked up, this matches the same
24664 wildcard file entry, and in this case &$2$& is set to the empty string, but
24665 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24666 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24667 whole domain. For non-partial domain lookups, no numerical variables are set.
24668 .endlist
24669
24670
24671 .section "Rewriting replacements" "SECID152"
24672 .cindex "rewriting" "replacements"
24673 If the replacement string for a rule is a single asterisk, addresses that
24674 match the pattern and the flags are &'not'& rewritten, and no subsequent
24675 rewriting rules are scanned. For example,
24676 .code
24677 hatta@lookingglass.fict.example  *  f
24678 .endd
24679 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24680 &'From:'& headers.
24681
24682 .vindex "&$domain$&"
24683 .vindex "&$local_part$&"
24684 If the replacement string is not a single asterisk, it is expanded, and must
24685 yield a fully qualified address. Within the expansion, the variables
24686 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24687 Any letters they contain retain their original case &-- they are not lower
24688 cased. The numerical variables are set up according to the type of pattern that
24689 matched the address, as described above. If the expansion is forced to fail by
24690 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24691 current rule is abandoned, but subsequent rules may take effect. Any other
24692 expansion failure causes the entire rewriting operation to be abandoned, and an
24693 entry written to the panic log.
24694
24695
24696
24697 .section "Rewriting flags" "SECID153"
24698 There are three different kinds of flag that may appear on rewriting rules:
24699
24700 .ilist
24701 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24702 c, f, h, r, s, t.
24703 .next
24704 A flag that specifies rewriting at SMTP time: S.
24705 .next
24706 Flags that control the rewriting process: Q, q, R, w.
24707 .endlist
24708
24709 For rules that are part of the &%headers_rewrite%& generic transport option,
24710 E, F, T, and S are not permitted.
24711
24712
24713
24714 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24715          "SECID154"
24716 .cindex "rewriting" "flags"
24717 If none of the following flag letters, nor the &"S"& flag (see section
24718 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24719 and to both the sender and recipient fields of the envelope, whereas a
24720 transport-time rewriting rule just applies to all headers. Otherwise, the
24721 rewriting rule is skipped unless the relevant addresses are being processed.
24722 .display
24723 &`E`&       rewrite all envelope fields
24724 &`F`&       rewrite the envelope From field
24725 &`T`&       rewrite the envelope To field
24726 &`b`&       rewrite the &'Bcc:'& header
24727 &`c`&       rewrite the &'Cc:'& header
24728 &`f`&       rewrite the &'From:'& header
24729 &`h`&       rewrite all headers
24730 &`r`&       rewrite the &'Reply-To:'& header
24731 &`s`&       rewrite the &'Sender:'& header
24732 &`t`&       rewrite the &'To:'& header
24733 .endd
24734 "All headers" means all of the headers listed above that can be selected
24735 individually, plus their &'Resent-'& versions. It does not include
24736 other headers such as &'Subject:'& etc.
24737
24738 You should be particularly careful about rewriting &'Sender:'& headers, and
24739 restrict this to special known cases in your own domains.
24740
24741
24742 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24743 .cindex "SMTP" "rewriting malformed addresses"
24744 .cindex "RCPT" "rewriting argument of"
24745 .cindex "MAIL" "rewriting argument of"
24746 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24747 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24748 before any other processing; even before syntax checking. The pattern is
24749 required to be a regular expression, and it is matched against the whole of the
24750 data for the command, including any surrounding angle brackets.
24751
24752 .vindex "&$domain$&"
24753 .vindex "&$local_part$&"
24754 This form of rewrite rule allows for the handling of addresses that are not
24755 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24756 input). Because the input is not required to be a syntactically valid address,
24757 the variables &$local_part$& and &$domain$& are not available during the
24758 expansion of the replacement string. The result of rewriting replaces the
24759 original address in the MAIL or RCPT command.
24760
24761
24762 .section "Flags controlling the rewriting process" "SECID155"
24763 There are four flags which control the way the rewriting process works. These
24764 take effect only when a rule is invoked, that is, when the address is of the
24765 correct type (matches the flags) and matches the pattern:
24766
24767 .ilist
24768 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24769 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24770 absence of &"Q"& the rewritten address must always include a domain.
24771 .next
24772 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24773 even if no rewriting actually takes place because of a &"fail"& in the
24774 expansion. The &"q"& flag is not effective if the address is of the wrong type
24775 (does not match the flags) or does not match the pattern.
24776 .next
24777 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24778 address, up to ten times. It can be combined with the &"q"& flag, to stop
24779 rewriting once it fails to match (after at least one successful rewrite).
24780 .next
24781 .cindex "rewriting" "whole addresses"
24782 When an address in a header is rewritten, the rewriting normally applies only
24783 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24784 left unchanged. For example, rewriting might change
24785 .code
24786 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24787 .endd
24788 into
24789 .code
24790 From: Ford Prefect <prefectf@hitch.fict.example>
24791 .endd
24792 .cindex "RFC 2047"
24793 Sometimes there is a need to replace the whole address item, and this can be
24794 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24795 causes an address in a header line to be rewritten, the entire address is
24796 replaced, not just the working part. The replacement must be a complete RFC
24797 2822 address, including the angle brackets if necessary. If text outside angle
24798 brackets contains a character whose value is greater than 126 or less than 32
24799 (except for tab), the text is encoded according to RFC 2047. The character set
24800 is taken from &%headers_charset%&, which gets its default at build time.
24801
24802 When the &"w"& flag is set on a rule that causes an envelope address to be
24803 rewritten, all but the working part of the replacement address is discarded.
24804 .endlist
24805
24806
24807 .section "Rewriting examples" "SECID156"
24808 Here is an example of the two common rewriting paradigms:
24809 .code
24810 *@*.hitch.fict.example  $1@hitch.fict.example
24811 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24812                      {$value}fail}@hitch.fict.example bctfrF
24813 .endd
24814 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24815 the string expansion to fail if the lookup does not succeed. In this context it
24816 has the effect of leaving the original address unchanged, but Exim goes on to
24817 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24818 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24819 explicitly, which would cause the rewritten address to be the same as before,
24820 at the cost of a small bit of processing. Not supplying either of these is an
24821 error, since the rewritten address would then contain no local part.
24822
24823 The first example above replaces the domain with a superior, more general
24824 domain. This may not be desirable for certain local parts. If the rule
24825 .code
24826 root@*.hitch.fict.example  *
24827 .endd
24828 were inserted before the first rule, rewriting would be suppressed for the
24829 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24830
24831 Rewriting can be made conditional on a number of tests, by making use of
24832 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24833 messages that originate outside the local host:
24834 .code
24835 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24836                          {$1@hitch.fict.example}fail}"
24837 .endd
24838 The replacement string is quoted in this example because it contains white
24839 space.
24840
24841 .cindex "rewriting" "bang paths"
24842 .cindex "bang paths" "rewriting"
24843 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24844 an address it treats it as an unqualified local part which it qualifies with
24845 the local qualification domain (if the source of the message is local or if the
24846 remote host is permitted to send unqualified addresses). Rewriting can
24847 sometimes be used to handle simple bang paths with a fixed number of
24848 components. For example, the rule
24849 .code
24850 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24851 .endd
24852 rewrites a two-component bang path &'host.name!user'& as the domain address
24853 &'user@host.name'&. However, there is a security implication in using this as
24854 a global rewriting rule for envelope addresses. It can provide a backdoor
24855 method for using your system as a relay, because the incoming addresses appear
24856 to be local. If the bang path addresses are received via SMTP, it is safer to
24857 use the &"S"& flag to rewrite them as they are received, so that relay checking
24858 can be done on the rewritten addresses.
24859 .ecindex IIDaddrew
24860
24861
24862
24863
24864
24865 . ////////////////////////////////////////////////////////////////////////////
24866 . ////////////////////////////////////////////////////////////////////////////
24867
24868 .chapter "Retry configuration" "CHAPretry"
24869 .scindex IIDretconf1 "retry" "configuration, description of"
24870 .scindex IIDregconf2 "configuration file" "retry section"
24871 The &"retry"& section of the runtime configuration file contains a list of
24872 retry rules that control how often Exim tries to deliver messages that cannot
24873 be delivered at the first attempt. If there are no retry rules (the section is
24874 empty or not present), there are no retries. In this situation, temporary
24875 errors are treated as permanent. The default configuration contains a single,
24876 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24877 line option can be used to test which retry rule will be used for a given
24878 address, domain and error.
24879
24880 The most common cause of retries is temporary failure to deliver to a remote
24881 host because the host is down, or inaccessible because of a network problem.
24882 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24883 address) basis, not on a per-message basis. Thus, if one message has recently
24884 been delayed, delivery of a new message to the same host is not immediately
24885 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24886 log selector is set, the message
24887 .cindex "retry" "time not reached"
24888 &"retry time not reached"& is written to the main log whenever a delivery is
24889 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24890 the handling of errors during remote deliveries.
24891
24892 Retry processing applies to routing as well as to delivering, except as covered
24893 in the next paragraph. The retry rules do not distinguish between these
24894 actions. It is not possible, for example, to specify different behaviour for
24895 failures to route the domain &'snark.fict.example'& and failures to deliver to
24896 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24897 added complication, so did not implement it. However, although they share the
24898 same retry rule, the actual retry times for routing and transporting a given
24899 domain are maintained independently.
24900
24901 When a delivery is not part of a queue run (typically an immediate delivery on
24902 receipt of a message), the routers are always run, and local deliveries are
24903 always attempted, even if retry times are set for them. This makes for better
24904 behaviour if one particular message is causing problems (for example, causing
24905 quota overflow, or provoking an error in a filter file). If such a delivery
24906 suffers a temporary failure, the retry data is updated as normal, and
24907 subsequent delivery attempts from queue runs occur only when the retry time for
24908 the local address is reached.
24909
24910 .section "Changing retry rules" "SECID157"
24911 If you change the retry rules in your configuration, you should consider
24912 whether or not to delete the retry data that is stored in Exim's spool area in
24913 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24914 always safe; that is why they are called &"hints"&.
24915
24916 The hints retry data contains suggested retry times based on the previous
24917 rules. In the case of a long-running problem with a remote host, it might
24918 record the fact that the host has timed out. If your new rules increase the
24919 timeout time for such a host, you should definitely remove the old retry data
24920 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24921 messages that it should now be retaining.
24922
24923
24924
24925 .section "Format of retry rules" "SECID158"
24926 .cindex "retry" "rules"
24927 Each retry rule occupies one line and consists of three or four parts,
24928 separated by white space: a pattern, an error name, an optional list of sender
24929 addresses, and a list of retry parameters. The pattern and sender lists must be
24930 enclosed in double quotes if they contain white space. The rules are searched
24931 in order until one is found where the pattern, error name, and sender list (if
24932 present) match the failing host or address, the error that occurred, and the
24933 message's sender, respectively.
24934
24935
24936 The pattern is any single item that may appear in an address list (see section
24937 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24938 which means that it is expanded before being tested against the address that
24939 has been delayed. A negated address list item is permitted. Address
24940 list processing treats a plain domain name as if it were preceded by &"*@"&,
24941 which makes it possible for many retry rules to start with just a domain. For
24942 example,
24943 .code
24944 lookingglass.fict.example        *  F,24h,30m;
24945 .endd
24946 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24947 whereas
24948 .code
24949 alice@lookingglass.fict.example  *  F,24h,30m;
24950 .endd
24951 applies only to temporary failures involving the local part &%alice%&.
24952 In practice, almost all rules start with a domain name pattern without a local
24953 part.
24954
24955 .cindex "regular expressions" "in retry rules"
24956 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24957 must match a complete address, not just a domain, because that is how regular
24958 expressions work in address lists.
24959 .display
24960 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24961 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24962 .endd
24963
24964
24965 .section "Choosing which retry rule to use for address errors" "SECID159"
24966 When Exim is looking for a retry rule after a routing attempt has failed (for
24967 example, after a DNS timeout), each line in the retry configuration is tested
24968 against the complete address only if &%retry_use_local_part%& is set for the
24969 router. Otherwise, only the domain is used, except when matching against a
24970 regular expression, when the local part of the address is replaced with &"*"&.
24971 A domain on its own can match a domain pattern, or a pattern that starts with
24972 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24973 &%check_local_user%& is true, and false for other routers.
24974
24975 Similarly, when Exim is looking for a retry rule after a local delivery has
24976 failed (for example, after a mailbox full error), each line in the retry
24977 configuration is tested against the complete address only if
24978 &%retry_use_local_part%& is set for the transport (it defaults true for all
24979 local transports).
24980
24981 .cindex "4&'xx'& responses" "retry rules for"
24982 However, when Exim is looking for a retry rule after a remote delivery attempt
24983 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24984 whole address is always used as the key when searching the retry rules. The
24985 rule that is found is used to create a retry time for the combination of the
24986 failing address and the message's sender. It is the combination of sender and
24987 recipient that is delayed in subsequent queue runs until its retry time is
24988 reached. You can delay the recipient without regard to the sender by setting
24989 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24990 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24991 commands.
24992
24993
24994
24995 .section "Choosing which retry rule to use for host and message errors" &&&
24996          "SECID160"
24997 For a temporary error that is not related to an individual address (for
24998 example, a connection timeout), each line in the retry configuration is checked
24999 twice. First, the name of the remote host is used as a domain name (preceded by
25000 &"*@"& when matching a regular expression). If this does not match the line,
25001 the domain from the email address is tried in a similar fashion. For example,
25002 suppose the MX records for &'a.b.c.example'& are
25003 .code
25004 a.b.c.example  MX  5  x.y.z.example
25005                MX  6  p.q.r.example
25006                MX  7  m.n.o.example
25007 .endd
25008 and the retry rules are
25009 .code
25010 p.q.r.example    *      F,24h,30m;
25011 a.b.c.example    *      F,4d,45m;
25012 .endd
25013 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25014 first rule matches neither the host nor the domain, so Exim looks at the second
25015 rule. This does not match the host, but it does match the domain, so it is used
25016 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25017 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25018 first retry rule is used, because it matches the host.
25019
25020 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25021 first rule to determine retry times, but for all the other hosts for the domain
25022 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25023 routing to &'a.b.c.example'& suffers a temporary failure.
25024
25025 &*Note*&: The host name is used when matching the patterns, not its IP address.
25026 However, if a message is routed directly to an IP address without the use of a
25027 host name, for example, if a &(manualroute)& router contains a setting such as:
25028 .code
25029 route_list = *.a.example  192.168.34.23
25030 .endd
25031 then the &"host name"& that is used when searching for a retry rule is the
25032 textual form of the IP address.
25033
25034 .section "Retry rules for specific errors" "SECID161"
25035 .cindex "retry" "specific errors; specifying"
25036 The second field in a retry rule is the name of a particular error, or an
25037 asterisk, which matches any error. The errors that can be tested for are:
25038
25039 .vlist
25040 .vitem &%auth_failed%&
25041 Authentication failed when trying to send to a host in the
25042 &%hosts_require_auth%& list in an &(smtp)& transport.
25043
25044 .vitem &%data_4xx%&
25045 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25046 after the command, or after sending the message's data.
25047
25048 .vitem &%mail_4xx%&
25049 A 4&'xx'& error was received for an outgoing MAIL command.
25050
25051 .vitem &%rcpt_4xx%&
25052 A 4&'xx'& error was received for an outgoing RCPT command.
25053 .endlist
25054
25055 For the three 4&'xx'& errors, either the first or both of the x's can be given
25056 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25057 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25058 and have retries every ten minutes with a one-hour timeout, you could set up a
25059 retry rule of this form:
25060 .code
25061 the.domain.name  rcpt_452   F,1h,10m
25062 .endd
25063 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25064 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25065
25066 .vlist
25067 .vitem &%lost_connection%&
25068 A server unexpectedly closed the SMTP connection. There may, of course,
25069 legitimate reasons for this (host died, network died), but if it repeats a lot
25070 for the same host, it indicates something odd.
25071
25072 .vitem &%lookup%&
25073 A DNS lookup for a host failed.
25074 Note that a &%dnslookup%& router will need to have matched
25075 its &%fail_defer_domains%& option for this retry type to be usable.
25076 Also note that a &%manualroute%& router will probably need
25077 its &%host_find_failed%& option set to &%defer%&.
25078
25079 .vitem &%refused_MX%&
25080 A connection to a host obtained from an MX record was refused.
25081
25082 .vitem &%refused_A%&
25083 A connection to a host not obtained from an MX record was refused.
25084
25085 .vitem &%refused%&
25086 A connection was refused.
25087
25088 .vitem &%timeout_connect_MX%&
25089 A connection attempt to a host obtained from an MX record timed out.
25090
25091 .vitem &%timeout_connect_A%&
25092 A connection attempt to a host not obtained from an MX record timed out.
25093
25094 .vitem &%timeout_connect%&
25095 A connection attempt timed out.
25096
25097 .vitem &%timeout_MX%&
25098 There was a timeout while connecting or during an SMTP session with a host
25099 obtained from an MX record.
25100
25101 .vitem &%timeout_A%&
25102 There was a timeout while connecting or during an SMTP session with a host not
25103 obtained from an MX record.
25104
25105 .vitem &%timeout%&
25106 There was a timeout while connecting or during an SMTP session.
25107
25108 .vitem &%tls_required%&
25109 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25110 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25111 to STARTTLS, or there was a problem setting up the TLS connection.
25112
25113 .vitem &%quota%&
25114 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25115 transport.
25116
25117 .vitem &%quota_%&<&'time'&>
25118 .cindex "quota" "error testing in retry rule"
25119 .cindex "retry" "quota error testing"
25120 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25121 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25122 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25123 for four days.
25124 .endlist
25125
25126 .cindex "mailbox" "time of last read"
25127 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25128 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25129 it should be based on the last time that the user accessed the mailbox.
25130 However, it is not always possible to determine this. Exim uses the following
25131 heuristic rules:
25132
25133 .ilist
25134 If the mailbox is a single file, the time of last access (the &"atime"&) is
25135 used. As no new messages are being delivered (because the mailbox is over
25136 quota), Exim does not access the file, so this is the time of last user access.
25137 .next
25138 .cindex "maildir format" "time of last read"
25139 For a maildir delivery, the time of last modification of the &_new_&
25140 subdirectory is used. As the mailbox is over quota, no new files are created in
25141 the &_new_& subdirectory, because no new messages are being delivered. Any
25142 change to the &_new_& subdirectory is therefore assumed to be the result of an
25143 MUA moving a new message to the &_cur_& directory when it is first read. The
25144 time that is used is therefore the last time that the user read a new message.
25145 .next
25146 For other kinds of multi-file mailbox, the time of last access cannot be
25147 obtained, so a retry rule that uses this type of error field is never matched.
25148 .endlist
25149
25150 The quota errors apply both to system-enforced quotas and to Exim's own quota
25151 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25152 when a local delivery is deferred because a partition is full (the ENOSPC
25153 error).
25154
25155
25156
25157 .section "Retry rules for specified senders" "SECID162"
25158 .cindex "retry" "rules; sender-specific"
25159 You can specify retry rules that apply only when the failing message has a
25160 specific sender. In particular, this can be used to define retry rules that
25161 apply only to bounce messages. The third item in a retry rule can be of this
25162 form:
25163 .display
25164 &`senders=`&<&'address list'&>
25165 .endd
25166 The retry timings themselves are then the fourth item. For example:
25167 .code
25168 *   rcpt_4xx   senders=:   F,1h,30m
25169 .endd
25170 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25171 host. If the address list contains white space, it must be enclosed in quotes.
25172 For example:
25173 .code
25174 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25175 .endd
25176 &*Warning*&: This facility can be unhelpful if it is used for host errors
25177 (which do not depend on the recipient). The reason is that the sender is used
25178 only to match the retry rule. Once the rule has been found for a host error,
25179 its contents are used to set a retry time for the host, and this will apply to
25180 all messages, not just those with specific senders.
25181
25182 When testing retry rules using &%-brt%&, you can supply a sender using the
25183 &%-f%& command line option, like this:
25184 .code
25185 exim -f "" -brt user@dom.ain
25186 .endd
25187 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25188 list is never matched.
25189
25190
25191
25192
25193
25194 .section "Retry parameters" "SECID163"
25195 .cindex "retry" "parameters in rules"
25196 The third (or fourth, if a senders list is present) field in a retry rule is a
25197 sequence of retry parameter sets, separated by semicolons. Each set consists of
25198 .display
25199 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25200 .endd
25201 The letter identifies the algorithm for computing a new retry time; the cutoff
25202 time is the time beyond which this algorithm no longer applies, and the
25203 arguments vary the algorithm's action. The cutoff time is measured from the
25204 time that the first failure for the domain (combined with the local part if
25205 relevant) was detected, not from the time the message was received.
25206
25207 .cindex "retry" "algorithms"
25208 .cindex "retry" "fixed intervals"
25209 .cindex "retry" "increasing intervals"
25210 .cindex "retry" "random intervals"
25211 The available algorithms are:
25212
25213 .ilist
25214 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25215 the interval.
25216 .next
25217 &'G'&: retry at geometrically increasing intervals. The first argument
25218 specifies a starting value for the interval, and the second a multiplier, which
25219 is used to increase the size of the interval at each retry.
25220 .next
25221 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25222 retry, the previous interval is multiplied by the factor in order to get a
25223 maximum for the next interval. The minimum interval is the first argument of
25224 the parameter, and an actual interval is chosen randomly between them. Such a
25225 rule has been found to be helpful in cluster configurations when all the
25226 members of the cluster restart at once, and may therefore synchronize their
25227 queue processing times.
25228 .endlist
25229
25230 When computing the next retry time, the algorithm definitions are scanned in
25231 order until one whose cutoff time has not yet passed is reached. This is then
25232 used to compute a new retry time that is later than the current time. In the
25233 case of fixed interval retries, this simply means adding the interval to the
25234 current time. For geometrically increasing intervals, retry intervals are
25235 computed from the rule's parameters until one that is greater than the previous
25236 interval is found. The main configuration variable
25237 .cindex "limit" "retry interval"
25238 .cindex "retry" "interval, maximum"
25239 .oindex "&%retry_interval_max%&"
25240 &%retry_interval_max%& limits the maximum interval between retries. It
25241 cannot be set greater than &`24h`&, which is its default value.
25242
25243 A single remote domain may have a number of hosts associated with it, and each
25244 host may have more than one IP address. Retry algorithms are selected on the
25245 basis of the domain name, but are applied to each IP address independently. If,
25246 for example, a host has two IP addresses and one is unusable, Exim will
25247 generate retry times for it and will not try to use it until its next retry
25248 time comes. Thus the good IP address is likely to be tried first most of the
25249 time.
25250
25251 .cindex "hints database" "use for retrying"
25252 Retry times are hints rather than promises. Exim does not make any attempt to
25253 run deliveries exactly at the computed times. Instead, a queue runner process
25254 starts delivery processes for delayed messages periodically, and these attempt
25255 new deliveries only for those addresses that have passed their next retry time.
25256 If a new message arrives for a deferred address, an immediate delivery attempt
25257 occurs only if the address has passed its retry time. In the absence of new
25258 messages, the minimum time between retries is the interval between queue runner
25259 processes. There is not much point in setting retry times of five minutes if
25260 your queue runners happen only once an hour, unless there are a significant
25261 number of incoming messages (which might be the case on a system that is
25262 sending everything to a smart host, for example).
25263
25264 The data in the retry hints database can be inspected by using the
25265 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25266 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25267 &'exinext'& utility script can be used to find out what the next retry times
25268 are for the hosts associated with a particular mail domain, and also for local
25269 deliveries that have been deferred.
25270
25271
25272 .section "Retry rule examples" "SECID164"
25273 Here are some example retry rules:
25274 .code
25275 alice@wonderland.fict.example quota_5d  F,7d,3h
25276 wonderland.fict.example       quota_5d
25277 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25278 lookingglass.fict.example     *         F,24h,30m;
25279 *                 refused_A   F,2h,20m;
25280 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25281 .endd
25282 The first rule sets up special handling for mail to
25283 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25284 mailbox has not been read for at least 5 days. Retries continue every three
25285 hours for 7 days. The second rule handles over-quota errors for all other local
25286 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25287 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25288 fail are bounced immediately if the mailbox has not been read for at least 5
25289 days.
25290
25291 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25292 happen every 15 minutes for an hour, then with geometrically increasing
25293 intervals until two days have passed since a delivery first failed. After the
25294 first hour there is a delay of one hour, then two hours, then four hours, and
25295 so on (this is a rather extreme example).
25296
25297 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25298 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25299 all other domains, with special action for connection refusal from hosts that
25300 were not obtained from an MX record.
25301
25302 The final rule in a retry configuration should always have asterisks in the
25303 first two fields so as to provide a general catch-all for any addresses that do
25304 not have their own special handling. This example tries every 15 minutes for 2
25305 hours, then with intervals starting at one hour and increasing by a factor of
25306 1.5 up to 16 hours, then every 8 hours up to 5 days.
25307
25308
25309
25310 .section "Timeout of retry data" "SECID165"
25311 .cindex "timeout" "of retry data"
25312 .oindex "&%retry_data_expire%&"
25313 .cindex "hints database" "data expiry"
25314 .cindex "retry" "timeout of data"
25315 Exim timestamps the data that it writes to its retry hints database. When it
25316 consults the data during a delivery it ignores any that is older than the value
25317 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25318 been tried for 7 days, Exim will try to deliver to it immediately a message
25319 arrives, and if that fails, it will calculate a retry time as if it were
25320 failing for the first time.
25321
25322 This improves the behaviour for messages routed to rarely-used hosts such as MX
25323 backups. If such a host was down at one time, and happens to be down again when
25324 Exim tries a month later, using the old retry data would imply that it had been
25325 down all the time, which is not a justified assumption.
25326
25327 If a host really is permanently dead, this behaviour causes a burst of retries
25328 every now and again, but only if messages routed to it are rare. If there is a
25329 message at least once every 7 days the retry data never expires.
25330
25331
25332
25333
25334 .section "Long-term failures" "SECID166"
25335 .cindex "delivery failure, long-term"
25336 .cindex "retry" "after long-term failure"
25337 Special processing happens when an email address has been failing for so long
25338 that the cutoff time for the last algorithm is reached. For example, using the
25339 default retry rule:
25340 .code
25341 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25342 .endd
25343 the cutoff time is four days. Reaching the retry cutoff is independent of how
25344 long any specific message has been failing; it is the length of continuous
25345 failure for the recipient address that counts.
25346
25347 When the cutoff time is reached for a local delivery, or for all the IP
25348 addresses associated with a remote delivery, a subsequent delivery failure
25349 causes Exim to give up on the address, and a bounce message is generated.
25350 In order to cater for new messages that use the failing address, a next retry
25351 time is still computed from the final algorithm, and is used as follows:
25352
25353 For local deliveries, one delivery attempt is always made for any subsequent
25354 messages. If this delivery fails, the address fails immediately. The
25355 post-cutoff retry time is not used.
25356
25357 If the delivery is remote, there are two possibilities, controlled by the
25358 .oindex "&%delay_after_cutoff%&"
25359 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25360 default. Until the post-cutoff retry time for one of the IP addresses is
25361 reached, the failing email address is bounced immediately, without a delivery
25362 attempt taking place. After that time, one new delivery attempt is made to
25363 those IP addresses that are past their retry times, and if that still fails,
25364 the address is bounced and new retry times are computed.
25365
25366 In other words, when all the hosts for a given email address have been failing
25367 for a long time, Exim bounces rather then defers until one of the hosts' retry
25368 times is reached. Then it tries once, and bounces if that attempt fails. This
25369 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25370 to a broken destination, but if the host does recover, Exim will eventually
25371 notice.
25372
25373 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25374 addresses are past their final cutoff time, Exim tries to deliver to those IP
25375 addresses that have not been tried since the message arrived. If there are
25376 no suitable IP addresses, or if they all fail, the address is bounced. In other
25377 words, it does not delay when a new message arrives, but tries the expired
25378 addresses immediately, unless they have been tried since the message arrived.
25379 If there is a continuous stream of messages for the failing domains, setting
25380 &%delay_after_cutoff%& false means that there will be many more attempts to
25381 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25382 true.
25383
25384 .section "Deliveries that work intermittently" "SECID167"
25385 .cindex "retry" "intermittently working deliveries"
25386 Some additional logic is needed to cope with cases where a host is
25387 intermittently available, or when a message has some attribute that prevents
25388 its delivery when others to the same address get through. In this situation,
25389 because some messages are successfully delivered, the &"retry clock"& for the
25390 host or address keeps getting reset by the successful deliveries, and so
25391 failing messages remain on the queue for ever because the cutoff time is never
25392 reached.
25393
25394 Two exceptional actions are applied to prevent this happening. The first
25395 applies to errors that are related to a message rather than a remote host.
25396 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25397 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25398 commands, and quota failures. For this type of error, if a message's arrival
25399 time is earlier than the &"first failed"& time for the error, the earlier time
25400 is used when scanning the retry rules to decide when to try next and when to
25401 time out the address.
25402
25403 The exceptional second action applies in all cases. If a message has been on
25404 the queue for longer than the cutoff time of any applicable retry rule for a
25405 given address, a delivery is attempted for that address, even if it is not yet
25406 time, and if this delivery fails, the address is timed out. A new retry time is
25407 not computed in this case, so that other messages for the same address are
25408 considered immediately.
25409 .ecindex IIDretconf1
25410 .ecindex IIDregconf2
25411
25412
25413
25414
25415
25416
25417 . ////////////////////////////////////////////////////////////////////////////
25418 . ////////////////////////////////////////////////////////////////////////////
25419
25420 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25421 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25422 .scindex IIDauthconf2 "authentication"
25423 The &"authenticators"& section of Exim's run time configuration is concerned
25424 with SMTP authentication. This facility is an extension to the SMTP protocol,
25425 described in RFC 2554, which allows a client SMTP host to authenticate itself
25426 to a server. This is a common way for a server to recognize clients that are
25427 permitted to use it as a relay. SMTP authentication is not of relevance to the
25428 transfer of mail between servers that have no managerial connection with each
25429 other.
25430
25431 .cindex "AUTH" "description of"
25432 Very briefly, the way SMTP authentication works is as follows:
25433
25434 .ilist
25435 The server advertises a number of authentication &'mechanisms'& in response to
25436 the client's EHLO command.
25437 .next
25438 The client issues an AUTH command, naming a specific mechanism. The command
25439 may, optionally, contain some authentication data.
25440 .next
25441 The server may issue one or more &'challenges'&, to which the client must send
25442 appropriate responses. In simple authentication mechanisms, the challenges are
25443 just prompts for user names and passwords. The server does not have to issue
25444 any challenges &-- in some mechanisms the relevant data may all be transmitted
25445 with the AUTH command.
25446 .next
25447 The server either accepts or denies authentication.
25448 .next
25449 If authentication succeeds, the client may optionally make use of the AUTH
25450 option on the MAIL command to pass an authenticated sender in subsequent
25451 mail transactions. Authentication lasts for the remainder of the SMTP
25452 connection.
25453 .next
25454 If authentication fails, the client may give up, or it may try a different
25455 authentication mechanism, or it may try transferring mail over the
25456 unauthenticated connection.
25457 .endlist
25458
25459 If you are setting up a client, and want to know which authentication
25460 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25461 SMTP port) on the server, and issue an EHLO command. The response to this
25462 includes the list of supported mechanisms. For example:
25463 .display
25464 &`$ `&&*&`telnet server.example 25`&*&
25465 &`Trying 192.168.34.25...`&
25466 &`Connected to server.example.`&
25467 &`Escape character is &#x0027;^]&#x0027;.`&
25468 &`220 server.example ESMTP Exim 4.20 ...`&
25469 &*&`ehlo client.example`&*&
25470 &`250-server.example Hello client.example [10.8.4.5]`&
25471 &`250-SIZE 52428800`&
25472 &`250-PIPELINING`&
25473 &`250-AUTH PLAIN`&
25474 &`250 HELP`&
25475 .endd
25476 The second-last line of this example output shows that the server supports
25477 authentication using the PLAIN mechanism. In Exim, the different authentication
25478 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25479 routers and transports, which authenticators are included in the binary is
25480 controlled by build-time definitions. The following are currently available,
25481 included by setting
25482 .code
25483 AUTH_CRAM_MD5=yes
25484 AUTH_CYRUS_SASL=yes
25485 AUTH_DOVECOT=yes
25486 AUTH_GSASL=yes
25487 AUTH_HEIMDAL_GSSAPI=yes
25488 AUTH_PLAINTEXT=yes
25489 AUTH_SPA=yes
25490 AUTH_TLS=yes
25491 .endd
25492 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25493 authentication mechanism (RFC 2195), and the second provides an interface to
25494 the Cyrus SASL authentication library.
25495 The third is an interface to Dovecot's authentication system, delegating the
25496 work via a socket interface.
25497 The fourth provides an interface to the GNU SASL authentication library, which
25498 provides mechanisms but typically not data sources.
25499 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25500 supporting setting a server keytab.
25501 The sixth can be configured to support
25502 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25503 not formally documented, but used by several MUAs. The seventh authenticator
25504 supports Microsoft's &'Secure Password Authentication'& mechanism.
25505 The eighth is an Exim authenticator but not an SMTP one;
25506 instead it can use information from a TLS negotiation.
25507
25508 The authenticators are configured using the same syntax as other drivers (see
25509 section &<<SECTfordricon>>&). If no authenticators are required, no
25510 authentication section need be present in the configuration file. Each
25511 authenticator can in principle have both server and client functions. When Exim
25512 is receiving SMTP mail, it is acting as a server; when it is sending out
25513 messages over SMTP, it is acting as a client. Authenticator configuration
25514 options are provided for use in both these circumstances.
25515
25516 To make it clear which options apply to which situation, the prefixes
25517 &%server_%& and &%client_%& are used on option names that are specific to
25518 either the server or the client function, respectively. Server and client
25519 functions are disabled if none of their options are set. If an authenticator is
25520 to be used for both server and client functions, a single definition, using
25521 both sets of options, is required. For example:
25522 .code
25523 cram:
25524   driver = cram_md5
25525   public_name = CRAM-MD5
25526   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25527   client_name = ph10
25528   client_secret = secret2
25529 .endd
25530 The &%server_%& option is used when Exim is acting as a server, and the
25531 &%client_%& options when it is acting as a client.
25532
25533 Descriptions of the individual authenticators are given in subsequent chapters.
25534 The remainder of this chapter covers the generic options for the
25535 authenticators, followed by general discussion of the way authentication works
25536 in Exim.
25537
25538 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25539 per-mechanism basis.  Please read carefully to determine which variables hold
25540 account labels such as usercodes and which hold passwords or other
25541 authenticating data.
25542
25543 Note that some mechanisms support two different identifiers for accounts: the
25544 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25545 and &'authz'& are commonly encountered.  The American spelling is standard here.
25546 Conceptually, authentication data such as passwords are tied to the identifier
25547 used to authenticate; servers may have rules to permit one user to act as a
25548 second user, so that after login the session is treated as though that second
25549 user had logged in.  That second user is the &'authorization id'&.  A robust
25550 configuration might confirm that the &'authz'& field is empty or matches the
25551 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25552 as verified data, the &'authz'& as an unverified request which the server might
25553 choose to honour.
25554
25555 A &'realm'& is a text string, typically a domain name, presented by a server
25556 to a client to help it select an account and credentials to use.  In some
25557 mechanisms, the client and server provably agree on the realm, but clients
25558 typically can not treat the realm as secure data to be blindly trusted.
25559
25560
25561
25562 .section "Generic options for authenticators" "SECID168"
25563 .cindex "authentication" "generic options"
25564 .cindex "options" "generic; for authenticators"
25565
25566 .option client_condition authenticators string&!! unset
25567 When Exim is authenticating as a client, it skips any authenticator whose
25568 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25569 used, for example, to skip plain text authenticators when the connection is not
25570 encrypted by a setting such as:
25571 .code
25572 client_condition = ${if !eq{$tls_out_cipher}{}}
25573 .endd
25574
25575
25576 .option client_set_id authenticators string&!! unset
25577 When client authentication succeeds, this condition is expanded; the
25578 result is used in the log lines for outbound messages.
25579 Typically it will be the user name used for authentication.
25580
25581
25582 .option driver authenticators string unset
25583 This option must always be set. It specifies which of the available
25584 authenticators is to be used.
25585
25586
25587 .option public_name authenticators string unset
25588 This option specifies the name of the authentication mechanism that the driver
25589 implements, and by which it is known to the outside world. These names should
25590 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25591 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25592 defaults to the driver's instance name.
25593
25594
25595 .option server_advertise_condition authenticators string&!! unset
25596 When a server is about to advertise an authentication mechanism, the condition
25597 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25598 mechanism is not advertised.
25599 If the expansion fails, the mechanism is not advertised. If the failure was not
25600 forced, and was not caused by a lookup defer, the incident is logged.
25601 See section &<<SECTauthexiser>>& below for further discussion.
25602
25603
25604 .option server_condition authenticators string&!! unset
25605 This option must be set for a &%plaintext%& server authenticator, where it
25606 is used directly to control authentication. See section &<<SECTplainserver>>&
25607 for details.
25608
25609 For the &(gsasl)& authenticator, this option is required for various
25610 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25611
25612 For the other authenticators, &%server_condition%& can be used as an additional
25613 authentication or authorization mechanism that is applied after the other
25614 authenticator conditions succeed. If it is set, it is expanded when the
25615 authenticator would otherwise return a success code. If the expansion is forced
25616 to fail, authentication fails. Any other expansion failure causes a temporary
25617 error code to be returned. If the result of a successful expansion is an empty
25618 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25619 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25620 other result, a temporary error code is returned, with the expanded string as
25621 the error text.
25622
25623
25624 .option server_debug_print authenticators string&!! unset
25625 If this option is set and authentication debugging is enabled (see the &%-d%&
25626 command line option), the string is expanded and included in the debugging
25627 output when the authenticator is run as a server. This can help with checking
25628 out the values of variables.
25629 If expansion of the string fails, the error message is written to the debugging
25630 output, and Exim carries on processing.
25631
25632
25633 .option server_set_id authenticators string&!! unset
25634 .vindex "&$authenticated_id$&"
25635 When an Exim server successfully authenticates a client, this string is
25636 expanded using data from the authentication, and preserved for any incoming
25637 messages in the variable &$authenticated_id$&. It is also included in the log
25638 lines for incoming messages. For example, a user/password authenticator
25639 configuration might preserve the user name that was used to authenticate, and
25640 refer to it subsequently during delivery of the message.
25641 If expansion fails, the option is ignored.
25642
25643
25644 .option server_mail_auth_condition authenticators string&!! unset
25645 This option allows a server to discard authenticated sender addresses supplied
25646 as part of MAIL commands in SMTP connections that are authenticated by the
25647 driver on which &%server_mail_auth_condition%& is set. The option is not used
25648 as part of the authentication process; instead its (unexpanded) value is
25649 remembered for later use.
25650 How it is used is described in the following section.
25651
25652
25653
25654
25655
25656 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25657 .cindex "authentication" "sender; authenticated"
25658 .cindex "AUTH" "on MAIL command"
25659 When a client supplied an AUTH= item on a MAIL command, Exim applies
25660 the following checks before accepting it as the authenticated sender of the
25661 message:
25662
25663 .ilist
25664 If the connection is not using extended SMTP (that is, HELO was used rather
25665 than EHLO), the use of AUTH= is a syntax error.
25666 .next
25667 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25668 .next
25669 .vindex "&$authenticated_sender$&"
25670 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25671 running, the value of &$authenticated_sender$& is set to the value obtained
25672 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25673 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25674 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25675 given for the MAIL command.
25676 .next
25677 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25678 is accepted and placed in &$authenticated_sender$& only if the client has
25679 authenticated.
25680 .next
25681 If the AUTH= value was accepted by either of the two previous rules, and
25682 the client has authenticated, and the authenticator has a setting for the
25683 &%server_mail_auth_condition%&, the condition is checked at this point. The
25684 valued that was saved from the authenticator is expanded. If the expansion
25685 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25686 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25687 the value of &$authenticated_sender$& is retained and passed on with the
25688 message.
25689 .endlist
25690
25691
25692 When &$authenticated_sender$& is set for a message, it is passed on to other
25693 hosts to which Exim authenticates as a client. Do not confuse this value with
25694 &$authenticated_id$&, which is a string obtained from the authentication
25695 process, and which is not usually a complete email address.
25696
25697 .vindex "&$sender_address$&"
25698 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25699 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25700 therefore make use of &$authenticated_sender$&. The converse is not true: the
25701 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25702 ACL is run.
25703
25704
25705
25706 .section "Authentication on an Exim server" "SECTauthexiser"
25707 .cindex "authentication" "on an Exim server"
25708 When Exim receives an EHLO command, it advertises the public names of those
25709 authenticators that are configured as servers, subject to the following
25710 conditions:
25711
25712 .ilist
25713 The client host must match &%auth_advertise_hosts%& (default *).
25714 .next
25715 It the &%server_advertise_condition%& option is set, its expansion must not
25716 yield the empty string, &"0"&, &"no"&, or &"false"&.
25717 .endlist
25718
25719 The order in which the authenticators are defined controls the order in which
25720 the mechanisms are advertised.
25721
25722 Some mail clients (for example, some versions of Netscape) require the user to
25723 provide a name and password for authentication whenever AUTH is advertised,
25724 even though authentication may not in fact be needed (for example, Exim may be
25725 set up to allow unconditional relaying from the client by an IP address check).
25726 You can make such clients more friendly by not advertising AUTH to them.
25727 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25728 that runs for RCPT) to relay without authentication, you should set
25729 .code
25730 auth_advertise_hosts = ! 10.9.8.0/24
25731 .endd
25732 so that no authentication mechanisms are advertised to them.
25733
25734 The &%server_advertise_condition%& controls the advertisement of individual
25735 authentication mechanisms. For example, it can be used to restrict the
25736 advertisement of a particular mechanism to encrypted connections, by a setting
25737 such as:
25738 .code
25739 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25740 .endd
25741 .vindex "&$tls_in_cipher$&"
25742 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25743 yields &"yes"&, which allows the advertisement to happen.
25744
25745 When an Exim server receives an AUTH command from a client, it rejects it
25746 immediately if AUTH was not advertised in response to an earlier EHLO
25747 command. This is the case if
25748
25749 .ilist
25750 The client host does not match &%auth_advertise_hosts%&; or
25751 .next
25752 No authenticators are configured with server options; or
25753 .next
25754 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25755 server authenticators.
25756 .endlist
25757
25758
25759 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25760 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25761 AUTH is accepted from any client host.
25762
25763 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25764 server authentication mechanism that was advertised in response to EHLO and
25765 that matches the one named in the AUTH command. If it finds one, it runs
25766 the appropriate authentication protocol, and authentication either succeeds or
25767 fails. If there is no matching advertised mechanism, the AUTH command is
25768 rejected with a 504 error.
25769
25770 .vindex "&$received_protocol$&"
25771 .vindex "&$sender_host_authenticated$&"
25772 When a message is received from an authenticated host, the value of
25773 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25774 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25775 public name) of the authenticator driver that successfully authenticated the
25776 client from which the message was received. This variable is empty if there was
25777 no successful authentication.
25778
25779
25780
25781
25782 .section "Testing server authentication" "SECID169"
25783 .cindex "authentication" "testing a server"
25784 .cindex "AUTH" "testing a server"
25785 .cindex "base64 encoding" "creating authentication test data"
25786 Exim's &%-bh%& option can be useful for testing server authentication
25787 configurations. The data for the AUTH command has to be sent using base64
25788 encoding. A quick way to produce such data for testing is the following Perl
25789 script:
25790 .code
25791 use MIME::Base64;
25792 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25793 .endd
25794 .cindex "binary zero" "in authentication data"
25795 This interprets its argument as a Perl string, and then encodes it. The
25796 interpretation as a Perl string allows binary zeros, which are required for
25797 some kinds of authentication, to be included in the data. For example, a
25798 command line to run this script on such data might be
25799 .code
25800 encode '\0user\0password'
25801 .endd
25802 Note the use of single quotes to prevent the shell interpreting the
25803 backslashes, so that they can be interpreted by Perl to specify characters
25804 whose code value is zero.
25805
25806 &*Warning 1*&: If either of the user or password strings starts with an octal
25807 digit, you must use three zeros instead of one after the leading backslash. If
25808 you do not, the octal digit that starts your string will be incorrectly
25809 interpreted as part of the code for the first character.
25810
25811 &*Warning 2*&: If there are characters in the strings that Perl interprets
25812 specially, you must use a Perl escape to prevent them being misinterpreted. For
25813 example, a command such as
25814 .code
25815 encode '\0user@domain.com\0pas$$word'
25816 .endd
25817 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25818
25819 If you have the &%mimencode%& command installed, another way to do produce
25820 base64-encoded strings is to run the command
25821 .code
25822 echo -e -n `\0user\0password' | mimencode
25823 .endd
25824 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25825 in the argument, and the &%-n%& option specifies no newline at the end of its
25826 output. However, not all versions of &%echo%& recognize these options, so you
25827 should check your version before relying on this suggestion.
25828
25829
25830
25831 .section "Authentication by an Exim client" "SECID170"
25832 .cindex "authentication" "on an Exim client"
25833 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25834 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25835 announces support for authentication, and the host matches an entry in either
25836 of these options, Exim (as a client) tries to authenticate as follows:
25837
25838 .ilist
25839 For each authenticator that is configured as a client, in the order in which
25840 they are defined in the configuration, it searches the authentication
25841 mechanisms announced by the server for one whose name matches the public name
25842 of the authenticator.
25843 .next
25844 .vindex "&$host$&"
25845 .vindex "&$host_address$&"
25846 When it finds one that matches, it runs the authenticator's client code. The
25847 variables &$host$& and &$host_address$& are available for any string expansions
25848 that the client might do. They are set to the server's name and IP address. If
25849 any expansion is forced to fail, the authentication attempt is abandoned, and
25850 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25851 delivery to be deferred.
25852 .next
25853 If the result of the authentication attempt is a temporary error or a timeout,
25854 Exim abandons trying to send the message to the host for the moment. It will
25855 try again later. If there are any backup hosts available, they are tried in the
25856 usual way.
25857 .next
25858 If the response to authentication is a permanent error (5&'xx'& code), Exim
25859 carries on searching the list of authenticators and tries another one if
25860 possible. If all authentication attempts give permanent errors, or if there are
25861 no attempts because no mechanisms match (or option expansions force failure),
25862 what happens depends on whether the host matches &%hosts_require_auth%& or
25863 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25864 delivery is deferred. The error can be detected in the retry rules, and thereby
25865 turned into a permanent error if you wish. In the second case, Exim tries to
25866 deliver the message unauthenticated.
25867 .endlist
25868
25869 .cindex "AUTH" "on MAIL command"
25870 When Exim has authenticated itself to a remote server, it adds the AUTH
25871 parameter to the MAIL commands it sends, if it has an authenticated sender for
25872 the message. If the message came from a remote host, the authenticated sender
25873 is the one that was receiving on an incoming MAIL command, provided that the
25874 incoming connection was authenticated and the &%server_mail_auth%& condition
25875 allowed the authenticated sender to be retained. If a local process calls Exim
25876 to send a message, the sender address that is built from the login name and
25877 &%qualify_domain%& is treated as authenticated. However, if the
25878 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25879 the authenticated sender that was received with the message.
25880 .ecindex IIDauthconf1
25881 .ecindex IIDauthconf2
25882
25883
25884
25885
25886
25887
25888 . ////////////////////////////////////////////////////////////////////////////
25889 . ////////////////////////////////////////////////////////////////////////////
25890
25891 .chapter "The plaintext authenticator" "CHAPplaintext"
25892 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25893 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25894 The &(plaintext)& authenticator can be configured to support the PLAIN and
25895 LOGIN authentication mechanisms, both of which transfer authentication data as
25896 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25897 security risk; you are strongly advised to insist on the use of SMTP encryption
25898 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25899 use unencrypted plain text, you should not use the same passwords for SMTP
25900 connections as you do for login accounts.
25901
25902 .section "Plaintext options" "SECID171"
25903 .cindex "options" "&(plaintext)& authenticator (server)"
25904 When configured as a server, &(plaintext)& uses the following options:
25905
25906 .option server_condition authenticators string&!! unset
25907 This is actually a global authentication option, but it must be set in order to
25908 configure the &(plaintext)& driver as a server. Its use is described below.
25909
25910 .option server_prompts plaintext string&!! unset
25911 The contents of this option, after expansion, must be a colon-separated list of
25912 prompt strings. If expansion fails, a temporary authentication rejection is
25913 given.
25914
25915 .section "Using plaintext in a server" "SECTplainserver"
25916 .cindex "AUTH" "in &(plaintext)& authenticator"
25917 .cindex "binary zero" "in &(plaintext)& authenticator"
25918 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25919         "in &(plaintext)& authenticator"
25920 .vindex "&$auth1$&, &$auth2$&, etc"
25921 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25922
25923 When running as a server, &(plaintext)& performs the authentication test by
25924 expanding a string. The data sent by the client with the AUTH command, or in
25925 response to subsequent prompts, is base64 encoded, and so may contain any byte
25926 values when decoded. If any data is supplied with the command, it is treated as
25927 a list of strings, separated by NULs (binary zeros), the first three of which
25928 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25929 (neither LOGIN nor PLAIN uses more than three strings).
25930
25931 For compatibility with previous releases of Exim, the values are also placed in
25932 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25933 variables for this purpose is now deprecated, as it can lead to confusion in
25934 string expansions that also use them for other things.
25935
25936 If there are more strings in &%server_prompts%& than the number of strings
25937 supplied with the AUTH command, the remaining prompts are used to obtain more
25938 data. Each response from the client may be a list of NUL-separated strings.
25939
25940 .vindex "&$authenticated_id$&"
25941 Once a sufficient number of data strings have been received,
25942 &%server_condition%& is expanded. If the expansion is forced to fail,
25943 authentication fails. Any other expansion failure causes a temporary error code
25944 to be returned. If the result of a successful expansion is an empty string,
25945 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25946 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25947 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25948 For any other result, a temporary error code is returned, with the expanded
25949 string as the error text
25950
25951 &*Warning*&: If you use a lookup in the expansion to find the user's
25952 password, be sure to make the authentication fail if the user is unknown.
25953 There are good and bad examples at the end of the next section.
25954
25955
25956
25957 .section "The PLAIN authentication mechanism" "SECID172"
25958 .cindex "PLAIN authentication mechanism"
25959 .cindex "authentication" "PLAIN mechanism"
25960 .cindex "binary zero" "in &(plaintext)& authenticator"
25961 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25962 sent as one item of data (that is, one combined string containing two NUL
25963 separators). The data is sent either as part of the AUTH command, or
25964 subsequently in response to an empty prompt from the server.
25965
25966 The second and third strings are a user name and a corresponding password.
25967 Using a single fixed user name and password as an example, this could be
25968 configured as follows:
25969 .code
25970 fixed_plain:
25971   driver = plaintext
25972   public_name = PLAIN
25973   server_prompts = :
25974   server_condition = \
25975     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25976   server_set_id = $auth2
25977 .endd
25978 Note that the default result strings from &%if%& (&"true"& or an empty string)
25979 are exactly what we want here, so they need not be specified. Obviously, if the
25980 password contains expansion-significant characters such as dollar, backslash,
25981 or closing brace, they have to be escaped.
25982
25983 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25984 the end of a string list are ignored). If all the data comes as part of the
25985 AUTH command, as is commonly the case, the prompt is not used. This
25986 authenticator is advertised in the response to EHLO as
25987 .code
25988 250-AUTH PLAIN
25989 .endd
25990 and a client host can authenticate itself by sending the command
25991 .code
25992 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25993 .endd
25994 As this contains three strings (more than the number of prompts), no further
25995 data is required from the client. Alternatively, the client may just send
25996 .code
25997 AUTH PLAIN
25998 .endd
25999 to initiate authentication, in which case the server replies with an empty
26000 prompt. The client must respond with the combined data string.
26001
26002 The data string is base64 encoded, as required by the RFC. This example,
26003 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26004 represents a zero byte. This is split up into three strings, the first of which
26005 is empty. The &%server_condition%& option in the authenticator checks that the
26006 second two are &`username`& and &`mysecret`& respectively.
26007
26008 Having just one fixed user name and password, as in this example, is not very
26009 realistic, though for a small organization with only a handful of
26010 authenticating clients it could make sense.
26011
26012 A more sophisticated instance of this authenticator could use the user name in
26013 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26014 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26015 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26016 This is an incorrect example:
26017 .code
26018 server_condition = \
26019   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26020 .endd
26021 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26022 which it then compares to the supplied password (&$auth3$&). Why is this example
26023 incorrect? It works fine for existing users, but consider what happens if a
26024 non-existent user name is given. The lookup fails, but as no success/failure
26025 strings are given for the lookup, it yields an empty string. Thus, to defeat
26026 the authentication, all a client has to do is to supply a non-existent user
26027 name and an empty password. The correct way of writing this test is:
26028 .code
26029 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26030   {${if eq{$value}{$auth3}}} {false}}
26031 .endd
26032 In this case, if the lookup succeeds, the result is checked; if the lookup
26033 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26034 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26035 always fails if its second argument is empty. However, the second way of
26036 writing the test makes the logic clearer.
26037
26038
26039 .section "The LOGIN authentication mechanism" "SECID173"
26040 .cindex "LOGIN authentication mechanism"
26041 .cindex "authentication" "LOGIN mechanism"
26042 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26043 in a number of programs. No data is sent with the AUTH command. Instead, a
26044 user name and password are supplied separately, in response to prompts. The
26045 plaintext authenticator can be configured to support this as in this example:
26046 .code
26047 fixed_login:
26048   driver = plaintext
26049   public_name = LOGIN
26050   server_prompts = User Name : Password
26051   server_condition = \
26052     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26053   server_set_id = $auth1
26054 .endd
26055 Because of the way plaintext operates, this authenticator accepts data supplied
26056 with the AUTH command (in contravention of the specification of LOGIN), but
26057 if the client does not supply it (as is the case for LOGIN clients), the prompt
26058 strings are used to obtain two data items.
26059
26060 Some clients are very particular about the precise text of the prompts. For
26061 example, Outlook Express is reported to recognize only &"Username:"& and
26062 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26063 strings. It uses the &%ldapauth%& expansion condition to check the user
26064 name and password by binding to an LDAP server:
26065 .code
26066 login:
26067   driver = plaintext
26068   public_name = LOGIN
26069   server_prompts = Username:: : Password::
26070   server_condition = ${if and{{ \
26071     !eq{}{$auth1} }{ \
26072     ldapauth{\
26073       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26074       pass=${quote:$auth2} \
26075       ldap://ldap.example.org/} }} }
26076   server_set_id = uid=$auth1,ou=people,o=example.org
26077 .endd
26078 We have to check that the username is not empty before using it, because LDAP
26079 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26080 operator to correctly quote the DN for authentication. However, the basic
26081 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26082 correct one to use for the password, because quoting is needed only to make
26083 the password conform to the Exim syntax. At the LDAP level, the password is an
26084 uninterpreted string.
26085
26086
26087 .section "Support for different kinds of authentication" "SECID174"
26088 A number of string expansion features are provided for the purpose of
26089 interfacing to different ways of user authentication. These include checking
26090 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26091 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26092 &<<SECTexpcond>>&.
26093
26094
26095
26096
26097 .section "Using plaintext in a client" "SECID175"
26098 .cindex "options" "&(plaintext)& authenticator (client)"
26099 The &(plaintext)& authenticator has two client options:
26100
26101 .option client_ignore_invalid_base64 plaintext boolean false
26102 If the client receives a server prompt that is not a valid base64 string,
26103 authentication is abandoned by default. However, if this option is set true,
26104 the error in the challenge is ignored and the client sends the response as
26105 usual.
26106
26107 .option client_send plaintext string&!! unset
26108 The string is a colon-separated list of authentication data strings. Each
26109 string is independently expanded before being sent to the server. The first
26110 string is sent with the AUTH command; any more strings are sent in response
26111 to prompts from the server. Before each string is expanded, the value of the
26112 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26113 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26114 way. Thus, the prompt that is received in response to sending the first string
26115 (with the AUTH command) can be used in the expansion of the second string, and
26116 so on. If an invalid base64 string is received when
26117 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26118 &$auth$&<&'n'&> variable.
26119
26120 &*Note*&: You cannot use expansion to create multiple strings, because
26121 splitting takes priority and happens first.
26122
26123 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26124 the data, further processing is applied to each string before it is sent. If
26125 there are any single circumflex characters in the string, they are converted to
26126 NULs. Should an actual circumflex be required as data, it must be doubled in
26127 the string.
26128
26129 This is an example of a client configuration that implements the PLAIN
26130 authentication mechanism with a fixed user name and password:
26131 .code
26132 fixed_plain:
26133   driver = plaintext
26134   public_name = PLAIN
26135   client_send = ^username^mysecret
26136 .endd
26137 The lack of colons means that the entire text is sent with the AUTH
26138 command, with the circumflex characters converted to NULs. A similar example
26139 that uses the LOGIN mechanism is:
26140 .code
26141 fixed_login:
26142   driver = plaintext
26143   public_name = LOGIN
26144   client_send = : username : mysecret
26145 .endd
26146 The initial colon means that the first string is empty, so no data is sent with
26147 the AUTH command itself. The remaining strings are sent in response to
26148 prompts.
26149 .ecindex IIDplaiauth1
26150 .ecindex IIDplaiauth2
26151
26152
26153
26154
26155 . ////////////////////////////////////////////////////////////////////////////
26156 . ////////////////////////////////////////////////////////////////////////////
26157
26158 .chapter "The cram_md5 authenticator" "CHID9"
26159 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26160 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26161 .cindex "CRAM-MD5 authentication mechanism"
26162 .cindex "authentication" "CRAM-MD5 mechanism"
26163 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26164 sends a challenge string to the client, and the response consists of a user
26165 name and the CRAM-MD5 digest of the challenge string combined with a secret
26166 string (password) which is known to both server and client. Thus, the secret
26167 is not sent over the network as plain text, which makes this authenticator more
26168 secure than &(plaintext)&. However, the downside is that the secret has to be
26169 available in plain text at either end.
26170
26171
26172 .section "Using cram_md5 as a server" "SECID176"
26173 .cindex "options" "&(cram_md5)& authenticator (server)"
26174 This authenticator has one server option, which must be set to configure the
26175 authenticator as a server:
26176
26177 .option server_secret cram_md5 string&!! unset
26178 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26179 When the server receives the client's response, the user name is placed in
26180 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26181 obtain the password for that user. The server then computes the CRAM-MD5 digest
26182 that the client should have sent, and checks that it received the correct
26183 string. If the expansion of &%server_secret%& is forced to fail, authentication
26184 fails. If the expansion fails for some other reason, a temporary error code is
26185 returned to the client.
26186
26187 For compatibility with previous releases of Exim, the user name is also placed
26188 in &$1$&. However, the use of this variables for this purpose is now
26189 deprecated, as it can lead to confusion in string expansions that also use
26190 numeric variables for other things.
26191
26192 For example, the following authenticator checks that the user name given by the
26193 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26194 user name, authentication fails.
26195 .code
26196 fixed_cram:
26197   driver = cram_md5
26198   public_name = CRAM-MD5
26199   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26200   server_set_id = $auth1
26201 .endd
26202 .vindex "&$authenticated_id$&"
26203 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26204 name in &$authenticated_id$&. A more typical configuration might look up the
26205 secret string in a file, using the user name as the key. For example:
26206 .code
26207 lookup_cram:
26208   driver = cram_md5
26209   public_name = CRAM-MD5
26210   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26211                   {$value}fail}
26212   server_set_id = $auth1
26213 .endd
26214 Note that this expansion explicitly forces failure if the lookup fails
26215 because &$auth1$& contains an unknown user name.
26216
26217 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26218 using the relevant libraries, you need to know the realm to specify in the
26219 lookup and then ask for the &"userPassword"& attribute for that user in that
26220 realm, with:
26221 .code
26222 cyrusless_crammd5:
26223   driver = cram_md5
26224   public_name = CRAM-MD5
26225   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26226                   dbmjz{/etc/sasldb2}{$value}fail}
26227   server_set_id = $auth1
26228 .endd
26229
26230 .section "Using cram_md5 as a client" "SECID177"
26231 .cindex "options" "&(cram_md5)& authenticator (client)"
26232 When used as a client, the &(cram_md5)& authenticator has two options:
26233
26234
26235
26236 .option client_name cram_md5 string&!! "the primary host name"
26237 This string is expanded, and the result used as the user name data when
26238 computing the response to the server's challenge.
26239
26240
26241 .option client_secret cram_md5 string&!! unset
26242 This option must be set for the authenticator to work as a client. Its value is
26243 expanded and the result used as the secret string when computing the response.
26244
26245
26246 .vindex "&$host$&"
26247 .vindex "&$host_address$&"
26248 Different user names and secrets can be used for different servers by referring
26249 to &$host$& or &$host_address$& in the options. Forced failure of either
26250 expansion string is treated as an indication that this authenticator is not
26251 prepared to handle this case. Exim moves on to the next configured client
26252 authenticator. Any other expansion failure causes Exim to give up trying to
26253 send the message to the current server.
26254
26255 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26256 strings, is:
26257 .code
26258 fixed_cram:
26259   driver = cram_md5
26260   public_name = CRAM-MD5
26261   client_name = ph10
26262   client_secret = secret
26263 .endd
26264 .ecindex IIDcramauth1
26265 .ecindex IIDcramauth2
26266
26267
26268
26269 . ////////////////////////////////////////////////////////////////////////////
26270 . ////////////////////////////////////////////////////////////////////////////
26271
26272 .chapter "The cyrus_sasl authenticator" "CHID10"
26273 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26274 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26275 .cindex "Cyrus" "SASL library"
26276 .cindex "Kerberos"
26277 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26278 Digital Ltd (&url(http://www.aldigital.co.uk)).
26279
26280 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26281 library implementation of the RFC 2222 (&"Simple Authentication and Security
26282 Layer"&). This library supports a number of authentication mechanisms,
26283 including PLAIN and LOGIN, but also several others that Exim does not support
26284 directly. In particular, there is support for Kerberos authentication.
26285
26286 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26287 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26288 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26289 name of the driver to determine which mechanism to support.
26290
26291 Where access to some kind of secret file is required, for example in GSSAPI
26292 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26293 user, and that the Cyrus SASL library has no way of escalating privileges
26294 by default. You may also find you need to set environment variables,
26295 depending on the driver you are using.
26296
26297 The application name provided by Exim is &"exim"&, so various SASL options may
26298 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26299 Kerberos, note that because of limitations in the GSSAPI interface,
26300 changing the server keytab might need to be communicated down to the Kerberos
26301 layer independently. The mechanism for doing so is dependent upon the Kerberos
26302 implementation.
26303
26304 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26305 may be set to point to an alternative keytab file. Exim will pass this
26306 variable through from its own inherited environment when started as root or the
26307 Exim user. The keytab file needs to be readable by the Exim user.
26308 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26309 environment variable.  In practice, for those releases, the Cyrus authenticator
26310 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26311 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26312
26313
26314 .section "Using cyrus_sasl as a server" "SECID178"
26315 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26316 (on a successful authentication) into &$auth1$&. For compatibility with
26317 previous releases of Exim, the username is also placed in &$1$&. However, the
26318 use of this variable for this purpose is now deprecated, as it can lead to
26319 confusion in string expansions that also use numeric variables for other
26320 things.
26321
26322
26323 .option server_hostname cyrus_sasl string&!! "see below"
26324 This option selects the hostname that is used when communicating with the
26325 library. The default value is &`$primary_hostname`&. It is up to the underlying
26326 SASL plug-in what it does with this data.
26327
26328
26329 .option server_mech cyrus_sasl string "see below"
26330 This option selects the authentication mechanism this driver should use. The
26331 default is the value of the generic &%public_name%& option. This option allows
26332 you to use a different underlying mechanism from the advertised name. For
26333 example:
26334 .code
26335 sasl:
26336   driver = cyrus_sasl
26337   public_name = X-ANYTHING
26338   server_mech = CRAM-MD5
26339   server_set_id = $auth1
26340 .endd
26341
26342 .option server_realm cyrus_sasl string&!! unset
26343 This specifies the SASL realm that the server claims to be in.
26344
26345
26346 .option server_service cyrus_sasl string &`smtp`&
26347 This is the SASL service that the server claims to implement.
26348
26349
26350 For straightforward cases, you do not need to set any of the authenticator's
26351 private options. All you need to do is to specify an appropriate mechanism as
26352 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26353 PLAIN, you could have two authenticators as follows:
26354 .code
26355 sasl_cram_md5:
26356   driver = cyrus_sasl
26357   public_name = CRAM-MD5
26358   server_set_id = $auth1
26359
26360 sasl_plain:
26361   driver = cyrus_sasl
26362   public_name = PLAIN
26363   server_set_id = $auth2
26364 .endd
26365 Cyrus SASL does implement the LOGIN authentication method, even though it is
26366 not a standard method. It is disabled by default in the source distribution,
26367 but it is present in many binary distributions.
26368 .ecindex IIDcyrauth1
26369 .ecindex IIDcyrauth2
26370
26371
26372
26373
26374 . ////////////////////////////////////////////////////////////////////////////
26375 . ////////////////////////////////////////////////////////////////////////////
26376 .chapter "The dovecot authenticator" "CHAPdovecot"
26377 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26378 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26379 This authenticator is an interface to the authentication facility of the
26380 Dovecot POP/IMAP server, which can support a number of authentication methods.
26381 Note that Dovecot must be configured to use auth-client not auth-userdb.
26382 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26383 to use the same mechanisms for SMTP authentication. This is a server
26384 authenticator only. There is only one option:
26385
26386 .option server_socket dovecot string unset
26387
26388 This option must specify the socket that is the interface to Dovecot
26389 authentication. The &%public_name%& option must specify an authentication
26390 mechanism that Dovecot is configured to support. You can have several
26391 authenticators for different mechanisms. For example:
26392 .code
26393 dovecot_plain:
26394   driver = dovecot
26395   public_name = PLAIN
26396   server_socket = /var/run/dovecot/auth-client
26397   server_set_id = $auth1
26398
26399 dovecot_ntlm:
26400   driver = dovecot
26401   public_name = NTLM
26402   server_socket = /var/run/dovecot/auth-client
26403   server_set_id = $auth1
26404 .endd
26405 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26406 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26407 option is passed in the Dovecot authentication command. If, for a TLS
26408 connection, a client certificate has been verified, the &"valid-client-cert"&
26409 option is passed. When authentication succeeds, the identity of the user
26410 who authenticated is placed in &$auth1$&.
26411 .ecindex IIDdcotauth1
26412 .ecindex IIDdcotauth2
26413
26414
26415 . ////////////////////////////////////////////////////////////////////////////
26416 . ////////////////////////////////////////////////////////////////////////////
26417 .chapter "The gsasl authenticator" "CHAPgsasl"
26418 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26419 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26420 .cindex "authentication" "GNU SASL"
26421 .cindex "authentication" "SASL"
26422 .cindex "authentication" "EXTERNAL"
26423 .cindex "authentication" "ANONYMOUS"
26424 .cindex "authentication" "PLAIN"
26425 .cindex "authentication" "LOGIN"
26426 .cindex "authentication" "DIGEST-MD5"
26427 .cindex "authentication" "CRAM-MD5"
26428 .cindex "authentication" "SCRAM-SHA-1"
26429 The &(gsasl)& authenticator provides server integration for the GNU SASL
26430 library and the mechanisms it provides.  This is new as of the 4.80 release
26431 and there are a few areas where the library does not let Exim smoothly
26432 scale to handle future authentication mechanisms, so no guarantee can be
26433 made that any particular new authentication mechanism will be supported
26434 without code changes in Exim.
26435
26436
26437 .option server_channelbinding gsasl boolean false
26438 Some authentication mechanisms are able to use external context at both ends
26439 of the session to bind the authentication to that context, and fail the
26440 authentication process if that context differs.  Specifically, some TLS
26441 ciphersuites can provide identifying information about the cryptographic
26442 context.
26443
26444 This means that certificate identity and verification becomes a non-issue,
26445 as a man-in-the-middle attack will cause the correct client and server to
26446 see different identifiers and authentication will fail.
26447
26448 This is currently only supported when using the GnuTLS library.  This is
26449 only usable by mechanisms which support "channel binding"; at time of
26450 writing, that's the SCRAM family.
26451
26452 This defaults off to ensure smooth upgrade across Exim releases, in case
26453 this option causes some clients to start failing.  Some future release
26454 of Exim may switch the default to be true.
26455
26456
26457 .option server_hostname gsasl string&!! "see below"
26458 This option selects the hostname that is used when communicating with the
26459 library. The default value is &`$primary_hostname`&.
26460 Some mechanisms will use this data.
26461
26462
26463 .option server_mech gsasl string "see below"
26464 This option selects the authentication mechanism this driver should use. The
26465 default is the value of the generic &%public_name%& option. This option allows
26466 you to use a different underlying mechanism from the advertised name. For
26467 example:
26468 .code
26469 sasl:
26470   driver = gsasl
26471   public_name = X-ANYTHING
26472   server_mech = CRAM-MD5
26473   server_set_id = $auth1
26474 .endd
26475
26476
26477 .option server_password gsasl string&!! unset
26478 Various mechanisms need access to the cleartext password on the server, so
26479 that proof-of-possession can be demonstrated on the wire, without sending
26480 the password itself.
26481
26482 The data available for lookup varies per mechanism.
26483 In all cases, &$auth1$& is set to the &'authentication id'&.
26484 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26485 if available, else the empty string.
26486 The &$auth3$& variable will always be the &'realm'& if available,
26487 else the empty string.
26488
26489 A forced failure will cause authentication to defer.
26490
26491 If using this option, it may make sense to set the &%server_condition%&
26492 option to be simply "true".
26493
26494
26495 .option server_realm gsasl string&!! unset
26496 This specifies the SASL realm that the server claims to be in.
26497 Some mechanisms will use this data.
26498
26499
26500 .option server_scram_iter gsasl string&!! unset
26501 This option provides data for the SCRAM family of mechanisms.
26502 &$auth1$& is not available at evaluation time.
26503 (This may change, as we receive feedback on use)
26504
26505
26506 .option server_scram_salt gsasl string&!! unset
26507 This option provides data for the SCRAM family of mechanisms.
26508 &$auth1$& is not available at evaluation time.
26509 (This may change, as we receive feedback on use)
26510
26511
26512 .option server_service gsasl string &`smtp`&
26513 This is the SASL service that the server claims to implement.
26514 Some mechanisms will use this data.
26515
26516
26517 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26518 .vindex "&$auth1$&, &$auth2$&, etc"
26519 These may be set when evaluating specific options, as detailed above.
26520 They will also be set when evaluating &%server_condition%&.
26521
26522 Unless otherwise stated below, the &(gsasl)& integration will use the following
26523 meanings for these variables:
26524
26525 .ilist
26526 .vindex "&$auth1$&"
26527 &$auth1$&: the &'authentication id'&
26528 .next
26529 .vindex "&$auth2$&"
26530 &$auth2$&: the &'authorization id'&
26531 .next
26532 .vindex "&$auth3$&"
26533 &$auth3$&: the &'realm'&
26534 .endlist
26535
26536 On a per-mechanism basis:
26537
26538 .ilist
26539 .cindex "authentication" "EXTERNAL"
26540 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26541 the &%server_condition%& option must be present.
26542 .next
26543 .cindex "authentication" "ANONYMOUS"
26544 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26545 the &%server_condition%& option must be present.
26546 .next
26547 .cindex "authentication" "GSSAPI"
26548 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26549 &$auth2$& will be set to the &'authorization id'&,
26550 the &%server_condition%& option must be present.
26551 .endlist
26552
26553 An &'anonymous token'& is something passed along as an unauthenticated
26554 identifier; this is analogous to FTP anonymous authentication passing an
26555 email address, or software-identifier@, as the "password".
26556
26557
26558 An example showing the password having the realm specified in the callback
26559 and demonstrating a Cyrus SASL to GSASL migration approach is:
26560 .code
26561 gsasl_cyrusless_crammd5:
26562   driver = gsasl
26563   public_name = CRAM-MD5
26564   server_realm = imap.example.org
26565   server_password = ${lookup{$auth1:$auth3:userPassword}\
26566                     dbmjz{/etc/sasldb2}{$value}fail}
26567   server_set_id = ${quote:$auth1}
26568   server_condition = yes
26569 .endd
26570
26571
26572 . ////////////////////////////////////////////////////////////////////////////
26573 . ////////////////////////////////////////////////////////////////////////////
26574
26575 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26576 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26577 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26578 .cindex "authentication" "GSSAPI"
26579 .cindex "authentication" "Kerberos"
26580 The &(heimdal_gssapi)& authenticator provides server integration for the
26581 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26582 reliably.
26583
26584 .option server_hostname heimdal_gssapi string&!! "see below"
26585 This option selects the hostname that is used, with &%server_service%&,
26586 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26587 identifier.  The default value is &`$primary_hostname`&.
26588
26589 .option server_keytab heimdal_gssapi string&!! unset
26590 If set, then Heimdal will not use the system default keytab (typically
26591 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26592 The value should be a pathname, with no &"file:"& prefix.
26593
26594 .option server_service heimdal_gssapi string&!! "smtp"
26595 This option specifies the service identifier used, in conjunction with
26596 &%server_hostname%&, for building the identifier for finding credentials
26597 from the keytab.
26598
26599
26600 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26601 Beware that these variables will typically include a realm, thus will appear
26602 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26603 not verified, so a malicious client can set it to anything.
26604
26605 The &$auth1$& field should be safely trustable as a value from the Key
26606 Distribution Center.  Note that these are not quite email addresses.
26607 Each identifier is for a role, and so the left-hand-side may include a
26608 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26609
26610 .vindex "&$auth1$&, &$auth2$&, etc"
26611 .ilist
26612 .vindex "&$auth1$&"
26613 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26614 .next
26615 .vindex "&$auth2$&"
26616 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26617 authentication.  If that was empty, this will also be set to the
26618 GSS Display Name.
26619 .endlist
26620
26621
26622 . ////////////////////////////////////////////////////////////////////////////
26623 . ////////////////////////////////////////////////////////////////////////////
26624
26625 .chapter "The spa authenticator" "CHAPspa"
26626 .scindex IIDspaauth1 "&(spa)& authenticator"
26627 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26628 .cindex "authentication" "Microsoft Secure Password"
26629 .cindex "authentication" "NTLM"
26630 .cindex "Microsoft Secure Password Authentication"
26631 .cindex "NTLM authentication"
26632 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26633 Password Authentication'& mechanism,
26634 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26635 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26636 taken from the Samba project (&url(http://www.samba.org)). The code for the
26637 server side was subsequently contributed by Tom Kistner. The mechanism works as
26638 follows:
26639
26640 .ilist
26641 After the AUTH command has been accepted, the client sends an SPA
26642 authentication request based on the user name and optional domain.
26643 .next
26644 The server sends back a challenge.
26645 .next
26646 The client builds a challenge response which makes use of the user's password
26647 and sends it to the server, which then accepts or rejects it.
26648 .endlist
26649
26650 Encryption is used to protect the password in transit.
26651
26652
26653
26654 .section "Using spa as a server" "SECID179"
26655 .cindex "options" "&(spa)& authenticator (server)"
26656 The &(spa)& authenticator has just one server option:
26657
26658 .option server_password spa string&!! unset
26659 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26660 This option is expanded, and the result must be the cleartext password for the
26661 authenticating user, whose name is at this point in &$auth1$&. For
26662 compatibility with previous releases of Exim, the user name is also placed in
26663 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26664 it can lead to confusion in string expansions that also use numeric variables
26665 for other things. For example:
26666 .code
26667 spa:
26668   driver = spa
26669   public_name = NTLM
26670   server_password = \
26671     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26672 .endd
26673 If the expansion is forced to fail, authentication fails. Any other expansion
26674 failure causes a temporary error code to be returned.
26675
26676
26677
26678
26679
26680 .section "Using spa as a client" "SECID180"
26681 .cindex "options" "&(spa)& authenticator (client)"
26682 The &(spa)& authenticator has the following client options:
26683
26684
26685
26686 .option client_domain spa string&!! unset
26687 This option specifies an optional domain for the authentication.
26688
26689
26690 .option client_password spa string&!! unset
26691 This option specifies the user's password, and must be set.
26692
26693
26694 .option client_username spa string&!! unset
26695 This option specifies the user name, and must be set. Here is an example of a
26696 configuration of this authenticator for use with the mail servers at
26697 &'msn.com'&:
26698 .code
26699 msn:
26700   driver = spa
26701   public_name = MSN
26702   client_username = msn/msn_username
26703   client_password = msn_plaintext_password
26704   client_domain = DOMAIN_OR_UNSET
26705 .endd
26706 .ecindex IIDspaauth1
26707 .ecindex IIDspaauth2
26708
26709
26710
26711
26712
26713 . ////////////////////////////////////////////////////////////////////////////
26714 . ////////////////////////////////////////////////////////////////////////////
26715
26716 .chapter "The tls authenticator" "CHAPtlsauth"
26717 .scindex IIDtlsauth1 "&(tls)& authenticator"
26718 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26719 .cindex "authentication" "Client Certificate"
26720 .cindex "authentication" "X509"
26721 .cindex "Certificate-based authentication"
26722 The &(tls)& authenticator provides server support for
26723 authentication based on client certificates.
26724
26725 It is not an SMTP authentication mechanism and is not
26726 advertised by the server as part of the SMTP EHLO response.
26727 It is an Exim authenticator in the sense that it affects
26728 the protocol element of the log line, can be tested for
26729 by the &%authenticated%& ACL condition, and can set
26730 the &$authenticated_id$& variable.
26731
26732 The client must present a verifiable certificate,
26733 for which it must have been requested via the
26734 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26735 (see &<<CHAPTLS>>&).
26736
26737 If an authenticator of this type is configured it is
26738 run before any SMTP-level communication is done,
26739 and can authenticate the connection.
26740 If it does, SMTP authentication is not offered.
26741
26742 A maximum of one authenticator of this type may be present.
26743
26744
26745 .cindex "options" "&(tls)& authenticator (server)"
26746 The &(tls)& authenticator has three server options:
26747
26748 .option server_param1 tls string&!! unset
26749 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26750 This option is expanded after the TLS negotiation and
26751 the result is placed in &$auth1$&.
26752 If the expansion is forced to fail, authentication fails. Any other expansion
26753 failure causes a temporary error code to be returned.
26754
26755 .option server_param2 tls string&!! unset
26756 .option server_param3 tls string&!! unset
26757 As above, for &$auth2$& and &$auth3$&.
26758
26759 &%server_param1%& may also be spelled &%server_param%&.
26760
26761
26762 Example:
26763 .code
26764 tls:
26765   driver = tls
26766   server_param1 =     ${certextract {subj_altname,mail,>:} \
26767                                     {$tls_in_peercert}}
26768   server_condition =  ${if forany {$auth1} \
26769                             {!= {0} \
26770                                 {${lookup ldap{ldap:///\
26771                          mailname=${quote_ldap_dn:${lc:$item}},\
26772                          ou=users,LDAP_DC?mailid} {$value}{0} \
26773                        }    }   } }
26774   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26775 .endd
26776 This accepts a client certificate that is verifiable against any
26777 of your configured trust-anchors
26778 which usually means the full set of public CAs)
26779 and which has a SAN with a good account name.
26780 Note that the client cert is on the wire in-clear, including the SAN,
26781 whereas a plaintext SMTP AUTH done inside TLS is not.
26782
26783 . An alternative might use
26784 . .code
26785 .   server_param1 = ${sha256:$tls_in_peercert}
26786 . .endd
26787 . to require one of a set of specific certs that define a given account
26788 . (the verification is still required, but mostly irrelevant).
26789 . This would help for per-device use.
26790 .
26791 . However, for the future we really need support for checking a
26792 . user cert in LDAP - which probably wants a base-64 DER.
26793
26794 .ecindex IIDtlsauth1
26795 .ecindex IIDtlsauth2
26796
26797
26798 Note that because authentication is traditionally an SMTP operation,
26799 the &%authenticated%& ACL condition cannot be used in
26800 a connect- or helo-ACL.
26801
26802
26803
26804 . ////////////////////////////////////////////////////////////////////////////
26805 . ////////////////////////////////////////////////////////////////////////////
26806
26807 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26808          "Encrypted SMTP connections"
26809 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26810 .scindex IIDencsmtp2 "SMTP" "encryption"
26811 .cindex "TLS" "on SMTP connection"
26812 .cindex "OpenSSL"
26813 .cindex "GnuTLS"
26814 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26815 Sockets Layer), is implemented by making use of the OpenSSL library or the
26816 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26817 cryptographic code in the Exim distribution itself for implementing TLS. In
26818 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26819 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26820 You also need to understand the basic concepts of encryption at a managerial
26821 level, and in particular, the way that public keys, private keys, and
26822 certificates are used.
26823
26824 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26825 connection is established, the client issues a STARTTLS command. If the
26826 server accepts this, the client and the server negotiate an encryption
26827 mechanism. If the negotiation succeeds, the data that subsequently passes
26828 between them is encrypted.
26829
26830 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26831 and if so, what cipher suite is in use, whether the client supplied a
26832 certificate, and whether or not that certificate was verified. This makes it
26833 possible for an Exim server to deny or accept certain commands based on the
26834 encryption state.
26835
26836 &*Warning*&: Certain types of firewall and certain anti-virus products can
26837 disrupt TLS connections. You need to turn off SMTP scanning for these products
26838 in order to get TLS to work.
26839
26840
26841
26842 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26843          "SECID284"
26844 .cindex "ssmtp protocol"
26845 .cindex "smtps protocol"
26846 .cindex "SMTP" "ssmtp protocol"
26847 .cindex "SMTP" "smtps protocol"
26848 Early implementations of encrypted SMTP used a different TCP port from normal
26849 SMTP, and expected an encryption negotiation to start immediately, instead of
26850 waiting for a STARTTLS command from the client using the standard SMTP
26851 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26852 allocated for this purpose.
26853
26854 This approach was abandoned when encrypted SMTP was standardized, but there are
26855 still some legacy clients that use it. Exim supports these clients by means of
26856 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26857 numbers; the most common use is expected to be:
26858 .code
26859 tls_on_connect_ports = 465
26860 .endd
26861 The port numbers specified by this option apply to all SMTP connections, both
26862 via the daemon and via &'inetd'&. You still need to specify all the ports that
26863 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26864 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26865 an extra port &-- rather, it specifies different behaviour on a port that is
26866 defined elsewhere.
26867
26868 There is also a &%-tls-on-connect%& command line option. This overrides
26869 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26870
26871
26872
26873
26874
26875
26876 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26877 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26878 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26879 followed later, when the first versions of GnuTLS were released. To build Exim
26880 to use GnuTLS, you need to set
26881 .code
26882 USE_GNUTLS=yes
26883 .endd
26884 in Local/Makefile, in addition to
26885 .code
26886 SUPPORT_TLS=yes
26887 .endd
26888 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26889 include files and libraries for GnuTLS can be found.
26890
26891 There are some differences in usage when using GnuTLS instead of OpenSSL:
26892
26893 .ilist
26894 The &%tls_verify_certificates%& option
26895 cannot be the path of a directory
26896 for GnuTLS versions before 3.3.6
26897 (for later versions, or OpenSSL, it can be either).
26898 .next
26899 The default value for &%tls_dhparam%& differs for historical reasons.
26900 .next
26901 .vindex "&$tls_in_peerdn$&"
26902 .vindex "&$tls_out_peerdn$&"
26903 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26904 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26905 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26906 .next
26907 OpenSSL identifies cipher suites using hyphens as separators, for example:
26908 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26909 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26910 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26911 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26912 to handle its own older variants) when processing lists of cipher suites in the
26913 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26914 option).
26915 .next
26916 The &%tls_require_ciphers%& options operate differently, as described in the
26917 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26918 .next
26919 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26920 When using OpenSSL, this option is ignored.
26921 (If an API is found to let OpenSSL be configured in this way,
26922 let the Exim Maintainers know and we'll likely use it).
26923 .next
26924 Some other recently added features may only be available in one or the other.
26925 This should be documented with the feature.  If the documentation does not
26926 explicitly state that the feature is infeasible in the other TLS
26927 implementation, then patches are welcome.
26928 .endlist
26929
26930
26931 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26932 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26933 an explicit path; if the latter, then the text about generation still applies,
26934 but not the chosen filename.
26935 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26936 See the documentation of &%tls_dhparam%& for more information.
26937
26938 GnuTLS uses D-H parameters that may take a substantial amount of time
26939 to compute. It is unreasonable to re-compute them for every TLS session.
26940 Therefore, Exim keeps this data in a file in its spool directory, called
26941 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26942 of bits requested.
26943 The file is owned by the Exim user and is readable only by
26944 its owner. Every Exim process that start up GnuTLS reads the D-H
26945 parameters from this file. If the file does not exist, the first Exim process
26946 that needs it computes the data and writes it to a temporary file which is
26947 renamed once it is complete. It does not matter if several Exim processes do
26948 this simultaneously (apart from wasting a few resources). Once a file is in
26949 place, new Exim processes immediately start using it.
26950
26951 For maximum security, the parameters that are stored in this file should be
26952 recalculated periodically, the frequency depending on your paranoia level.
26953 If you are avoiding using the fixed D-H primes published in RFCs, then you
26954 are concerned about some advanced attacks and will wish to do this; if you do
26955 not regenerate then you might as well stick to the standard primes.
26956
26957 Arranging this is easy in principle; just delete the file when you want new
26958 values to be computed. However, there may be a problem. The calculation of new
26959 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26960 If the system is not very active, &_/dev/random_& may delay returning data
26961 until enough randomness (entropy) is available. This may cause Exim to hang for
26962 a substantial amount of time, causing timeouts on incoming connections.
26963
26964 The solution is to generate the parameters externally to Exim. They are stored
26965 in &_gnutls-params-N_& in PEM format, which means that they can be
26966 generated externally using the &(certtool)& command that is part of GnuTLS.
26967
26968 To replace the parameters with new ones, instead of deleting the file
26969 and letting Exim re-create it, you can generate new parameters using
26970 &(certtool)& and, when this has been done, replace Exim's cache file by
26971 renaming. The relevant commands are something like this:
26972 .code
26973 # ls
26974 [ look for file; assume gnutls-params-2236 is the most recent ]
26975 # rm -f new-params
26976 # touch new-params
26977 # chown exim:exim new-params
26978 # chmod 0600 new-params
26979 # certtool --generate-dh-params --bits 2236 >>new-params
26980 # openssl dhparam -noout -text -in new-params | head
26981 [ check the first line, make sure it's not more than 2236;
26982   if it is, then go back to the start ("rm") and repeat
26983   until the size generated is at most the size requested ]
26984 # chmod 0400 new-params
26985 # mv new-params gnutls-params-2236
26986 .endd
26987 If Exim never has to generate the parameters itself, the possibility of
26988 stalling is removed.
26989
26990 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26991 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26992 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26993 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26994 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26995 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26996 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26997 which applies to all D-H usage, client or server.  If the value returned by
26998 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26999 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27000 limit, which is still much higher than Exim historically used.
27001
27002 The filename and bits used will change as the GnuTLS maintainers change the
27003 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27004 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27005 2432 bits, while NSS is limited to 2236 bits.
27006
27007 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27008 increase the chance of the generated prime actually being within acceptable
27009 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27010 procedure above.  There is no sane procedure available to Exim to double-check
27011 the size of the generated prime, so it might still be too large.
27012
27013
27014 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27015 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27016 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27017 There is a function in the OpenSSL library that can be passed a list of cipher
27018 suites before the cipher negotiation takes place. This specifies which ciphers
27019 are acceptable. The list is colon separated and may contain names like
27020 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27021 directly to this function call.
27022 Many systems will install the OpenSSL manual-pages, so you may have
27023 &'ciphers(1)'& available to you.
27024 The following quotation from the OpenSSL
27025 documentation specifies what forms of item are allowed in the cipher string:
27026
27027 .ilist
27028 It can consist of a single cipher suite such as RC4-SHA.
27029 .next
27030 It can represent a list of cipher suites containing a certain algorithm,
27031 or cipher suites of a certain type. For example SHA1 represents all
27032 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27033 SSL v3 algorithms.
27034 .next
27035 Lists of cipher suites can be combined in a single cipher string using
27036 the + character. This is used as a logical and operation. For example
27037 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27038 algorithms.
27039 .endlist
27040
27041 Each cipher string can be optionally preceded by one of the characters &`!`&,
27042 &`-`& or &`+`&.
27043 .ilist
27044 If &`!`& is used, the ciphers are permanently deleted from the list. The
27045 ciphers deleted can never reappear in the list even if they are explicitly
27046 stated.
27047 .next
27048 If &`-`& is used, the ciphers are deleted from the list, but some or all
27049 of the ciphers can be added again by later options.
27050 .next
27051 If &`+`& is used, the ciphers are moved to the end of the list. This
27052 option does not add any new ciphers; it just moves matching existing ones.
27053 .endlist
27054
27055 If none of these characters is present, the string is interpreted as
27056 a list of ciphers to be appended to the current preference list. If the list
27057 includes any ciphers already present they will be ignored: that is, they will
27058 not be moved to the end of the list.
27059 .endlist
27060
27061 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27062 string:
27063 .code
27064 # note single-quotes to get ! past any shell history expansion
27065 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27066 .endd
27067
27068 This example will let the library defaults be permitted on the MX port, where
27069 there's probably no identity verification anyway, but ups the ante on the
27070 submission ports where the administrator might have some influence on the
27071 choice of clients used:
27072 .code
27073 # OpenSSL variant; see man ciphers(1)
27074 tls_require_ciphers = ${if =={$received_port}{25}\
27075                            {DEFAULT}\
27076                            {HIGH:!MD5:!SHA1}}
27077 .endd
27078
27079
27080
27081 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27082          "SECTreqciphgnu"
27083 .cindex "GnuTLS" "specifying parameters for"
27084 .cindex "TLS" "specifying ciphers (GnuTLS)"
27085 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27086 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27087 .cindex "TLS" "specifying protocols (GnuTLS)"
27088 .cindex "TLS" "specifying priority string (GnuTLS)"
27089 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27090 The GnuTLS library allows the caller to provide a "priority string", documented
27091 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27092 ciphersuite specification in OpenSSL.
27093
27094 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27095 and controls both protocols and ciphers.
27096
27097 The &%tls_require_ciphers%& option is available both as an global option,
27098 controlling how Exim behaves as a server, and also as an option of the
27099 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27100 the value is string expanded.  The resulting string is not an Exim list and
27101 the string is given to the GnuTLS library, so that Exim does not need to be
27102 aware of future feature enhancements of GnuTLS.
27103
27104 Documentation of the strings accepted may be found in the GnuTLS manual, under
27105 "Priority strings".  This is online as
27106 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27107 but beware that this relates to GnuTLS 3, which may be newer than the version
27108 installed on your system.  If you are using GnuTLS 3,
27109 then the example code
27110 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27111 on that site can be used to test a given string.
27112
27113 For example:
27114 .code
27115 # Disable older versions of protocols
27116 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27117 .endd
27118
27119 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27120 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27121 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27122
27123 This example will let the library defaults be permitted on the MX port, where
27124 there's probably no identity verification anyway, and lowers security further
27125 by increasing compatibility; but this ups the ante on the submission ports
27126 where the administrator might have some influence on the choice of clients
27127 used:
27128 .code
27129 # GnuTLS variant
27130 tls_require_ciphers = ${if =={$received_port}{25}\
27131                            {NORMAL:%COMPAT}\
27132                            {SECURE128}}
27133 .endd
27134
27135
27136 .section "Configuring an Exim server to use TLS" "SECID182"
27137 .cindex "TLS" "configuring an Exim server"
27138 When Exim has been built with TLS support, it advertises the availability of
27139 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27140 but not to any others. The default value of this option is unset, which means
27141 that STARTTLS is not advertised at all. This default is chosen because you
27142 need to set some other options in order to make TLS available, and also it is
27143 sensible for systems that want to use TLS only as a client.
27144
27145 If a client issues a STARTTLS command and there is some configuration
27146 problem in the server, the command is rejected with a 454 error. If the client
27147 persists in trying to issue SMTP commands, all except QUIT are rejected
27148 with the error
27149 .code
27150 554 Security failure
27151 .endd
27152 If a STARTTLS command is issued within an existing TLS session, it is
27153 rejected with a 554 error code.
27154
27155 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27156 must be set to match some hosts. The default is * which matches all hosts.
27157
27158 .new
27159 If this is all you do, TLS encryption will be enabled but not authentication -
27160 meaning that the peer has no assurance it is actually you he is talking to.
27161 You gain protection from a passive sniffer listening on the wire but not
27162 from someone able to intercept the communication.
27163 .wen
27164
27165 Further protection requires some further configuration at the server end.
27166
27167 It is rumoured that all existing clients that support TLS/SSL use RSA
27168 encryption. To make this work you need to set, in the server,
27169 .code
27170 tls_certificate = /some/file/name
27171 tls_privatekey = /some/file/name
27172 .endd
27173 These options are, in fact, expanded strings, so you can make them depend on
27174 the identity of the client that is connected if you wish. The first file
27175 contains the server's X509 certificate, and the second contains the private key
27176 that goes with it. These files need to be
27177 PEM format and readable by the Exim user, and must
27178 always be given as full path names.
27179 The key must not be password-protected.
27180 They can be the same file if both the
27181 certificate and the key are contained within it. If &%tls_privatekey%& is not
27182 set, or if its expansion is forced to fail or results in an empty string, this
27183 is assumed to be the case. The certificate file may also contain intermediate
27184 certificates that need to be sent to the client to enable it to authenticate
27185 the server's certificate.
27186
27187 If you do not understand about certificates and keys, please try to find a
27188 source of this background information, which is not Exim-specific. (There are a
27189 few comments below in section &<<SECTcerandall>>&.)
27190
27191 &*Note*&: These options do not apply when Exim is operating as a client &--
27192 they apply only in the case of a server. If you need to use a certificate in an
27193 Exim client, you must set the options of the same names in an &(smtp)&
27194 transport.
27195
27196 With just these options, an Exim server will be able to use TLS. It does not
27197 require the client to have a certificate (but see below for how to insist on
27198 this). There is one other option that may be needed in other situations. If
27199 .code
27200 tls_dhparam = /some/file/name
27201 .endd
27202 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27203 with the parameters contained in the file.
27204 Set this to &`none`& to disable use of DH entirely, by making no prime
27205 available:
27206 .code
27207 tls_dhparam = none
27208 .endd
27209 This may also be set to a string identifying a standard prime to be used for
27210 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27211 used is &`ike23`&.  There are a few standard primes available, see the
27212 documentation for &%tls_dhparam%& for the complete list.
27213
27214 See the command
27215 .code
27216 openssl dhparam
27217 .endd
27218 for a way of generating file data.
27219
27220 The strings supplied for these three options are expanded every time a client
27221 host connects. It is therefore possible to use different certificates and keys
27222 for different hosts, if you so wish, by making use of the client's IP address
27223 in &$sender_host_address$& to control the expansion. If a string expansion is
27224 forced to fail, Exim behaves as if the option is not set.
27225
27226 .cindex "cipher" "logging"
27227 .cindex "log" "TLS cipher"
27228 .vindex "&$tls_in_cipher$&"
27229 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27230 an incoming TLS connection. It is included in the &'Received:'& header of an
27231 incoming message (by default &-- you can, of course, change this), and it is
27232 also included in the log line that records a message's arrival, keyed by
27233 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27234 condition can be used to test for specific cipher suites in ACLs.
27235
27236 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27237 can check the name of the cipher suite and vary their actions accordingly. The
27238 cipher suite names vary, depending on which TLS library is being used. For
27239 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27240 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27241 documentation for more details.
27242
27243 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27244 (again depending on the &%tls_cipher%& log selector).
27245
27246
27247 .section "Requesting and verifying client certificates" "SECID183"
27248 .cindex "certificate" "verification of client"
27249 .cindex "TLS" "client certificate verification"
27250 If you want an Exim server to request a certificate when negotiating a TLS
27251 session with a client, you must set either &%tls_verify_hosts%& or
27252 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27253 apply to all TLS connections. For any host that matches one of these options,
27254 Exim requests a certificate as part of the setup of the TLS session. The
27255 contents of the certificate are verified by comparing it with a list of
27256 expected certificates.
27257 These may be the system default set (depending on library version),
27258 an explicit file or,
27259 depending on library version, a directory, identified by
27260 &%tls_verify_certificates%&.
27261
27262 A file can contain multiple certificates, concatenated end to end. If a
27263 directory is used
27264 (OpenSSL only),
27265 each certificate must be in a separate file, with a name (or a symbolic link)
27266 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27267 certificate. You can compute the relevant hash by running the command
27268 .code
27269 openssl x509 -hash -noout -in /cert/file
27270 .endd
27271 where &_/cert/file_& contains a single certificate.
27272
27273 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27274 what happens if the client does not supply a certificate, or if the certificate
27275 does not match any of the certificates in the collection named by
27276 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27277 attempt to set up a TLS session is aborted, and the incoming connection is
27278 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27279 session continues. ACLs that run for subsequent SMTP commands can detect the
27280 fact that no certificate was verified, and vary their actions accordingly. For
27281 example, you can insist on a certificate before accepting a message for
27282 relaying, but not when the message is destined for local delivery.
27283
27284 .vindex "&$tls_in_peerdn$&"
27285 When a client supplies a certificate (whether it verifies or not), the value of
27286 the Distinguished Name of the certificate is made available in the variable
27287 &$tls_in_peerdn$& during subsequent processing of the message.
27288
27289 .cindex "log" "distinguished name"
27290 Because it is often a long text string, it is not included in the log line or
27291 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27292 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27293 &%received_header_text%& to change the &'Received:'& header. When no
27294 certificate is supplied, &$tls_in_peerdn$& is empty.
27295
27296
27297 .section "Revoked certificates" "SECID184"
27298 .cindex "TLS" "revoked certificates"
27299 .cindex "revocation list"
27300 .cindex "certificate" "revocation list"
27301 .cindex "OCSP" "stapling"
27302 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27303 certificates are revoked. If you have such a list, you can pass it to an Exim
27304 server using the global option called &%tls_crl%& and to an Exim client using
27305 an identically named option for the &(smtp)& transport. In each case, the value
27306 of the option is expanded and must then be the name of a file that contains a
27307 CRL in PEM format.
27308 The downside is that clients have to periodically re-download a potentially huge
27309 file from every certificate authority they know of.
27310
27311 The way with most moving parts at query time is Online Certificate
27312 Status Protocol (OCSP), where the client verifies the certificate
27313 against an OCSP server run by the CA.  This lets the CA track all
27314 usage of the certs.  It requires running software with access to the
27315 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27316 is based on HTTP and can be proxied accordingly.
27317
27318 The only widespread OCSP server implementation (known to this writer)
27319 comes as part of OpenSSL and aborts on an invalid request, such as
27320 connecting to the port and then disconnecting.  This requires
27321 re-entering the passphrase each time some random client does this.
27322
27323 The third way is OCSP Stapling; in this, the server using a certificate
27324 issued by the CA periodically requests an OCSP proof of validity from
27325 the OCSP server, then serves it up inline as part of the TLS
27326 negotiation.   This approach adds no extra round trips, does not let the
27327 CA track users, scales well with number of certs issued by the CA and is
27328 resilient to temporary OCSP server failures, as long as the server
27329 starts retrying to fetch an OCSP proof some time before its current
27330 proof expires.  The downside is that it requires server support.
27331
27332 Unless Exim is built with the support disabled,
27333 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27334 support for OCSP stapling is included.
27335
27336 There is a global option called &%tls_ocsp_file%&.
27337 The file specified therein is expected to be in DER format, and contain
27338 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27339 option will be re-expanded for SNI, if the &%tls_certificate%& option
27340 contains &`tls_in_sni`&, as per other TLS options.
27341
27342 Exim does not at this time implement any support for fetching a new OCSP
27343 proof.  The burden is on the administrator to handle this, outside of
27344 Exim.  The file specified should be replaced atomically, so that the
27345 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27346 on each connection, so a new file will be handled transparently on the
27347 next connection.
27348
27349 When built with OpenSSL Exim will check for a valid next update timestamp
27350 in the OCSP proof; if not present, or if the proof has expired, it will be
27351 ignored.
27352
27353 For the client to be able to verify the stapled OCSP the server must
27354 also supply, in its stapled information, any intermediate
27355 certificates for the chain leading to the OCSP proof from the signer
27356 of the server certificate.  There may be zero or one such. These
27357 intermediate certificates should be added to the server OCSP stapling
27358 file named by &%tls_ocsp_file%&.
27359
27360 Note that the proof only covers the terminal server certificate,
27361 not any of the chain from CA to it.
27362
27363 There is no current way to staple a proof for a client certificate.
27364
27365 .code
27366   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27367   OCSP server is supplied.  The server URL may be included in the
27368   server certificate, if the CA is helpful.
27369
27370   One failure mode seen was the OCSP Signer cert expiring before the end
27371   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27372   noted this as invalid overall, but the re-fetch script did not.
27373 .endd
27374
27375
27376
27377
27378 .section "Configuring an Exim client to use TLS" "SECID185"
27379 .cindex "cipher" "logging"
27380 .cindex "log" "TLS cipher"
27381 .cindex "log" "distinguished name"
27382 .cindex "TLS" "configuring an Exim client"
27383 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27384 deliveries as well as to incoming, the latter one causing logging of the
27385 server certificate's DN. The remaining client configuration for TLS is all
27386 within the &(smtp)& transport.
27387
27388 It is not necessary to set any options to have TLS work in the &(smtp)&
27389 transport. If Exim is built with TLS support, and TLS is advertised by a
27390 server, the &(smtp)& transport always tries to start a TLS session. However,
27391 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27392 transport) to a list of server hosts for which TLS should not be used.
27393
27394 If you do not want Exim to attempt to send messages unencrypted when an attempt
27395 to set up an encrypted connection fails in any way, you can set
27396 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27397 those hosts, delivery is always deferred if an encrypted connection cannot be
27398 set up. If there are any other hosts for the address, they are tried in the
27399 usual way.
27400
27401 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27402 the message unencrypted. It always does this if the response to STARTTLS is
27403 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27404 session after a success response code, what happens is controlled by the
27405 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27406 delivery to this host is deferred, and other hosts (if available) are tried. If
27407 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27408 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27409 negotiation fails, Exim closes the current connection (because it is in an
27410 unknown state), opens a new one to the same host, and then tries the delivery
27411 unencrypted.
27412
27413 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27414 transport provide the client with a certificate, which is passed to the server
27415 if it requests it. If the server is Exim, it will request a certificate only if
27416 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27417
27418 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27419 specifies a collection of expected server certificates.
27420 These may be the system default set (depending on library version),
27421 a file or,
27422 depending on library version, a directory,
27423 must name a file or,
27424 for OpenSSL only (not GnuTLS), a directory.
27425 The client verifies the server's certificate
27426 against this collection, taking into account any revoked certificates that are
27427 in the list defined by &%tls_crl%&.
27428 Failure to verify fails the TLS connection unless either of the
27429 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27430
27431 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27432 certificate verification to the listed servers.  Verification either must
27433 or need not succeed respectively.
27434
27435 The &(smtp)& transport has two OCSP-related options:
27436 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27437 is requested and required for the connection to proceed.  The default
27438 value is empty.
27439 &%hosts_request_ocsp%&; a host-list for which (additionally)
27440 a Certificate Status is requested (but not necessarily verified).  The default
27441 value is "*" meaning that requests are made unless configured
27442 otherwise.
27443
27444 The host(s) should also be in &%hosts_require_tls%&, and
27445 &%tls_verify_certificates%& configured for the transport,
27446 for OCSP to be relevant.
27447
27448 If
27449 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27450 list of permitted cipher suites. If either of these checks fails, delivery to
27451 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27452 alternative hosts, if any.
27453
27454  &*Note*&:
27455 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27456 is operating as a client. Exim does not assume that a server certificate (set
27457 by the global options of the same name) should also be used when operating as a
27458 client.
27459
27460 .vindex "&$host$&"
27461 .vindex "&$host_address$&"
27462 All the TLS options in the &(smtp)& transport are expanded before use, with
27463 &$host$& and &$host_address$& containing the name and address of the server to
27464 which the client is connected. Forced failure of an expansion causes Exim to
27465 behave as if the relevant option were unset.
27466
27467 .vindex &$tls_out_bits$&
27468 .vindex &$tls_out_cipher$&
27469 .vindex &$tls_out_peerdn$&
27470 .vindex &$tls_out_sni$&
27471 Before an SMTP connection is established, the
27472 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27473 variables are emptied. (Until the first connection, they contain the values
27474 that were set when the message was received.) If STARTTLS is subsequently
27475 successfully obeyed, these variables are set to the relevant values for the
27476 outgoing connection.
27477
27478
27479
27480 .section "Use of TLS Server Name Indication" "SECTtlssni"
27481 .cindex "TLS" "Server Name Indication"
27482 .vindex "&$tls_in_sni$&"
27483 .oindex "&%tls_in_sni%&"
27484 With TLS1.0 or above, there is an extension mechanism by which extra
27485 information can be included at various points in the protocol.  One of these
27486 extensions, documented in RFC 6066 (and before that RFC 4366) is
27487 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27488 client in the initial handshake, so that the server can examine the servername
27489 within and possibly choose to use different certificates and keys (and more)
27490 for this session.
27491
27492 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27493 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27494 address.
27495
27496 With SMTP to MX, there are the same problems here as in choosing the identity
27497 against which to validate a certificate: you can't rely on insecure DNS to
27498 provide the identity which you then cryptographically verify.  So this will
27499 be of limited use in that environment.
27500
27501 With SMTP to Submission, there is a well-defined hostname which clients are
27502 connecting to and can validate certificates against.  Thus clients &*can*&
27503 choose to include this information in the TLS negotiation.  If this becomes
27504 wide-spread, then hosters can choose to present different certificates to
27505 different clients.  Or even negotiate different cipher suites.
27506
27507 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27508 if not empty, will be sent on a TLS session as part of the handshake.  There's
27509 nothing more to it.  Choosing a sensible value not derived insecurely is the
27510 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27511 for the lifetime of the client connection (including during authentication).
27512
27513 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27514 received from a client.
27515 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27516
27517 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27518 option (prior to expansion) then the following options will be re-expanded
27519 during TLS session handshake, to permit alternative values to be chosen:
27520
27521 .ilist
27522 .vindex "&%tls_certificate%&"
27523 &%tls_certificate%&
27524 .next
27525 .vindex "&%tls_crl%&"
27526 &%tls_crl%&
27527 .next
27528 .vindex "&%tls_privatekey%&"
27529 &%tls_privatekey%&
27530 .next
27531 .vindex "&%tls_verify_certificates%&"
27532 &%tls_verify_certificates%&
27533 .next
27534 .vindex "&%tls_ocsp_file%&"
27535 &%tls_ocsp_file%&
27536 .endlist
27537
27538 Great care should be taken to deal with matters of case, various injection
27539 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27540 can always be referenced; it is important to remember that &$tls_sni$& is
27541 arbitrary unverified data provided prior to authentication.
27542
27543 The Exim developers are proceeding cautiously and so far no other TLS options
27544 are re-expanded.
27545
27546 When Exim is built against OpenSSL, OpenSSL must have been built with support
27547 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27548 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27549 see &`-servername`& in the output, then OpenSSL has support.
27550
27551 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27552 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27553 built, then you have SNI support).
27554
27555
27556
27557 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27558          "SECTmulmessam"
27559 .cindex "multiple SMTP deliveries with TLS"
27560 .cindex "TLS" "multiple message deliveries"
27561 Exim sends multiple messages down the same TCP/IP connection by starting up
27562 an entirely new delivery process for each message, passing the socket from
27563 one process to the next. This implementation does not fit well with the use
27564 of TLS, because there is quite a lot of state information associated with a TLS
27565 connection, not just a socket identification. Passing all the state information
27566 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27567 session before passing the socket to a new process. The new process may then
27568 try to start a new TLS session, and if successful, may try to re-authenticate
27569 if AUTH is in use, before sending the next message.
27570
27571 The RFC is not clear as to whether or not an SMTP session continues in clear
27572 after TLS has been shut down, or whether TLS may be restarted again later, as
27573 just described. However, if the server is Exim, this shutdown and
27574 reinitialization works. It is not known which (if any) other servers operate
27575 successfully if the client closes a TLS session and continues with unencrypted
27576 SMTP, but there are certainly some that do not work. For such servers, Exim
27577 should not pass the socket to another process, because the failure of the
27578 subsequent attempt to use it would cause Exim to record a temporary host error,
27579 and delay other deliveries to that host.
27580
27581 To test for this case, Exim sends an EHLO command to the server after
27582 closing down the TLS session. If this fails in any way, the connection is
27583 closed instead of being passed to a new delivery process, but no retry
27584 information is recorded.
27585
27586 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27587 &(smtp)& transport to match those hosts for which Exim should not pass
27588 connections to new processes if TLS has been used.
27589
27590
27591
27592
27593 .section "Certificates and all that" "SECTcerandall"
27594 .cindex "certificate" "references to discussion"
27595 In order to understand fully how TLS works, you need to know about
27596 certificates, certificate signing, and certificate authorities. This is not the
27597 place to give a tutorial, especially as I do not know very much about it
27598 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27599 to Apache, currently at
27600 .display
27601 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27602 .endd
27603 Other parts of the &'modssl'& documentation are also helpful, and have
27604 links to further files.
27605 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27606 0-201-61598-3), contains both introductory and more in-depth descriptions.
27607 Some sample programs taken from the book are available from
27608 .display
27609 &url(http://www.rtfm.com/openssl-examples/)
27610 .endd
27611
27612
27613 .section "Certificate chains" "SECID186"
27614 The file named by &%tls_certificate%& may contain more than one
27615 certificate. This is useful in the case where the certificate that is being
27616 sent is validated by an intermediate certificate which the other end does
27617 not have. Multiple certificates must be in the correct order in the file.
27618 First the host's certificate itself, then the first intermediate
27619 certificate to validate the issuer of the host certificate, then the next
27620 intermediate certificate to validate the issuer of the first intermediate
27621 certificate, and so on, until finally (optionally) the root certificate.
27622 The root certificate must already be trusted by the recipient for
27623 validation to succeed, of course, but if it's not preinstalled, sending the
27624 root certificate along with the rest makes it available for the user to
27625 install if the receiving end is a client MUA that can interact with a user.
27626
27627 Note that certificates using MD5 are unlikely to work on today's Internet;
27628 even if your libraries allow loading them for use in Exim when acting as a
27629 server, increasingly clients will not accept such certificates.  The error
27630 diagnostics in such a case can be frustratingly vague.
27631
27632
27633
27634 .section "Self-signed certificates" "SECID187"
27635 .cindex "certificate" "self-signed"
27636 You can create a self-signed certificate using the &'req'& command provided
27637 with OpenSSL, like this:
27638 . ==== Do not shorten the duration here without reading and considering
27639 . ==== the text below.  Please leave it at 9999 days.
27640 .code
27641 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27642             -days 9999 -nodes
27643 .endd
27644 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27645 delimited and so can be identified independently. The &%-days%& option
27646 specifies a period for which the certificate is valid. The &%-nodes%& option is
27647 important: if you do not set it, the key is encrypted with a passphrase
27648 that you are prompted for, and any use that is made of the key causes more
27649 prompting for the passphrase. This is not helpful if you are going to use
27650 this certificate and key in an MTA, where prompting is not possible.
27651
27652 . ==== I expect to still be working 26 years from now.  The less technical
27653 . ==== debt I create, in terms of storing up trouble for my later years, the
27654 . ==== happier I will be then.  We really have reached the point where we
27655 . ==== should start, at the very least, provoking thought and making folks
27656 . ==== pause before proceeding, instead of leaving all the fixes until two
27657 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27658 . ==== -pdp, 2012
27659 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27660 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27661 the above command might produce a date in the past.  Think carefully about
27662 the lifetime of the systems you're deploying, and either reduce the duration
27663 of the certificate or reconsider your platform deployment.  (At time of
27664 writing, reducing the duration is the most likely choice, but the inexorable
27665 progression of time takes us steadily towards an era where this will not
27666 be a sensible resolution).
27667
27668 A self-signed certificate made in this way is sufficient for testing, and
27669 may be adequate for all your requirements if you are mainly interested in
27670 encrypting transfers, and not in secure identification.
27671
27672 However, many clients require that the certificate presented by the server be a
27673 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27674 certificate. In this situation, the self-signed certificate described above
27675 must be installed on the client host as a trusted root &'certification
27676 authority'& (CA), and the certificate used by Exim must be a user certificate
27677 signed with that self-signed certificate.
27678
27679 For information on creating self-signed CA certificates and using them to sign
27680 user certificates, see the &'General implementation overview'& chapter of the
27681 Open-source PKI book, available online at
27682 &url(http://ospkibook.sourceforge.net/).
27683 .ecindex IIDencsmtp1
27684 .ecindex IIDencsmtp2
27685
27686
27687
27688 . ////////////////////////////////////////////////////////////////////////////
27689 . ////////////////////////////////////////////////////////////////////////////
27690
27691 .chapter "Access control lists" "CHAPACL"
27692 .scindex IIDacl "&ACL;" "description"
27693 .cindex "control of incoming mail"
27694 .cindex "message" "controlling incoming"
27695 .cindex "policy control" "access control lists"
27696 Access Control Lists (ACLs) are defined in a separate section of the run time
27697 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27698 name, terminated by a colon. Here is a complete ACL section that contains just
27699 one very small ACL:
27700 .code
27701 begin acl
27702 small_acl:
27703   accept   hosts = one.host.only
27704 .endd
27705 You can have as many lists as you like in the ACL section, and the order in
27706 which they appear does not matter. The lists are self-terminating.
27707
27708 The majority of ACLs are used to control Exim's behaviour when it receives
27709 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27710 when a local process submits a message using SMTP by specifying the &%-bs%&
27711 option. The most common use is for controlling which recipients are accepted
27712 in incoming messages. In addition, you can define an ACL that is used to check
27713 local non-SMTP messages. The default configuration file contains an example of
27714 a realistic ACL for checking RCPT commands. This is discussed in chapter
27715 &<<CHAPdefconfil>>&.
27716
27717
27718 .section "Testing ACLs" "SECID188"
27719 The &%-bh%& command line option provides a way of testing your ACL
27720 configuration locally by running a fake SMTP session with which you interact.
27721
27722
27723 .section "Specifying when ACLs are used" "SECID189"
27724 .cindex "&ACL;" "options for specifying"
27725 In order to cause an ACL to be used, you have to name it in one of the relevant
27726 options in the main part of the configuration. These options are:
27727 .cindex "AUTH" "ACL for"
27728 .cindex "DATA" "ACLs for"
27729 .cindex "ETRN" "ACL for"
27730 .cindex "EXPN" "ACL for"
27731 .cindex "HELO" "ACL for"
27732 .cindex "EHLO" "ACL for"
27733 .cindex "DKIM" "ACL for"
27734 .cindex "MAIL" "ACL for"
27735 .cindex "QUIT, ACL for"
27736 .cindex "RCPT" "ACL for"
27737 .cindex "STARTTLS, ACL for"
27738 .cindex "VRFY" "ACL for"
27739 .cindex "SMTP" "connection, ACL for"
27740 .cindex "non-SMTP messages" "ACLs for"
27741 .cindex "MIME content scanning" "ACL for"
27742 .cindex "PRDR" "ACL for"
27743
27744 .table2 140pt
27745 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27746 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27747 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27748 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27749 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27750 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27751 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27752 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27753 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27754 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27755 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27756 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27757 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27758 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27759 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27760 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27761 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27762 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27763 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27764 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27765 .endtable
27766
27767 For example, if you set
27768 .code
27769 acl_smtp_rcpt = small_acl
27770 .endd
27771 the little ACL defined above is used whenever Exim receives a RCPT command
27772 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27773 done when RCPT commands arrive. A rejection of RCPT should cause the
27774 sending MTA to give up on the recipient address contained in the RCPT
27775 command, whereas rejection at other times may cause the client MTA to keep on
27776 trying to deliver the message. It is therefore recommended that you do as much
27777 testing as possible at RCPT time.
27778
27779
27780 .section "The non-SMTP ACLs" "SECID190"
27781 .cindex "non-SMTP messages" "ACLs for"
27782 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27783 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27784 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27785 the state of the SMTP connection such as encryption and authentication) are not
27786 relevant and are forbidden in these ACLs. However, the sender and recipients
27787 are known, so the &%senders%& and &%sender_domains%& conditions and the
27788 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27789 &$authenticated_sender$& are also available. You can specify added header lines
27790 in any of these ACLs.
27791
27792 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27793 non-SMTP message, before any of the message has been read. (This is the
27794 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27795 batched SMTP input, it runs after the DATA command has been reached. The
27796 result of this ACL is ignored; it cannot be used to reject a message. If you
27797 really need to, you could set a value in an ACL variable here and reject based
27798 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27799 controls, and in particular, it can be used to set
27800 .code
27801 control = suppress_local_fixups
27802 .endd
27803 This cannot be used in the other non-SMTP ACLs because by the time they are
27804 run, it is too late.
27805
27806 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27807 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27808
27809 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27810 kind of rejection is treated as permanent, because there is no way of sending a
27811 temporary error for these kinds of message.
27812
27813
27814 .section "The SMTP connect ACL" "SECID191"
27815 .cindex "SMTP" "connection, ACL for"
27816 .oindex &%smtp_banner%&
27817 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27818 session, after the test specified by &%host_reject_connection%& (which is now
27819 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27820 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27821 the message override the banner message that is otherwise specified by the
27822 &%smtp_banner%& option.
27823
27824
27825 .section "The EHLO/HELO ACL" "SECID192"
27826 .cindex "EHLO" "ACL for"
27827 .cindex "HELO" "ACL for"
27828 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27829 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27830 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27831 Note that a client may issue more than one EHLO or HELO command in an SMTP
27832 session, and indeed is required to issue a new EHLO or HELO after successfully
27833 setting up encryption following a STARTTLS command.
27834
27835 Note also that a deny neither forces the client to go away nor means that
27836 mail will be refused on the connection.  Consider checking for
27837 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27838
27839 If the command is accepted by an &%accept%& verb that has a &%message%&
27840 modifier, the message may not contain more than one line (it will be truncated
27841 at the first newline and a panic logged if it does). Such a message cannot
27842 affect the EHLO options that are listed on the second and subsequent lines of
27843 an EHLO response.
27844
27845
27846 .section "The DATA ACLs" "SECID193"
27847 .cindex "DATA" "ACLs for"
27848 Two ACLs are associated with the DATA command, because it is two-stage
27849 command, with two responses being sent to the client.
27850 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27851 is obeyed. This gives you control after all the RCPT commands, but before
27852 the message itself is received. It offers the opportunity to give a negative
27853 response to the DATA command before the data is transmitted. Header lines
27854 added by MAIL or RCPT ACLs are not visible at this time, but any that
27855 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27856
27857 You cannot test the contents of the message, for example, to verify addresses
27858 in the headers, at RCPT time or when the DATA command is received. Such
27859 tests have to appear in the ACL that is run after the message itself has been
27860 received, before the final response to the DATA command is sent. This is
27861 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27862 associated with the DATA command.
27863
27864 .new
27865 .cindex CHUNKING "BDAT command"
27866 .cindex BDAT "SMTP command"
27867 .cindex "RFC 3030" CHUNKING
27868 If CHUNKING was advertised and a BDAT command sequence is received,
27869 the &%acl_smtp_predata%& ACL is not run.
27870 . XXX why not?  It should be possible, for the first BDAT.
27871 The &%acl_smtp_data%& is run after the last BDAT command and all of
27872 the data specified is received.
27873 .wen
27874
27875 For both of these ACLs, it is not possible to reject individual recipients. An
27876 error response rejects the entire message. Unfortunately, it is known that some
27877 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27878 before or after the data) correctly &-- they keep the message on their queues
27879 and try again later, but that is their problem, though it does waste some of
27880 your resources.
27881
27882 The &%acl_smtp_data%& ACL is run after
27883 the &%acl_smtp_data_prdr%&,
27884 the &%acl_smtp_dkim%&
27885 and the &%acl_smtp_mime%& ACLs.
27886
27887 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27888 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27889 enabled (which is the default).
27890
27891 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27892 received, and is executed for each DKIM signature found in a message.  If not
27893 otherwise specified, the default action is to accept.
27894
27895 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27896
27897 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27898
27899
27900 .section "The SMTP MIME ACL" "SECID194"
27901 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27902 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27903
27904 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27905
27906
27907 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27908 .cindex "PRDR" "ACL for"
27909 .oindex "&%prdr_enable%&"
27910 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27911 with PRDR support enabled (which is the default).
27912 It becomes active only when the PRDR feature is negotiated between
27913 client and server for a message, and more than one recipient
27914 has been accepted.
27915
27916 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27917 has been received, and is executed once for each recipient of the message
27918 with &$local_part$& and &$domain$& valid.
27919 The test may accept, defer or deny for individual recipients.
27920 The &%acl_smtp_data%& will still be called after this ACL and
27921 can reject the message overall, even if this ACL has accepted it
27922 for some or all recipients.
27923
27924 PRDR may be used to support per-user content filtering.  Without it
27925 one must defer any recipient after the first that has a different
27926 content-filter configuration.  With PRDR, the RCPT-time check
27927 .cindex "PRDR" "variable for"
27928 for this can be disabled when the variable &$prdr_requested$&
27929 is &"yes"&.
27930 Any required difference in behaviour of the main DATA-time
27931 ACL should however depend on the PRDR-time ACL having run, as Exim
27932 will avoid doing so in some situations (e.g.  single-recipient mails).
27933
27934 See also the &%prdr_enable%& global option
27935 and the &%hosts_try_prdr%& smtp transport option.
27936
27937 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27938 If the ACL is not defined, processing completes as if
27939 the feature was not requested by the client.
27940
27941 .section "The QUIT ACL" "SECTQUITACL"
27942 .cindex "QUIT, ACL for"
27943 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27944 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27945 does not in fact control any access.
27946 For this reason, it may only accept
27947 or warn as its final result.
27948
27949 This ACL can be used for tasks such as custom logging at the end of an SMTP
27950 session. For example, you can use ACL variables in other ACLs to count
27951 messages, recipients, etc., and log the totals at QUIT time using one or
27952 more &%logwrite%& modifiers on a &%warn%& verb.
27953
27954 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27955 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27956
27957 You do not need to have a final &%accept%&, but if you do, you can use a
27958 &%message%& modifier to specify custom text that is sent as part of the 221
27959 response to QUIT.
27960
27961 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27962 failure (for example, failure to open a log file, or when Exim is bombing out
27963 because it has detected an unrecoverable error), all SMTP commands from the
27964 client are given temporary error responses until QUIT is received or the
27965 connection is closed. In these special cases, the QUIT ACL does not run.
27966
27967
27968 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27969 .vindex &$acl_smtp_notquit$&
27970 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27971 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27972 trouble, such as being unable to write to its log files, this ACL is not run,
27973 because it might try to do things (such as write to log files) that make the
27974 situation even worse.
27975
27976 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27977 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27978 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27979 and &%warn%&.
27980
27981 .vindex &$smtp_notquit_reason$&
27982 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27983 to a string that indicates the reason for the termination of the SMTP
27984 connection. The possible values are:
27985 .table2
27986 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27987 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27988 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27989 .irow &`connection-lost`&          "The SMTP connection has been lost"
27990 .irow &`data-timeout`&             "Timeout while reading message data"
27991 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27992 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27993 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27994 .irow &`synchronization-error`&    "SMTP synchronization error"
27995 .irow &`tls-failed`&               "TLS failed to start"
27996 .endtable
27997 In most cases when an SMTP connection is closed without having received QUIT,
27998 Exim sends an SMTP response message before actually closing the connection.
27999 With the exception of the &`acl-drop`& case, the default message can be
28000 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28001 &%drop%& verb in another ACL, it is the message from the other ACL that is
28002 used.
28003
28004
28005 .section "Finding an ACL to use" "SECID195"
28006 .cindex "&ACL;" "finding which to use"
28007 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28008 you can use different ACLs in different circumstances. For example,
28009 .code
28010 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28011                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28012 .endd
28013 In the default configuration file there are some example settings for
28014 providing an RFC 4409 message submission service on port 587 and a
28015 non-standard &"smtps"& service on port 465. You can use a string
28016 expansion like this to choose an ACL for MUAs on these ports which is
28017 more appropriate for this purpose than the default ACL on port 25.
28018
28019 The expanded string does not have to be the name of an ACL in the
28020 configuration file; there are other possibilities. Having expanded the
28021 string, Exim searches for an ACL as follows:
28022
28023 .ilist
28024 If the string begins with a slash, Exim uses it as a file name, and reads its
28025 contents as an ACL. The lines are processed in the same way as lines in the
28026 Exim configuration file. In particular, continuation lines are supported, blank
28027 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28028 If the file does not exist or cannot be read, an error occurs (typically
28029 causing a temporary failure of whatever caused the ACL to be run). For example:
28030 .code
28031 acl_smtp_data = /etc/acls/\
28032   ${lookup{$sender_host_address}lsearch\
28033   {/etc/acllist}{$value}{default}}
28034 .endd
28035 This looks up an ACL file to use on the basis of the host's IP address, falling
28036 back to a default if the lookup fails. If an ACL is successfully read from a
28037 file, it is retained in memory for the duration of the Exim process, so that it
28038 can be re-used without having to re-read the file.
28039 .next
28040 If the string does not start with a slash, and does not contain any spaces,
28041 Exim searches the ACL section of the configuration for an ACL whose name
28042 matches the string.
28043 .next
28044 If no named ACL is found, or if the string contains spaces, Exim parses
28045 the string as an inline ACL. This can save typing in cases where you just
28046 want to have something like
28047 .code
28048 acl_smtp_vrfy = accept
28049 .endd
28050 in order to allow free use of the VRFY command. Such a string may contain
28051 newlines; it is processed in the same way as an ACL that is read from a file.
28052 .endlist
28053
28054
28055
28056
28057 .section "ACL return codes" "SECID196"
28058 .cindex "&ACL;" "return codes"
28059 Except for the QUIT ACL, which does not affect the SMTP return code (see
28060 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28061 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28062 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28063 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28064 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28065 This also causes a 4&'xx'& return code.
28066
28067 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28068 &"deny"&, because there is no mechanism for passing temporary errors to the
28069 submitters of non-SMTP messages.
28070
28071
28072 ACLs that are relevant to message reception may also return &"discard"&. This
28073 has the effect of &"accept"&, but causes either the entire message or an
28074 individual recipient address to be discarded. In other words, it is a
28075 blackholing facility. Use it with care.
28076
28077 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28078 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28079 RCPT ACL is to discard just the one recipient address. If there are no
28080 recipients left when the message's data is received, the DATA ACL is not
28081 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28082 remaining recipients. The &"discard"& return is not permitted for the
28083 &%acl_smtp_predata%& ACL.
28084
28085
28086 .cindex "&[local_scan()]& function" "when all recipients discarded"
28087 The &[local_scan()]& function is always run, even if there are no remaining
28088 recipients; it may create new recipients.
28089
28090
28091
28092 .section "Unset ACL options" "SECID197"
28093 .cindex "&ACL;" "unset options"
28094 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28095 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28096 not defined at all. For any defined ACL, the default action when control
28097 reaches the end of the ACL statements is &"deny"&.
28098
28099 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28100 these two are ACLs that are used only for their side effects. They cannot be
28101 used to accept or reject anything.
28102
28103 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28104 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28105 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28106 when the ACL is not defined is &"accept"&.
28107
28108 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28109 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28110 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28111 messages over an SMTP connection. For an example, see the ACL in the default
28112 configuration file.
28113
28114
28115
28116
28117 .section "Data for message ACLs" "SECID198"
28118 .cindex "&ACL;" "data for message ACL"
28119 .vindex &$domain$&
28120 .vindex &$local_part$&
28121 .vindex &$sender_address$&
28122 .vindex &$sender_host_address$&
28123 .vindex &$smtp_command$&
28124 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28125 that contain information about the host and the message's sender (for example,
28126 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28127 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28128 &$local_part$& are set from the argument address. The entire SMTP command
28129 is available in &$smtp_command$&.
28130
28131 When an ACL for the AUTH parameter of MAIL is running, the variables that
28132 contain information about the host are set, but &$sender_address$& is not yet
28133 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28134 how it is used.
28135
28136 .vindex "&$message_size$&"
28137 The &$message_size$& variable is set to the value of the SIZE parameter on
28138 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28139 that parameter is not given. The value is updated to the true message size by
28140 the time the final DATA ACL is run (after the message data has been
28141 received).
28142
28143 .vindex "&$rcpt_count$&"
28144 .vindex "&$recipients_count$&"
28145 The &$rcpt_count$& variable increases by one for each RCPT command received.
28146 The &$recipients_count$& variable increases by one each time a RCPT command is
28147 accepted, so while an ACL for RCPT is being processed, it contains the number
28148 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28149 &$rcpt_count$& contains the total number of RCPT commands, and
28150 &$recipients_count$& contains the total number of accepted recipients.
28151
28152
28153
28154
28155
28156 .section "Data for non-message ACLs" "SECTdatfornon"
28157 .cindex "&ACL;" "data for non-message ACL"
28158 .vindex &$smtp_command_argument$&
28159 .vindex &$smtp_command$&
28160 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28161 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28162 and the entire SMTP command is available in &$smtp_command$&.
28163 These variables can be tested using a &%condition%& condition. For example,
28164 here is an ACL for use with AUTH, which insists that either the session is
28165 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28166 does not permit authentication methods that use cleartext passwords on
28167 unencrypted connections.
28168 .code
28169 acl_check_auth:
28170   accept encrypted = *
28171   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28172                      {CRAM-MD5}}
28173   deny   message   = TLS encryption or CRAM-MD5 required
28174 .endd
28175 (Another way of applying this restriction is to arrange for the authenticators
28176 that use cleartext passwords not to be advertised when the connection is not
28177 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28178 option to do this.)
28179
28180
28181
28182 .section "Format of an ACL" "SECID199"
28183 .cindex "&ACL;" "format of"
28184 .cindex "&ACL;" "verbs, definition of"
28185 An individual ACL consists of a number of statements. Each statement starts
28186 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28187 Modifiers can change the way the verb operates, define error and log messages,
28188 set variables, insert delays, and vary the processing of accepted messages.
28189
28190 If all the conditions are met, the verb is obeyed. The same condition may be
28191 used (with different arguments) more than once in the same statement. This
28192 provides a means of specifying an &"and"& conjunction between conditions. For
28193 example:
28194 .code
28195 deny  dnslists = list1.example
28196       dnslists = list2.example
28197 .endd
28198 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28199 the conditions and modifiers when it reaches a condition that fails. What
28200 happens then depends on the verb (and in one case, on a special modifier). Not
28201 all the conditions make sense at every testing point. For example, you cannot
28202 test a sender address in the ACL that is run for a VRFY command.
28203
28204
28205 .section "ACL verbs" "SECID200"
28206 The ACL verbs are as follows:
28207
28208 .ilist
28209 .cindex "&%accept%& ACL verb"
28210 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28211 of the conditions are not met, what happens depends on whether &%endpass%&
28212 appears among the conditions (for syntax see below). If the failing condition
28213 is before &%endpass%&, control is passed to the next ACL statement; if it is
28214 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28215 check a RCPT command:
28216 .code
28217 accept domains = +local_domains
28218        endpass
28219        verify = recipient
28220 .endd
28221 If the recipient domain does not match the &%domains%& condition, control
28222 passes to the next statement. If it does match, the recipient is verified, and
28223 the command is accepted if verification succeeds. However, if verification
28224 fails, the ACL yields &"deny"&, because the failing condition is after
28225 &%endpass%&.
28226
28227 The &%endpass%& feature has turned out to be confusing to many people, so its
28228 use is not recommended nowadays. It is always possible to rewrite an ACL so
28229 that &%endpass%& is not needed, and it is no longer used in the default
28230 configuration.
28231
28232 .cindex "&%message%& ACL modifier" "with &%accept%&"
28233 If a &%message%& modifier appears on an &%accept%& statement, its action
28234 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28235 (when an &%accept%& verb either accepts or passes control to the next
28236 statement), &%message%& can be used to vary the message that is sent when an
28237 SMTP command is accepted. For example, in a RCPT ACL you could have:
28238 .display
28239 &`accept  `&<&'some conditions'&>
28240 &`        message = OK, I will allow you through today`&
28241 .endd
28242 You can specify an SMTP response code, optionally followed by an &"extended
28243 response code"& at the start of the message, but the first digit must be the
28244 same as would be sent by default, which is 2 for an &%accept%& verb.
28245
28246 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28247 an error message that is used when access is denied. This behaviour is retained
28248 for backward compatibility, but current &"best practice"& is to avoid the use
28249 of &%endpass%&.
28250
28251
28252 .next
28253 .cindex "&%defer%& ACL verb"
28254 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28255 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28256 &%defer%& is the same as &%deny%&, because there is no way of sending a
28257 temporary error. For a RCPT command, &%defer%& is much the same as using a
28258 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28259 be used in any ACL, and even for a recipient it might be a simpler approach.
28260
28261
28262 .next
28263 .cindex "&%deny%& ACL verb"
28264 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28265 the conditions are not met, control is passed to the next ACL statement. For
28266 example,
28267 .code
28268 deny dnslists = blackholes.mail-abuse.org
28269 .endd
28270 rejects commands from hosts that are on a DNS black list.
28271
28272
28273 .next
28274 .cindex "&%discard%& ACL verb"
28275 &%discard%&: This verb behaves like &%accept%&, except that it returns
28276 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28277 that are concerned with receiving messages. When all the conditions are true,
28278 the sending entity receives a &"success"& response. However, &%discard%& causes
28279 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28280 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28281 message's recipients are discarded. Recipients that are discarded before DATA
28282 do not appear in the log line when the &%received_recipients%& log selector is set.
28283
28284 If the &%log_message%& modifier is set when &%discard%& operates,
28285 its contents are added to the line that is automatically written to the log.
28286 The &%message%& modifier operates exactly as it does for &%accept%&.
28287
28288
28289 .next
28290 .cindex "&%drop%& ACL verb"
28291 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28292 forcibly closed after the 5&'xx'& error message has been sent. For example:
28293 .code
28294 drop   message   = I don't take more than 20 RCPTs
28295        condition = ${if > {$rcpt_count}{20}}
28296 .endd
28297 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28298 The connection is always dropped after sending a 550 response.
28299
28300 .next
28301 .cindex "&%require%& ACL verb"
28302 &%require%&: If all the conditions are met, control is passed to the next ACL
28303 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28304 example, when checking a RCPT command,
28305 .code
28306 require message = Sender did not verify
28307         verify  = sender
28308 .endd
28309 passes control to subsequent statements only if the message's sender can be
28310 verified. Otherwise, it rejects the command. Note the positioning of the
28311 &%message%& modifier, before the &%verify%& condition. The reason for this is
28312 discussed in section &<<SECTcondmodproc>>&.
28313
28314 .next
28315 .cindex "&%warn%& ACL verb"
28316 &%warn%&: If all the conditions are true, a line specified by the
28317 &%log_message%& modifier is written to Exim's main log. Control always passes
28318 to the next ACL statement. If any condition is false, the log line is not
28319 written. If an identical log line is requested several times in the same
28320 message, only one copy is actually written to the log. If you want to force
28321 duplicates to be written, use the &%logwrite%& modifier instead.
28322
28323 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28324 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28325 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28326 first failing condition. There is more about adding header lines in section
28327 &<<SECTaddheadacl>>&.
28328
28329 If any condition on a &%warn%& statement cannot be completed (that is, there is
28330 some sort of defer), the log line specified by &%log_message%& is not written.
28331 This does not include the case of a forced failure from a lookup, which
28332 is considered to be a successful completion. After a defer, no further
28333 conditions or modifiers in the &%warn%& statement are processed. The incident
28334 is logged, and the ACL continues to be processed, from the next statement
28335 onwards.
28336
28337
28338 .vindex "&$acl_verify_message$&"
28339 When one of the &%warn%& conditions is an address verification that fails, the
28340 text of the verification failure message is in &$acl_verify_message$&. If you
28341 want this logged, you must set it up explicitly. For example:
28342 .code
28343 warn   !verify = sender
28344        log_message = sender verify failed: $acl_verify_message
28345 .endd
28346 .endlist
28347
28348 At the end of each ACL there is an implicit unconditional &%deny%&.
28349
28350 As you can see from the examples above, the conditions and modifiers are
28351 written one to a line, with the first one on the same line as the verb, and
28352 subsequent ones on following lines. If you have a very long condition, you can
28353 continue it onto several physical lines by the usual backslash continuation
28354 mechanism. It is conventional to align the conditions vertically.
28355
28356
28357
28358 .section "ACL variables" "SECTaclvariables"
28359 .cindex "&ACL;" "variables"
28360 There are some special variables that can be set during ACL processing. They
28361 can be used to pass information between different ACLs, different invocations
28362 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28363 transports, and filters that are used to deliver a message. The names of these
28364 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28365 an underscore, but the remainder of the name can be any sequence of
28366 alphanumeric characters and underscores that you choose. There is no limit on
28367 the number of ACL variables. The two sets act as follows:
28368 .ilist
28369 The values of those variables whose names begin with &$acl_c$& persist
28370 throughout an SMTP connection. They are never reset. Thus, a value that is set
28371 while receiving one message is still available when receiving the next message
28372 on the same SMTP connection.
28373 .next
28374 The values of those variables whose names begin with &$acl_m$& persist only
28375 while a message is being received. They are reset afterwards. They are also
28376 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28377 .endlist
28378
28379 When a message is accepted, the current values of all the ACL variables are
28380 preserved with the message and are subsequently made available at delivery
28381 time. The ACL variables are set by a modifier called &%set%&. For example:
28382 .code
28383 accept hosts = whatever
28384        set acl_m4 = some value
28385 accept authenticated = *
28386        set acl_c_auth = yes
28387 .endd
28388 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28389 be set. If you want to set a variable without taking any action, you can use a
28390 &%warn%& verb without any other modifiers or conditions.
28391
28392 .oindex &%strict_acl_vars%&
28393 What happens if a syntactically valid but undefined ACL variable is
28394 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28395 false (the default), an empty string is substituted; if it is true, an
28396 error is generated.
28397
28398 Versions of Exim before 4.64 have a limited set of numbered variables, but
28399 their names are compatible, so there is no problem with upgrading.
28400
28401
28402 .section "Condition and modifier processing" "SECTcondmodproc"
28403 .cindex "&ACL;" "conditions; processing"
28404 .cindex "&ACL;" "modifiers; processing"
28405 An exclamation mark preceding a condition negates its result. For example:
28406 .code
28407 deny   domains = *.dom.example
28408       !verify  = recipient
28409 .endd
28410 causes the ACL to return &"deny"& if the recipient domain ends in
28411 &'dom.example'& and the recipient address cannot be verified. Sometimes
28412 negation can be used on the right-hand side of a condition. For example, these
28413 two statements are equivalent:
28414 .code
28415 deny  hosts = !192.168.3.4
28416 deny !hosts =  192.168.3.4
28417 .endd
28418 However, for many conditions (&%verify%& being a good example), only left-hand
28419 side negation of the whole condition is possible.
28420
28421 The arguments of conditions and modifiers are expanded. A forced failure
28422 of an expansion causes a condition to be ignored, that is, it behaves as if the
28423 condition is true. Consider these two statements:
28424 .code
28425 accept  senders = ${lookup{$host_name}lsearch\
28426                   {/some/file}{$value}fail}
28427 accept  senders = ${lookup{$host_name}lsearch\
28428                   {/some/file}{$value}{}}
28429 .endd
28430 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28431 the returned list is searched, but if the lookup fails the behaviour is
28432 different in the two cases. The &%fail%& in the first statement causes the
28433 condition to be ignored, leaving no further conditions. The &%accept%& verb
28434 therefore succeeds. The second statement, however, generates an empty list when
28435 the lookup fails. No sender can match an empty list, so the condition fails,
28436 and therefore the &%accept%& also fails.
28437
28438 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28439 specify actions that are taken as the conditions for a statement are checked;
28440 others specify text for messages that are used when access is denied or a
28441 warning is generated. The &%control%& modifier affects the way an incoming
28442 message is handled.
28443
28444 The positioning of the modifiers in an ACL statement is important, because the
28445 processing of a verb ceases as soon as its outcome is known. Only those
28446 modifiers that have already been encountered will take effect. For example,
28447 consider this use of the &%message%& modifier:
28448 .code
28449 require message = Can't verify sender
28450         verify  = sender
28451         message = Can't verify recipient
28452         verify  = recipient
28453         message = This message cannot be used
28454 .endd
28455 If sender verification fails, Exim knows that the result of the statement is
28456 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28457 so its text is used as the error message. If sender verification succeeds, but
28458 recipient verification fails, the second message is used. If recipient
28459 verification succeeds, the third message becomes &"current"&, but is never used
28460 because there are no more conditions to cause failure.
28461
28462 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28463 modifier that is used, because all the conditions must be true for rejection to
28464 happen. Specifying more than one &%message%& modifier does not make sense, and
28465 the message can even be specified after all the conditions. For example:
28466 .code
28467 deny   hosts = ...
28468       !senders = *@my.domain.example
28469        message = Invalid sender from client host
28470 .endd
28471 The &"deny"& result does not happen until the end of the statement is reached,
28472 by which time Exim has set up the message.
28473
28474
28475
28476 .section "ACL modifiers" "SECTACLmodi"
28477 .cindex "&ACL;" "modifiers; list of"
28478 The ACL modifiers are as follows:
28479
28480 .vlist
28481 .vitem &*add_header*&&~=&~<&'text'&>
28482 This modifier specifies one or more header lines that are to be added to an
28483 incoming message, assuming, of course, that the message is ultimately
28484 accepted. For details, see section &<<SECTaddheadacl>>&.
28485
28486 .vitem &*continue*&&~=&~<&'text'&>
28487 .cindex "&%continue%& ACL modifier"
28488 .cindex "database" "updating in ACL"
28489 This modifier does nothing of itself, and processing of the ACL always
28490 continues with the next condition or modifier. The value of &%continue%& is in
28491 the side effects of expanding its argument. Typically this could be used to
28492 update a database. It is really just a syntactic tidiness, to avoid having to
28493 write rather ugly lines like this:
28494 .display
28495 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28496 .endd
28497 Instead, all you need is
28498 .display
28499 &`continue = `&<&'some expansion'&>
28500 .endd
28501
28502 .vitem &*control*&&~=&~<&'text'&>
28503 .cindex "&%control%& ACL modifier"
28504 This modifier affects the subsequent processing of the SMTP connection or of an
28505 incoming message that is accepted. The effect of the first type of control
28506 lasts for the duration of the connection, whereas the effect of the second type
28507 lasts only until the current message has been received. The message-specific
28508 controls always apply to the whole message, not to individual recipients,
28509 even if the &%control%& modifier appears in a RCPT ACL.
28510
28511 As there are now quite a few controls that can be applied, they are described
28512 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28513 in several different ways. For example:
28514
28515 . ==== As this is a nested list, any displays it contains must be indented
28516 . ==== as otherwise they are too far to the left. That comment applies only
28517 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28518 . ==== way.
28519
28520 .ilist
28521 It can be at the end of an &%accept%& statement:
28522 .code
28523     accept  ...some conditions
28524             control = queue_only
28525 .endd
28526 In this case, the control is applied when this statement yields &"accept"&, in
28527 other words, when the conditions are all true.
28528
28529 .next
28530 It can be in the middle of an &%accept%& statement:
28531 .code
28532     accept  ...some conditions...
28533             control = queue_only
28534             ...some more conditions...
28535 .endd
28536 If the first set of conditions are true, the control is applied, even if the
28537 statement does not accept because one of the second set of conditions is false.
28538 In this case, some subsequent statement must yield &"accept"& for the control
28539 to be relevant.
28540
28541 .next
28542 It can be used with &%warn%& to apply the control, leaving the
28543 decision about accepting or denying to a subsequent verb. For
28544 example:
28545 .code
28546     warn    ...some conditions...
28547             control = freeze
28548     accept  ...
28549 .endd
28550 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28551 &%logwrite%&, so it does not add anything to the message and does not write a
28552 log entry.
28553
28554 .next
28555 If you want to apply a control unconditionally, you can use it with a
28556 &%require%& verb. For example:
28557 .code
28558     require  control = no_multiline_responses
28559 .endd
28560 .endlist
28561
28562 .vitem &*delay*&&~=&~<&'time'&>
28563 .cindex "&%delay%& ACL modifier"
28564 .oindex "&%-bh%&"
28565 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28566 the time interval before proceeding. However, when testing Exim using the
28567 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28568 output instead). The time is given in the usual Exim notation, and the delay
28569 happens as soon as the modifier is processed. In an SMTP session, pending
28570 output is flushed before the delay is imposed.
28571
28572 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28573 example:
28574 .code
28575 deny    ...some conditions...
28576         delay = 30s
28577 .endd
28578 The delay happens if all the conditions are true, before the statement returns
28579 &"deny"&. Compare this with:
28580 .code
28581 deny    delay = 30s
28582         ...some conditions...
28583 .endd
28584 which waits for 30s before processing the conditions. The &%delay%& modifier
28585 can also be used with &%warn%& and together with &%control%&:
28586 .code
28587 warn    ...some conditions...
28588         delay = 2m
28589         control = freeze
28590 accept  ...
28591 .endd
28592
28593 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28594 responses to several commands are no longer buffered and sent in one packet (as
28595 they would normally be) because all output is flushed before imposing the
28596 delay. This optimization is disabled so that a number of small delays do not
28597 appear to the client as one large aggregated delay that might provoke an
28598 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28599 using a &%control%& modifier to set &%no_delay_flush%&.
28600
28601
28602 .vitem &*endpass*&
28603 .cindex "&%endpass%& ACL modifier"
28604 This modifier, which has no argument, is recognized only in &%accept%& and
28605 &%discard%& statements. It marks the boundary between the conditions whose
28606 failure causes control to pass to the next statement, and the conditions whose
28607 failure causes the ACL to return &"deny"&. This concept has proved to be
28608 confusing to some people, so the use of &%endpass%& is no longer recommended as
28609 &"best practice"&. See the description of &%accept%& above for more details.
28610
28611
28612 .vitem &*log_message*&&~=&~<&'text'&>
28613 .cindex "&%log_message%& ACL modifier"
28614 This modifier sets up a message that is used as part of the log message if the
28615 ACL denies access or a &%warn%& statement's conditions are true. For example:
28616 .code
28617 require log_message = wrong cipher suite $tls_in_cipher
28618         encrypted   = DES-CBC3-SHA
28619 .endd
28620 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28621 example:
28622 .display
28623 &`discard `&<&'some conditions'&>
28624 &`        log_message = Discarded $local_part@$domain because...`&
28625 .endd
28626 When access is denied, &%log_message%& adds to any underlying error message
28627 that may exist because of a condition failure. For example, while verifying a
28628 recipient address, a &':fail:'& redirection might have already set up a
28629 message.
28630
28631 The message may be defined before the conditions to which it applies, because
28632 the string expansion does not happen until Exim decides that access is to be
28633 denied. This means that any variables that are set by the condition are
28634 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28635 variables are set after a DNS black list lookup succeeds. If the expansion of
28636 &%log_message%& fails, or if the result is an empty string, the modifier is
28637 ignored.
28638
28639 .vindex "&$acl_verify_message$&"
28640 If you want to use a &%warn%& statement to log the result of an address
28641 verification, you can use &$acl_verify_message$& to include the verification
28642 error message.
28643
28644 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28645 the start of the logged message. If the same warning log message is requested
28646 more than once while receiving  a single email message, only one copy is
28647 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28648 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28649 is logged for a successful &%warn%& statement.
28650
28651 If &%log_message%& is not present and there is no underlying error message (for
28652 example, from the failure of address verification), but &%message%& is present,
28653 the &%message%& text is used for logging rejections. However, if any text for
28654 logging contains newlines, only the first line is logged. In the absence of
28655 both &%log_message%& and &%message%&, a default built-in message is used for
28656 logging rejections.
28657
28658
28659 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28660 .cindex "&%log_reject_target%& ACL modifier"
28661 .cindex "logging in ACL" "specifying which log"
28662 This modifier makes it possible to specify which logs are used for messages
28663 about ACL rejections. Its argument is a colon-separated list of words that can
28664 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28665 may be empty, in which case a rejection is not logged at all. For example, this
28666 ACL fragment writes no logging information when access is denied:
28667 .display
28668 &`deny `&<&'some conditions'&>
28669 &`     log_reject_target =`&
28670 .endd
28671 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28672 permanent and temporary rejections. Its effect lasts for the rest of the
28673 current ACL.
28674
28675
28676 .vitem &*logwrite*&&~=&~<&'text'&>
28677 .cindex "&%logwrite%& ACL modifier"
28678 .cindex "logging in ACL" "immediate"
28679 This modifier writes a message to a log file as soon as it is encountered when
28680 processing an ACL. (Compare &%log_message%&, which, except in the case of
28681 &%warn%& and &%discard%&, is used only if the ACL statement denies
28682 access.) The &%logwrite%& modifier can be used to log special incidents in
28683 ACLs. For example:
28684 .display
28685 &`accept `&<&'some special conditions'&>
28686 &`       control  = freeze`&
28687 &`       logwrite = froze message because ...`&
28688 .endd
28689 By default, the message is written to the main log. However, it may begin
28690 with a colon, followed by a comma-separated list of log names, and then
28691 another colon, to specify exactly which logs are to be written. For
28692 example:
28693 .code
28694 logwrite = :main,reject: text for main and reject logs
28695 logwrite = :panic: text for panic log only
28696 .endd
28697
28698
28699 .vitem &*message*&&~=&~<&'text'&>
28700 .cindex "&%message%& ACL modifier"
28701 This modifier sets up a text string that is expanded and used as a response
28702 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28703 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28704 there is some complication if &%endpass%& is involved; see the description of
28705 &%accept%& for details.)
28706
28707 The expansion of the message happens at the time Exim decides that the ACL is
28708 to end, not at the time it processes &%message%&. If the expansion fails, or
28709 generates an empty string, the modifier is ignored. Here is an example where
28710 &%message%& must be specified first, because the ACL ends with a rejection if
28711 the &%hosts%& condition fails:
28712 .code
28713 require  message = Host not recognized
28714          hosts = 10.0.0.0/8
28715 .endd
28716 (Once a condition has failed, no further conditions or modifiers are
28717 processed.)
28718
28719 .cindex "SMTP" "error codes"
28720 .oindex "&%smtp_banner%&
28721 For ACLs that are triggered by SMTP commands, the message is returned as part
28722 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28723 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28724 is accepted. In the case of the connect ACL, accepting with a message modifier
28725 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28726 accept message may not contain more than one line (otherwise it will be
28727 truncated at the first newline and a panic logged), and it cannot affect the
28728 EHLO options.
28729
28730 When SMTP is involved, the message may begin with an overriding response code,
28731 consisting of three digits optionally followed by an &"extended response code"&
28732 of the form &'n.n.n'&, each code being followed by a space. For example:
28733 .code
28734 deny  message = 599 1.2.3 Host not welcome
28735       hosts = 192.168.34.0/24
28736 .endd
28737 The first digit of the supplied response code must be the same as would be sent
28738 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28739 access, but for the predata ACL, note that the default success code is 354, not
28740 2&'xx'&.
28741
28742 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28743 the message modifier cannot override the 221 response code.
28744
28745 The text in a &%message%& modifier is literal; any quotes are taken as
28746 literals, but because the string is expanded, backslash escapes are processed
28747 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28748 response.
28749
28750 .vindex "&$acl_verify_message$&"
28751 For ACLs that are called by an &%acl =%& ACL condition, the message is
28752 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28753
28754 If &%message%& is used on a statement that verifies an address, the message
28755 specified overrides any message that is generated by the verification process.
28756 However, the original message is available in the variable
28757 &$acl_verify_message$&, so you can incorporate it into your message if you
28758 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28759 routers to be passed back as part of the SMTP response, you should either not
28760 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28761
28762 For compatibility with previous releases of Exim, a &%message%& modifier that
28763 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28764 modifier, but this usage is now deprecated. However, &%message%& acts only when
28765 all the conditions are true, wherever it appears in an ACL command, whereas
28766 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28767 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28768 effect.
28769
28770
28771 .new
28772 .vitem &*queue*&&~=&~<&'text'&>
28773 This modifier specifies the use of a named queue for spool files
28774 for the message.
28775 It can only be used before the message is received (i.e. not in
28776 the DATA ACL).
28777 This could be used, for example, for known high-volume burst sources
28778 of traffic, or for quarantine of messages.
28779 Separate queue-runner processes will be needed for named queues.
28780 If the text after expansion is empty, the default queue is used.
28781 .wen
28782
28783
28784 .vitem &*remove_header*&&~=&~<&'text'&>
28785 This modifier specifies one or more header names in a colon-separated list
28786  that are to be removed from an incoming message, assuming, of course, that
28787 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28788
28789
28790 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28791 .cindex "&%set%& ACL modifier"
28792 This modifier puts a value into one of the ACL variables (see section
28793 &<<SECTaclvariables>>&).
28794
28795
28796 .vitem &*udpsend*&&~=&~<&'parameters'&>
28797 This modifier sends a UDP packet, for purposes such as statistics
28798 collection or behaviour monitoring. The parameters are expanded, and
28799 the result of the expansion must be a colon-separated list consisting
28800 of a destination server, port number, and the packet contents. The
28801 server can be specified as a host name or IPv4 or IPv6 address. The
28802 separator can be changed with the usual angle bracket syntax. For
28803 example, you might want to collect information on which hosts connect
28804 when:
28805 .code
28806 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28807              $tod_zulu $sender_host_address
28808 .endd
28809 .endlist
28810
28811
28812
28813
28814 .section "Use of the control modifier" "SECTcontrols"
28815 .cindex "&%control%& ACL modifier"
28816 The &%control%& modifier supports the following settings:
28817
28818 .vlist
28819 .vitem &*control&~=&~allow_auth_unadvertised*&
28820 This modifier allows a client host to use the SMTP AUTH command even when it
28821 has not been advertised in response to EHLO. Furthermore, because there are
28822 apparently some really broken clients that do this, Exim will accept AUTH after
28823 HELO (rather than EHLO) when this control is set. It should be used only if you
28824 really need it, and you should limit its use to those broken clients that do
28825 not work without it. For example:
28826 .code
28827 warn hosts   = 192.168.34.25
28828      control = allow_auth_unadvertised
28829 .endd
28830 Normally, when an Exim server receives an AUTH command, it checks the name of
28831 the authentication mechanism that is given in the command to ensure that it
28832 matches an advertised mechanism. When this control is set, the check that a
28833 mechanism has been advertised is bypassed. Any configured mechanism can be used
28834 by the client. This control is permitted only in the connection and HELO ACLs.
28835
28836
28837 .vitem &*control&~=&~caseful_local_part*& &&&
28838        &*control&~=&~caselower_local_part*&
28839 .cindex "&ACL;" "case of local part in"
28840 .cindex "case of local parts"
28841 .vindex "&$local_part$&"
28842 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28843 (that is, during RCPT processing). By default, the contents of &$local_part$&
28844 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28845 any uppercase letters in the original local part are restored in &$local_part$&
28846 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28847 is encountered.
28848
28849 These controls affect only the current recipient. Moreover, they apply only to
28850 local part handling that takes place directly in the ACL (for example, as a key
28851 in lookups). If a test to verify the recipient is obeyed, the case-related
28852 handling of the local part during the verification is controlled by the router
28853 configuration (see the &%caseful_local_part%& generic router option).
28854
28855 This facility could be used, for example, to add a spam score to local parts
28856 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28857 spam score:
28858 .code
28859 warn  control = caseful_local_part
28860       set acl_m4 = ${eval:\
28861                      $acl_m4 + \
28862                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28863                     }
28864       control = caselower_local_part
28865 .endd
28866 Notice that we put back the lower cased version afterwards, assuming that
28867 is what is wanted for subsequent tests.
28868
28869
28870 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
28871 .cindex "&ACL;" "cutthrough routing"
28872 .cindex "cutthrough" "requesting"
28873 This option requests delivery be attempted while the item is being received.
28874
28875 The option is usable in the RCPT ACL.
28876 If enabled for a message received via smtp and routed to an smtp transport,
28877 and only one transport, interface, destination host and port combination
28878 is used for all recipients of the message,
28879 then the delivery connection is made while the receiving connection is open
28880 and data is copied from one to the other.
28881
28882 An attempt to set this option for any recipient but the first
28883 for a mail will be quietly ignored.
28884 If a recipient-verify callout
28885 (with use_sender)
28886 connection is subsequently
28887 requested in the same ACL it is held open and used for
28888 any subsequent recipients and the data,
28889 otherwise one is made after the initial RCPT ACL completes.
28890
28891 Note that routers are used in verify mode,
28892 and cannot depend on content of received headers.
28893 Note also that headers cannot be
28894 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28895 Headers may be modified by routers (subject to the above) and transports.
28896
28897 All the usual ACLs are called; if one results in the message being
28898 rejected, all effort spent in delivery (including the costs on
28899 the ultimate destination) will be wasted.
28900 Note that in the case of data-time ACLs this includes the entire
28901 message body.
28902
28903 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28904 of outgoing messages is done, because it sends data to the ultimate destination
28905 before the entire message has been received from the source.
28906 It is not supported for messages received with the SMTP PRDR option in use.
28907
28908 Should the ultimate destination system positively accept or reject the mail,
28909 a corresponding indication is given to the source system and nothing is queued.
28910 If the item is successfully delivered in cutthrough mode
28911 the delivery log lines are tagged with ">>" rather than "=>" and appear
28912 before the acceptance "<=" line.
28913
28914 .new
28915 If there is a temporary error the item is queued for later delivery in the
28916 usual fashion.
28917 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
28918 to the control; the default value is &"spool"& and the alternate value
28919 &"pass"& copies an SMTP defer response from the target back to the initiator
28920 and does not queue the message.
28921 Note that this is independent of any receipient verify conditions in the ACL.
28922 .wen
28923
28924 Delivery in this mode avoids the generation of a bounce mail to a
28925 (possibly faked)
28926 sender when the destination system is doing content-scan based rejection.
28927
28928
28929 .vitem &*control&~=&~debug/*&<&'options'&>
28930 .cindex "&ACL;" "enabling debug logging"
28931 .cindex "debugging" "enabling from an ACL"
28932 This control turns on debug logging, almost as though Exim had been invoked
28933 with &`-d`&, with the output going to a new logfile, by default called
28934 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28935 may access any variables already defined.  The logging may be adjusted with
28936 the &'opts'& option, which takes the same values as the &`-d`& command-line
28937 option.
28938 .new
28939 Logging may be stopped, and the file removed, with the &'kill'& option.
28940 .wen
28941 Some examples (which depend on variables that don't exist in all
28942 contexts):
28943 .code
28944       control = debug
28945       control = debug/tag=.$sender_host_address
28946       control = debug/opts=+expand+acl
28947       control = debug/tag=.$message_exim_id/opts=+expand
28948       control = debug/kill
28949 .endd
28950
28951
28952 .vitem &*control&~=&~dkim_disable_verify*&
28953 .cindex "disable DKIM verify"
28954 .cindex "DKIM" "disable verify"
28955 This control turns off DKIM verification processing entirely.  For details on
28956 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28957
28958
28959 .vitem &*control&~=&~dscp/*&<&'value'&>
28960 .cindex "&ACL;" "setting DSCP value"
28961 .cindex "DSCP" "inbound"
28962 This option causes the DSCP value associated with the socket for the inbound
28963 connection to be adjusted to a given value, given as one of a number of fixed
28964 strings or to numeric value.
28965 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28966 Common values include &`throughput`&, &`mincost`&, and on newer systems
28967 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28968
28969 The outbound packets from Exim will be marked with this value in the header
28970 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28971 that these values will have any effect, not be stripped by networking
28972 equipment, or do much of anything without cooperation with your Network
28973 Engineer and those of all network operators between the source and destination.
28974
28975
28976 .vitem &*control&~=&~enforce_sync*& &&&
28977        &*control&~=&~no_enforce_sync*&
28978 .cindex "SMTP" "synchronization checking"
28979 .cindex "synchronization checking in SMTP"
28980 These controls make it possible to be selective about when SMTP synchronization
28981 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28982 state of the switch (it is true by default). See the description of this option
28983 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28984
28985 The effect of these two controls lasts for the remainder of the SMTP
28986 connection. They can appear in any ACL except the one for the non-SMTP
28987 messages. The most straightforward place to put them is in the ACL defined by
28988 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28989 before the first synchronization check. The expected use is to turn off the
28990 synchronization checks for badly-behaved hosts that you nevertheless need to
28991 work with.
28992
28993
28994 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28995 .cindex "fake defer"
28996 .cindex "defer, fake"
28997 This control works in exactly the same way as &%fakereject%& (described below)
28998 except that it causes an SMTP 450 response after the message data instead of a
28999 550 response. You must take care when using &%fakedefer%& because it causes the
29000 messages to be duplicated when the sender retries. Therefore, you should not
29001 use &%fakedefer%& if the message is to be delivered normally.
29002
29003 .vitem &*control&~=&~fakereject/*&<&'message'&>
29004 .cindex "fake rejection"
29005 .cindex "rejection, fake"
29006 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29007 words, only when an SMTP message is being received. If Exim accepts the
29008 message, instead the final 250 response, a 550 rejection message is sent.
29009 However, Exim proceeds to deliver the message as normal. The control applies
29010 only to the current message, not to any subsequent ones that may be received in
29011 the same SMTP connection.
29012
29013 The text for the 550 response is taken from the &%control%& modifier. If no
29014 message is supplied, the following is used:
29015 .code
29016 550-Your message has been rejected but is being
29017 550-kept for evaluation.
29018 550-If it was a legitimate message, it may still be
29019 550 delivered to the target recipient(s).
29020 .endd
29021 This facility should be used with extreme caution.
29022
29023 .vitem &*control&~=&~freeze*&
29024 .cindex "frozen messages" "forcing in ACL"
29025 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29026 other words, only when a message is being received. If the message is accepted,
29027 it is placed on Exim's queue and frozen. The control applies only to the
29028 current message, not to any subsequent ones that may be received in the same
29029 SMTP connection.
29030
29031 This modifier can optionally be followed by &`/no_tell`&. If the global option
29032 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29033 is told about the freezing), provided all the &*control=freeze*& modifiers that
29034 are obeyed for the current message have the &`/no_tell`& option.
29035
29036 .vitem &*control&~=&~no_delay_flush*&
29037 .cindex "SMTP" "output flushing, disabling for delay"
29038 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29039 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29040 use. This control, as long as it is encountered before the &%delay%& modifier,
29041 disables such output flushing.
29042
29043 .vitem &*control&~=&~no_callout_flush*&
29044 .cindex "SMTP" "output flushing, disabling for callout"
29045 Exim normally flushes SMTP output before performing a callout in an ACL, to
29046 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29047 use. This control, as long as it is encountered before the &%verify%& condition
29048 that causes the callout, disables such output flushing.
29049
29050 .vitem &*control&~=&~no_mbox_unspool*&
29051 This control is available when Exim is compiled with the content scanning
29052 extension. Content scanning may require a copy of the current message, or parts
29053 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29054 or spam scanner. Normally, such copies are deleted when they are no longer
29055 needed. If this control is set, the copies are not deleted. The control applies
29056 only to the current message, not to any subsequent ones that may be received in
29057 the same SMTP connection. It is provided for debugging purposes and is unlikely
29058 to be useful in production.
29059
29060 .vitem &*control&~=&~no_multiline_responses*&
29061 .cindex "multiline responses, suppressing"
29062 This control is permitted for any ACL except the one for non-SMTP messages.
29063 It seems that there are broken clients in use that cannot handle multiline
29064 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29065
29066 If this control is set, multiline SMTP responses from ACL rejections are
29067 suppressed. One way of doing this would have been to put out these responses as
29068 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29069 (&"use multiline responses for more"& it says &-- ha!), and some of the
29070 responses might get close to that. So this facility, which is after all only a
29071 sop to broken clients, is implemented by doing two very easy things:
29072
29073 .ilist
29074 Extra information that is normally output as part of a rejection caused by
29075 sender verification failure is omitted. Only the final line (typically &"sender
29076 verification failed"&) is sent.
29077 .next
29078 If a &%message%& modifier supplies a multiline response, only the first
29079 line is output.
29080 .endlist
29081
29082 The setting of the switch can, of course, be made conditional on the
29083 calling host. Its effect lasts until the end of the SMTP connection.
29084
29085 .vitem &*control&~=&~no_pipelining*&
29086 .cindex "PIPELINING" "suppressing advertising"
29087 This control turns off the advertising of the PIPELINING extension to SMTP in
29088 the current session. To be useful, it must be obeyed before Exim sends its
29089 response to an EHLO command. Therefore, it should normally appear in an ACL
29090 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29091 &%pipelining_advertise_hosts%&.
29092
29093 .vitem &*control&~=&~queue_only*&
29094 .oindex "&%queue_only%&"
29095 .cindex "queueing incoming messages"
29096 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29097 other words, only when a message is being received. If the message is accepted,
29098 it is placed on Exim's queue and left there for delivery by a subsequent queue
29099 runner. No immediate delivery process is started. In other words, it has the
29100 effect as the &%queue_only%& global option. However, the control applies only
29101 to the current message, not to any subsequent ones that may be received in the
29102 same SMTP connection.
29103
29104 .vitem &*control&~=&~submission/*&<&'options'&>
29105 .cindex "message" "submission"
29106 .cindex "submission mode"
29107 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29108 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29109 the current message is a submission from a local MUA. In this case, Exim
29110 operates in &"submission mode"&, and applies certain fixups to the message if
29111 necessary. For example, it adds a &'Date:'& header line if one is not present.
29112 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29113 late (the message has already been created).
29114
29115 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29116 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29117 submission mode; the available options for this control are described there.
29118 The control applies only to the current message, not to any subsequent ones
29119 that may be received in the same SMTP connection.
29120
29121 .vitem &*control&~=&~suppress_local_fixups*&
29122 .cindex "submission fixups, suppressing"
29123 This control applies to locally submitted (non TCP/IP) messages, and is the
29124 complement of &`control = submission`&. It disables the fixups that are
29125 normally applied to locally-submitted messages. Specifically:
29126
29127 .ilist
29128 Any &'Sender:'& header line is left alone (in this respect, it is a
29129 dynamic version of &%local_sender_retain%&).
29130 .next
29131 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29132 .next
29133 There is no check that &'From:'& corresponds to the actual sender.
29134 .endlist ilist
29135
29136 This control may be useful when a remotely-originated message is accepted,
29137 passed to some scanning program, and then re-submitted for delivery. It can be
29138 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29139 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29140 data is read.
29141
29142 &*Note:*& This control applies only to the current message, not to any others
29143 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29144
29145 .vitem &*control&~=&~utf8_downconvert*&
29146 This control enables conversion of UTF-8 in message addresses
29147 to a-label form.
29148 For details see &<<SECTi18nMTA>>&.
29149 .endlist vlist
29150
29151
29152 .section "Summary of message fixup control" "SECTsummesfix"
29153 All four possibilities for message fixups can be specified:
29154
29155 .ilist
29156 Locally submitted, fixups applied: the default.
29157 .next
29158 Locally submitted, no fixups applied: use
29159 &`control = suppress_local_fixups`&.
29160 .next
29161 Remotely submitted, no fixups applied: the default.
29162 .next
29163 Remotely submitted, fixups applied: use &`control = submission`&.
29164 .endlist
29165
29166
29167
29168 .section "Adding header lines in ACLs" "SECTaddheadacl"
29169 .cindex "header lines" "adding in an ACL"
29170 .cindex "header lines" "position of added lines"
29171 .cindex "&%add_header%& ACL modifier"
29172 The &%add_header%& modifier can be used to add one or more extra header lines
29173 to an incoming message, as in this example:
29174 .code
29175 warn dnslists = sbl.spamhaus.org : \
29176                 dialup.mail-abuse.org
29177      add_header = X-blacklisted-at: $dnslist_domain
29178 .endd
29179 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29180 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29181 receiving a message). The message must ultimately be accepted for
29182 &%add_header%& to have any significant effect. You can use &%add_header%& with
29183 any ACL verb, including &%deny%& (though this is potentially useful only in a
29184 RCPT ACL).
29185
29186 Headers will not be added to the message if the modifier is used in
29187 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29188
29189 Leading and trailing newlines are removed from
29190 the data for the &%add_header%& modifier; if it then
29191 contains one or more newlines that
29192 are not followed by a space or a tab, it is assumed to contain multiple header
29193 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29194 front of any line that is not a valid header line.
29195
29196 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29197 They are added to the message before processing the DATA and MIME ACLs.
29198 However, if an identical header line is requested more than once, only one copy
29199 is actually added to the message. Further header lines may be accumulated
29200 during the DATA and MIME ACLs, after which they are added to the message, again
29201 with duplicates suppressed. Thus, it is possible to add two identical header
29202 lines to an SMTP message, but only if one is added before DATA and one after.
29203 In the case of non-SMTP messages, new headers are accumulated during the
29204 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29205 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29206 are included in the entry that is written to the reject log.
29207
29208 .cindex "header lines" "added; visibility of"
29209 Header lines are not visible in string expansions
29210 of message headers
29211 until they are added to the
29212 message. It follows that header lines defined in the MAIL, RCPT, and predata
29213 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29214 header lines that are added by the DATA or MIME ACLs are not visible in those
29215 ACLs. Because of this restriction, you cannot use header lines as a way of
29216 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29217 this, you can use ACL variables, as described in section
29218 &<<SECTaclvariables>>&.
29219
29220 The list of headers yet to be added is given by the &%$headers_added%& variable.
29221
29222 The &%add_header%& modifier acts immediately as it is encountered during the
29223 processing of an ACL. Notice the difference between these two cases:
29224 .display
29225 &`accept add_header = ADDED: some text`&
29226 &`       `&<&'some condition'&>
29227
29228 &`accept `&<&'some condition'&>
29229 &`       add_header = ADDED: some text`&
29230 .endd
29231 In the first case, the header line is always added, whether or not the
29232 condition is true. In the second case, the header line is added only if the
29233 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29234 ACL statement. All those that are encountered before a condition fails are
29235 honoured.
29236
29237 .cindex "&%warn%& ACL verb"
29238 For compatibility with previous versions of Exim, a &%message%& modifier for a
29239 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29240 effect only if all the conditions are true, even if it appears before some of
29241 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29242 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29243 are present on a &%warn%& verb, both are processed according to their
29244 specifications.
29245
29246 By default, new header lines are added to a message at the end of the existing
29247 header lines. However, you can specify that any particular header line should
29248 be added right at the start (before all the &'Received:'& lines), immediately
29249 after the first block of &'Received:'& lines, or immediately before any line
29250 that is not a &'Received:'& or &'Resent-something:'& header.
29251
29252 This is done by specifying &":at_start:"&, &":after_received:"&, or
29253 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29254 header line, respectively. (Header text cannot start with a colon, as there has
29255 to be a header name first.) For example:
29256 .code
29257 warn add_header = \
29258        :after_received:X-My-Header: something or other...
29259 .endd
29260 If more than one header line is supplied in a single &%add_header%& modifier,
29261 each one is treated independently and can therefore be placed differently. If
29262 you add more than one line at the start, or after the Received: block, they end
29263 up in reverse order.
29264
29265 &*Warning*&: This facility currently applies only to header lines that are
29266 added in an ACL. It does NOT work for header lines that are added in a
29267 system filter or in a router or transport.
29268
29269
29270
29271 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29272 .cindex "header lines" "removing in an ACL"
29273 .cindex "header lines" "position of removed lines"
29274 .cindex "&%remove_header%& ACL modifier"
29275 The &%remove_header%& modifier can be used to remove one or more header lines
29276 from an incoming message, as in this example:
29277 .code
29278 warn   message        = Remove internal headers
29279        remove_header  = x-route-mail1 : x-route-mail2
29280 .endd
29281 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29282 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29283 receiving a message). The message must ultimately be accepted for
29284 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29285 with any ACL verb, including &%deny%&, though this is really not useful for
29286 any verb that doesn't result in a delivered message.
29287
29288 Headers will not be removed from the message if the modifier is used in
29289 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29290
29291 More than one header can be removed at the same time by using a colon separated
29292 list of header names. The header matching is case insensitive. Wildcards are
29293 not permitted, nor is list expansion performed, so you cannot use hostlists to
29294 create a list of headers, however both connection and message variable expansion
29295 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29296 .code
29297 warn   hosts           = +internal_hosts
29298        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29299 warn   message         = Remove internal headers
29300        remove_header   = $acl_c_ihdrs
29301 .endd
29302 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29303 They are removed from the message before processing the DATA and MIME ACLs.
29304 There is no harm in attempting to remove the same header twice nor is removing
29305 a non-existent header. Further header lines to be removed may be accumulated
29306 during the DATA and MIME ACLs, after which they are removed from the message,
29307 if present. In the case of non-SMTP messages, headers to be removed are
29308 accumulated during the non-SMTP ACLs, and are removed from the message after
29309 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29310 ACL, there really is no effect because there is no logging of what headers
29311 would have been removed.
29312
29313 .cindex "header lines" "removed; visibility of"
29314 Header lines are not visible in string expansions until the DATA phase when it
29315 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29316 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29317 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29318 this restriction, you cannot use header lines as a way of controlling data
29319 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29320 you should instead use ACL variables, as described in section
29321 &<<SECTaclvariables>>&.
29322
29323 The &%remove_header%& modifier acts immediately as it is encountered during the
29324 processing of an ACL. Notice the difference between these two cases:
29325 .display
29326 &`accept remove_header = X-Internal`&
29327 &`       `&<&'some condition'&>
29328
29329 &`accept `&<&'some condition'&>
29330 &`       remove_header = X-Internal`&
29331 .endd
29332 In the first case, the header line is always removed, whether or not the
29333 condition is true. In the second case, the header line is removed only if the
29334 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29335 same ACL statement. All those that are encountered before a condition fails
29336 are honoured.
29337
29338 &*Warning*&: This facility currently applies only to header lines that are
29339 present during ACL processing. It does NOT remove header lines that are added
29340 in a system filter or in a router or transport.
29341
29342
29343
29344
29345 .section "ACL conditions" "SECTaclconditions"
29346 .cindex "&ACL;" "conditions; list of"
29347 Some of the conditions listed in this section are available only when Exim is
29348 compiled with the content-scanning extension. They are included here briefly
29349 for completeness. More detailed descriptions can be found in the discussion on
29350 content scanning in chapter &<<CHAPexiscan>>&.
29351
29352 Not all conditions are relevant in all circumstances. For example, testing
29353 senders and recipients does not make sense in an ACL that is being run as the
29354 result of the arrival of an ETRN command, and checks on message headers can be
29355 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29356 can use the same condition (with different parameters) more than once in the
29357 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29358 The conditions are as follows:
29359
29360
29361 .vlist
29362 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29363 .cindex "&ACL;" "nested"
29364 .cindex "&ACL;" "indirect"
29365 .cindex "&ACL;" "arguments"
29366 .cindex "&%acl%& ACL condition"
29367 The possible values of the argument are the same as for the
29368 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29369 &"accept"& the condition is true; if it returns &"deny"& the condition is
29370 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29371 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29372 condition false. This means that further processing of the &%warn%& verb
29373 ceases, but processing of the ACL continues.
29374
29375 If the argument is a named ACL, up to nine space-separated optional values
29376 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29377 and $acl_narg is set to the count of values.
29378 Previous values of these variables are restored after the call returns.
29379 The name and values are expanded separately.
29380 Note that spaces in complex expansions which are used as arguments
29381 will act as argument separators.
29382
29383 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29384 the connection is dropped. If it returns &"discard"&, the verb must be
29385 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29386 conditions are tested.
29387
29388 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29389 loops. This condition allows you to use different ACLs in different
29390 circumstances. For example, different ACLs can be used to handle RCPT commands
29391 for different local users or different local domains.
29392
29393 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29394 .cindex "&%authenticated%& ACL condition"
29395 .cindex "authentication" "ACL checking"
29396 .cindex "&ACL;" "testing for authentication"
29397 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29398 the name of the authenticator is tested against the list. To test for
29399 authentication by any authenticator, you can set
29400 .code
29401 authenticated = *
29402 .endd
29403
29404 .vitem &*condition&~=&~*&<&'string'&>
29405 .cindex "&%condition%& ACL condition"
29406 .cindex "customizing" "ACL condition"
29407 .cindex "&ACL;" "customized test"
29408 .cindex "&ACL;" "testing, customized"
29409 This feature allows you to make up custom conditions. If the result of
29410 expanding the string is an empty string, the number zero, or one of the strings
29411 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29412 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29413 any other value, some error is assumed to have occurred, and the ACL returns
29414 &"defer"&. However, if the expansion is forced to fail, the condition is
29415 ignored. The effect is to treat it as true, whether it is positive or
29416 negative.
29417
29418 .vitem &*decode&~=&~*&<&'location'&>
29419 .cindex "&%decode%& ACL condition"
29420 This condition is available only when Exim is compiled with the
29421 content-scanning extension, and it is allowed only in the ACL defined by
29422 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29423 If all goes well, the condition is true. It is false only if there are
29424 problems such as a syntax error or a memory shortage. For more details, see
29425 chapter &<<CHAPexiscan>>&.
29426
29427 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29428 .cindex "&%dnslists%& ACL condition"
29429 .cindex "DNS list" "in ACL"
29430 .cindex "black list (DNS)"
29431 .cindex "&ACL;" "testing a DNS list"
29432 This condition checks for entries in DNS black lists. These are also known as
29433 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29434 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29435 different variants of this condition to describe briefly here. See sections
29436 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29437
29438 .vitem &*domains&~=&~*&<&'domain&~list'&>
29439 .cindex "&%domains%& ACL condition"
29440 .cindex "domain" "ACL checking"
29441 .cindex "&ACL;" "testing a recipient domain"
29442 .vindex "&$domain_data$&"
29443 This condition is relevant only after a RCPT command. It checks that the domain
29444 of the recipient address is in the domain list. If percent-hack processing is
29445 enabled, it is done before this test is done. If the check succeeds with a
29446 lookup, the result of the lookup is placed in &$domain_data$& until the next
29447 &%domains%& test.
29448
29449 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29450 use &%domains%& in a DATA ACL.
29451
29452
29453 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29454 .cindex "&%encrypted%& ACL condition"
29455 .cindex "encryption" "checking in an ACL"
29456 .cindex "&ACL;" "testing for encryption"
29457 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29458 name of the cipher suite in use is tested against the list. To test for
29459 encryption without testing for any specific cipher suite(s), set
29460 .code
29461 encrypted = *
29462 .endd
29463
29464
29465 .vitem &*hosts&~=&~*&<&'host&~list'&>
29466 .cindex "&%hosts%& ACL condition"
29467 .cindex "host" "ACL checking"
29468 .cindex "&ACL;" "testing the client host"
29469 This condition tests that the calling host matches the host list. If you have
29470 name lookups or wildcarded host names and IP addresses in the same host list,
29471 you should normally put the IP addresses first. For example, you could have:
29472 .code
29473 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29474 .endd
29475 The lookup in this example uses the host name for its key. This is implied by
29476 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29477 and it wouldn't matter which way round you had these two items.)
29478
29479 The reason for the problem with host names lies in the left-to-right way that
29480 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29481 but when it reaches an item that requires a host name, it fails if it cannot
29482 find a host name to compare with the pattern. If the above list is given in the
29483 opposite order, the &%accept%& statement fails for a host whose name cannot be
29484 found, even if its IP address is 10.9.8.7.
29485
29486 If you really do want to do the name check first, and still recognize the IP
29487 address even if the name lookup fails, you can rewrite the ACL like this:
29488 .code
29489 accept hosts = dbm;/etc/friendly/hosts
29490 accept hosts = 10.9.8.7
29491 .endd
29492 The default action on failing to find the host name is to assume that the host
29493 is not in the list, so the first &%accept%& statement fails. The second
29494 statement can then check the IP address.
29495
29496 .vindex "&$host_data$&"
29497 If a &%hosts%& condition is satisfied by means of a lookup, the result
29498 of the lookup is made available in the &$host_data$& variable. This
29499 allows you, for example, to set up a statement like this:
29500 .code
29501 deny  hosts = net-lsearch;/some/file
29502 message = $host_data
29503 .endd
29504 which gives a custom error message for each denied host.
29505
29506 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29507 .cindex "&%local_parts%& ACL condition"
29508 .cindex "local part" "ACL checking"
29509 .cindex "&ACL;" "testing a local part"
29510 .vindex "&$local_part_data$&"
29511 This condition is relevant only after a RCPT command. It checks that the local
29512 part of the recipient address is in the list. If percent-hack processing is
29513 enabled, it is done before this test. If the check succeeds with a lookup, the
29514 result of the lookup is placed in &$local_part_data$&, which remains set until
29515 the next &%local_parts%& test.
29516
29517 .vitem &*malware&~=&~*&<&'option'&>
29518 .cindex "&%malware%& ACL condition"
29519 .cindex "&ACL;" "virus scanning"
29520 .cindex "&ACL;" "scanning for viruses"
29521 This condition is available only when Exim is compiled with the
29522 content-scanning extension. It causes the incoming message to be scanned for
29523 viruses. For details, see chapter &<<CHAPexiscan>>&.
29524
29525 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29526 .cindex "&%mime_regex%& ACL condition"
29527 .cindex "&ACL;" "testing by regex matching"
29528 This condition is available only when Exim is compiled with the
29529 content-scanning extension, and it is allowed only in the ACL defined by
29530 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29531 with any of the regular expressions. For details, see chapter
29532 &<<CHAPexiscan>>&.
29533
29534 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29535 .cindex "rate limiting"
29536 This condition can be used to limit the rate at which a user or host submits
29537 messages. Details are given in section &<<SECTratelimiting>>&.
29538
29539 .vitem &*recipients&~=&~*&<&'address&~list'&>
29540 .cindex "&%recipients%& ACL condition"
29541 .cindex "recipient" "ACL checking"
29542 .cindex "&ACL;" "testing a recipient"
29543 This condition is relevant only after a RCPT command. It checks the entire
29544 recipient address against a list of recipients.
29545
29546 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29547 .cindex "&%regex%& ACL condition"
29548 .cindex "&ACL;" "testing by regex matching"
29549 This condition is available only when Exim is compiled with the
29550 content-scanning extension, and is available only in the DATA, MIME, and
29551 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29552 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29553
29554 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29555 .cindex "&%sender_domains%& ACL condition"
29556 .cindex "sender" "ACL checking"
29557 .cindex "&ACL;" "testing a sender domain"
29558 .vindex "&$domain$&"
29559 .vindex "&$sender_address_domain$&"
29560 This condition tests the domain of the sender of the message against the given
29561 domain list. &*Note*&: The domain of the sender address is in
29562 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29563 of this condition. This is an exception to the general rule for testing domain
29564 lists. It is done this way so that, if this condition is used in an ACL for a
29565 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29566 influence the sender checking.
29567
29568 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29569 relaying, because sender addresses are easily, and commonly, forged.
29570
29571 .vitem &*senders&~=&~*&<&'address&~list'&>
29572 .cindex "&%senders%& ACL condition"
29573 .cindex "sender" "ACL checking"
29574 .cindex "&ACL;" "testing a sender"
29575 This condition tests the sender of the message against the given list. To test
29576 for a bounce message, which has an empty sender, set
29577 .code
29578 senders = :
29579 .endd
29580 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29581 relaying, because sender addresses are easily, and commonly, forged.
29582
29583 .vitem &*spam&~=&~*&<&'username'&>
29584 .cindex "&%spam%& ACL condition"
29585 .cindex "&ACL;" "scanning for spam"
29586 This condition is available only when Exim is compiled with the
29587 content-scanning extension. It causes the incoming message to be scanned by
29588 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29589
29590 .vitem &*verify&~=&~certificate*&
29591 .cindex "&%verify%& ACL condition"
29592 .cindex "TLS" "client certificate verification"
29593 .cindex "certificate" "verification of client"
29594 .cindex "&ACL;" "certificate verification"
29595 .cindex "&ACL;" "testing a TLS certificate"
29596 This condition is true in an SMTP session if the session is encrypted, and a
29597 certificate was received from the client, and the certificate was verified. The
29598 server requests a certificate only if the client matches &%tls_verify_hosts%&
29599 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29600
29601 .vitem &*verify&~=&~csa*&
29602 .cindex "CSA verification"
29603 This condition checks whether the sending host (the client) is authorized to
29604 send email. Details of how this works are given in section
29605 &<<SECTverifyCSA>>&.
29606
29607 .vitem &*verify&~=&~header_names_ascii*&
29608 .cindex "&%verify%& ACL condition"
29609 .cindex "&ACL;" "verifying header names only ASCII"
29610 .cindex "header lines" "verifying header names only ASCII"
29611 .cindex "verifying" "header names only ASCII"
29612 This condition is relevant only in an ACL that is run after a message has been
29613 received, that is, in an ACL specified by &%acl_smtp_data%& or
29614 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29615 there are no non-ASCII characters, also excluding control characters.  The
29616 allowable characters are decimal ASCII values 33 through 126.
29617
29618 Exim itself will handle headers with non-ASCII characters, but it can cause
29619 problems for downstream applications, so this option will allow their
29620 detection and rejection in the DATA ACL's.
29621
29622 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29623 .cindex "&%verify%& ACL condition"
29624 .cindex "&ACL;" "verifying sender in the header"
29625 .cindex "header lines" "verifying the sender in"
29626 .cindex "sender" "verifying in header"
29627 .cindex "verifying" "sender in header"
29628 This condition is relevant only in an ACL that is run after a message has been
29629 received, that is, in an ACL specified by &%acl_smtp_data%& or
29630 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29631 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29632 is loosely thought of as a &"sender"& address (hence the name of the test).
29633 However, an address that appears in one of these headers need not be an address
29634 that accepts bounce messages; only sender addresses in envelopes are required
29635 to accept bounces. Therefore, if you use the callout option on this check, you
29636 might want to arrange for a non-empty address in the MAIL command.
29637
29638 Details of address verification and the options are given later, starting at
29639 section &<<SECTaddressverification>>& (callouts are described in section
29640 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29641 condition to restrict it to bounce messages only:
29642 .code
29643 deny    senders = :
29644         message = A valid sender header is required for bounces
29645        !verify  = header_sender
29646 .endd
29647
29648 .vitem &*verify&~=&~header_syntax*&
29649 .cindex "&%verify%& ACL condition"
29650 .cindex "&ACL;" "verifying header syntax"
29651 .cindex "header lines" "verifying syntax"
29652 .cindex "verifying" "header syntax"
29653 This condition is relevant only in an ACL that is run after a message has been
29654 received, that is, in an ACL specified by &%acl_smtp_data%& or
29655 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29656 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29657 and &'Bcc:'&), returning true if there are no problems.
29658 Unqualified addresses (local parts without domains) are
29659 permitted only in locally generated messages and from hosts that match
29660 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29661 appropriate.
29662
29663 Note that this condition is a syntax check only. However, a common spamming
29664 ploy used to be to send syntactically invalid headers such as
29665 .code
29666 To: @
29667 .endd
29668 and this condition can be used to reject such messages, though they are not as
29669 common as they used to be.
29670
29671 .vitem &*verify&~=&~helo*&
29672 .cindex "&%verify%& ACL condition"
29673 .cindex "&ACL;" "verifying HELO/EHLO"
29674 .cindex "HELO" "verifying"
29675 .cindex "EHLO" "verifying"
29676 .cindex "verifying" "EHLO"
29677 .cindex "verifying" "HELO"
29678 This condition is true if a HELO or EHLO command has been received from the
29679 client host, and its contents have been verified. If there has been no previous
29680 attempt to verify the HELO/EHLO contents, it is carried out when this
29681 condition is encountered. See the description of the &%helo_verify_hosts%& and
29682 &%helo_try_verify_hosts%& options for details of how to request verification
29683 independently of this condition.
29684
29685 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29686 option), this condition is always true.
29687
29688
29689 .vitem &*verify&~=&~not_blind*&
29690 .cindex "verifying" "not blind"
29691 .cindex "bcc recipients, verifying none"
29692 This condition checks that there are no blind (bcc) recipients in the message.
29693 Every envelope recipient must appear either in a &'To:'& header line or in a
29694 &'Cc:'& header line for this condition to be true. Local parts are checked
29695 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29696 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29697 used only in a DATA or non-SMTP ACL.
29698
29699 There are, of course, many legitimate messages that make use of blind (bcc)
29700 recipients. This check should not be used on its own for blocking messages.
29701
29702
29703 .vitem &*verify&~=&~recipient/*&<&'options'&>
29704 .cindex "&%verify%& ACL condition"
29705 .cindex "&ACL;" "verifying recipient"
29706 .cindex "recipient" "verifying"
29707 .cindex "verifying" "recipient"
29708 .vindex "&$address_data$&"
29709 This condition is relevant only after a RCPT command. It verifies the current
29710 recipient. Details of address verification are given later, starting at section
29711 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29712 of &$address_data$& is the last value that was set while routing the address.
29713 This applies even if the verification fails. When an address that is being
29714 verified is redirected to a single address, verification continues with the new
29715 address, and in that case, the subsequent value of &$address_data$& is the
29716 value for the child address.
29717
29718 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29719 .cindex "&%verify%& ACL condition"
29720 .cindex "&ACL;" "verifying host reverse lookup"
29721 .cindex "host" "verifying reverse lookup"
29722 This condition ensures that a verified host name has been looked up from the IP
29723 address of the client host. (This may have happened already if the host name
29724 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29725 Verification ensures that the host name obtained from a reverse DNS lookup, or
29726 one of its aliases, does, when it is itself looked up in the DNS, yield the
29727 original IP address.
29728
29729 There is one possible option, &`defer_ok`&.  If this is present and a
29730 DNS operation returns a temporary error, the verify condition succeeds.
29731
29732 If this condition is used for a locally generated message (that is, when there
29733 is no client host involved), it always succeeds.
29734
29735 .vitem &*verify&~=&~sender/*&<&'options'&>
29736 .cindex "&%verify%& ACL condition"
29737 .cindex "&ACL;" "verifying sender"
29738 .cindex "sender" "verifying"
29739 .cindex "verifying" "sender"
29740 This condition is relevant only after a MAIL or RCPT command, or after a
29741 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29742 the message's sender is empty (that is, this is a bounce message), the
29743 condition is true. Otherwise, the sender address is verified.
29744
29745 .vindex "&$address_data$&"
29746 .vindex "&$sender_address_data$&"
29747 If there is data in the &$address_data$& variable at the end of routing, its
29748 value is placed in &$sender_address_data$& at the end of verification. This
29749 value can be used in subsequent conditions and modifiers in the same ACL
29750 statement. It does not persist after the end of the current statement. If you
29751 want to preserve the value for longer, you can save it in an ACL variable.
29752
29753 Details of verification are given later, starting at section
29754 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29755 to avoid doing it more than once per message.
29756
29757 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29758 .cindex "&%verify%& ACL condition"
29759 This is a variation of the previous option, in which a modified address is
29760 verified as a sender.
29761 .endlist
29762
29763
29764
29765 .section "Using DNS lists" "SECTmorednslists"
29766 .cindex "DNS list" "in ACL"
29767 .cindex "black list (DNS)"
29768 .cindex "&ACL;" "testing a DNS list"
29769 In its simplest form, the &%dnslists%& condition tests whether the calling host
29770 is on at least one of a number of DNS lists by looking up the inverted IP
29771 address in one or more DNS domains. (Note that DNS list domains are not mail
29772 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29773 special options instead.) For example, if the calling host's IP
29774 address is 192.168.62.43, and the ACL statement is
29775 .code
29776 deny dnslists = blackholes.mail-abuse.org : \
29777                 dialups.mail-abuse.org
29778 .endd
29779 the following records are looked up:
29780 .code
29781 43.62.168.192.blackholes.mail-abuse.org
29782 43.62.168.192.dialups.mail-abuse.org
29783 .endd
29784 As soon as Exim finds an existing DNS record, processing of the list stops.
29785 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29786 to test that a host is on more than one list (an &"and"& conjunction), you can
29787 use two separate conditions:
29788 .code
29789 deny dnslists = blackholes.mail-abuse.org
29790      dnslists = dialups.mail-abuse.org
29791 .endd
29792 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29793 behaves as if the host does not match the list item, that is, as if the DNS
29794 record does not exist. If there are further items in the DNS list, they are
29795 processed.
29796
29797 This is usually the required action when &%dnslists%& is used with &%deny%&
29798 (which is the most common usage), because it prevents a DNS failure from
29799 blocking mail. However, you can change this behaviour by putting one of the
29800 following special items in the list:
29801 .display
29802 &`+include_unknown `&   behave as if the item is on the list
29803 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29804 &`+defer_unknown   `&   give a temporary error
29805 .endd
29806 .cindex "&`+include_unknown`&"
29807 .cindex "&`+exclude_unknown`&"
29808 .cindex "&`+defer_unknown`&"
29809 Each of these applies to any subsequent items on the list. For example:
29810 .code
29811 deny dnslists = +defer_unknown : foo.bar.example
29812 .endd
29813 Testing the list of domains stops as soon as a match is found. If you want to
29814 warn for one list and block for another, you can use two different statements:
29815 .code
29816 deny  dnslists = blackholes.mail-abuse.org
29817 warn  message  = X-Warn: sending host is on dialups list
29818       dnslists = dialups.mail-abuse.org
29819 .endd
29820 .cindex cacheing "of dns lookup"
29821 .cindex DNS TTL
29822 DNS list lookups are cached by Exim for the duration of the SMTP session
29823 (but limited by the DNS return TTL value),
29824 so a lookup based on the IP address is done at most once for any incoming
29825 connection (assuming long-enough TTL).
29826 Exim does not share information between multiple incoming
29827 connections (but your local name server cache should be active).
29828
29829
29830
29831 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29832 .cindex "DNS list" "keyed by explicit IP address"
29833 By default, the IP address that is used in a DNS list lookup is the IP address
29834 of the calling host. However, you can specify another IP address by listing it
29835 after the domain name, introduced by a slash. For example:
29836 .code
29837 deny dnslists = black.list.tld/192.168.1.2
29838 .endd
29839 This feature is not very helpful with explicit IP addresses; it is intended for
29840 use with IP addresses that are looked up, for example, the IP addresses of the
29841 MX hosts or nameservers of an email sender address. For an example, see section
29842 &<<SECTmulkeyfor>>& below.
29843
29844
29845
29846
29847 .section "DNS lists keyed on domain names" "SECID202"
29848 .cindex "DNS list" "keyed by domain name"
29849 There are some lists that are keyed on domain names rather than inverted IP
29850 addresses (see for example the &'domain based zones'& link at
29851 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29852 with these lists. You can change the name that is looked up in a DNS list by
29853 listing it after the domain name, introduced by a slash. For example,
29854 .code
29855 deny  message  = Sender's domain is listed at $dnslist_domain
29856       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29857 .endd
29858 This particular example is useful only in ACLs that are obeyed after the
29859 RCPT or DATA commands, when a sender address is available. If (for
29860 example) the message's sender is &'user@tld.example'& the name that is looked
29861 up by this example is
29862 .code
29863 tld.example.dsn.rfc-ignorant.org
29864 .endd
29865 A single &%dnslists%& condition can contain entries for both names and IP
29866 addresses. For example:
29867 .code
29868 deny dnslists = sbl.spamhaus.org : \
29869                 dsn.rfc-ignorant.org/$sender_address_domain
29870 .endd
29871 The first item checks the sending host's IP address; the second checks a domain
29872 name. The whole condition is true if either of the DNS lookups succeeds.
29873
29874
29875
29876
29877 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29878 .cindex "DNS list" "multiple keys for"
29879 The syntax described above for looking up explicitly-defined values (either
29880 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29881 name for the DNS list, what follows the slash can in fact be a list of items.
29882 As with all lists in Exim, the default separator is a colon. However, because
29883 this is a sublist within the list of DNS blacklist domains, it is necessary
29884 either to double the separators like this:
29885 .code
29886 dnslists = black.list.tld/name.1::name.2
29887 .endd
29888 or to change the separator character, like this:
29889 .code
29890 dnslists = black.list.tld/<;name.1;name.2
29891 .endd
29892 If an item in the list is an IP address, it is inverted before the DNS
29893 blacklist domain is appended. If it is not an IP address, no inversion
29894 occurs. Consider this condition:
29895 .code
29896 dnslists = black.list.tld/<;192.168.1.2;a.domain
29897 .endd
29898 The DNS lookups that occur are:
29899 .code
29900 2.1.168.192.black.list.tld
29901 a.domain.black.list.tld
29902 .endd
29903 Once a DNS record has been found (that matches a specific IP return
29904 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29905 are done. If there is a temporary DNS error, the rest of the sublist of domains
29906 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29907 only if no other DNS lookup in this sublist succeeds. In other words, a
29908 successful lookup for any of the items in the sublist overrides a temporary
29909 error for a previous item.
29910
29911 The ability to supply a list of items after the slash is in some sense just a
29912 syntactic convenience. These two examples have the same effect:
29913 .code
29914 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29915 dnslists = black.list.tld/a.domain::b.domain
29916 .endd
29917 However, when the data for the list is obtained from a lookup, the second form
29918 is usually much more convenient. Consider this example:
29919 .code
29920 deny message  = The mail servers for the domain \
29921                 $sender_address_domain \
29922                 are listed at $dnslist_domain ($dnslist_value); \
29923                 see $dnslist_text.
29924      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29925                                    ${lookup dnsdb {>|mxh=\
29926                                    $sender_address_domain} }} }
29927 .endd
29928 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29929 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29930 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29931 of expanding the condition might be something like this:
29932 .code
29933 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29934 .endd
29935 Thus, this example checks whether or not the IP addresses of the sender
29936 domain's mail servers are on the Spamhaus black list.
29937
29938 The key that was used for a successful DNS list lookup is put into the variable
29939 &$dnslist_matched$& (see section &<<SECID204>>&).
29940
29941
29942
29943
29944 .section "Data returned by DNS lists" "SECID203"
29945 .cindex "DNS list" "data returned from"
29946 DNS lists are constructed using address records in the DNS. The original RBL
29947 just used the address 127.0.0.1 on the right hand side of each record, but the
29948 RBL+ list and some other lists use a number of values with different meanings.
29949 The values used on the RBL+ list are:
29950 .display
29951 127.1.0.1  RBL
29952 127.1.0.2  DUL
29953 127.1.0.3  DUL and RBL
29954 127.1.0.4  RSS
29955 127.1.0.5  RSS and RBL
29956 127.1.0.6  RSS and DUL
29957 127.1.0.7  RSS and DUL and RBL
29958 .endd
29959 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29960 different values. Some DNS lists may return more than one address record;
29961 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29962
29963
29964 .section "Variables set from DNS lists" "SECID204"
29965 .cindex "expansion" "variables, set from DNS list"
29966 .cindex "DNS list" "variables set from"
29967 .vindex "&$dnslist_domain$&"
29968 .vindex "&$dnslist_matched$&"
29969 .vindex "&$dnslist_text$&"
29970 .vindex "&$dnslist_value$&"
29971 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29972 the name of the overall domain that matched (for example,
29973 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29974 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29975 the DNS record. When the key is an IP address, it is not reversed in
29976 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29977 cases, for example:
29978 .code
29979 deny dnslists = spamhaus.example
29980 .endd
29981 the key is also available in another variable (in this case,
29982 &$sender_host_address$&). In more complicated cases, however, this is not true.
29983 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29984 might generate a dnslists lookup like this:
29985 .code
29986 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29987 .endd
29988 If this condition succeeds, the value in &$dnslist_matched$& might be
29989 &`192.168.6.7`& (for example).
29990
29991 If more than one address record is returned by the DNS lookup, all the IP
29992 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29993 The variable &$dnslist_text$& contains the contents of any associated TXT
29994 record. For lists such as RBL+ the TXT record for a merged entry is often not
29995 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29996 information.
29997
29998 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29999 &-- although these appear before the condition in the ACL, they are not
30000 expanded until after it has failed. For example:
30001 .code
30002 deny    hosts = !+local_networks
30003         message = $sender_host_address is listed \
30004                   at $dnslist_domain
30005         dnslists = rbl-plus.mail-abuse.example
30006 .endd
30007
30008
30009
30010 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30011 .cindex "DNS list" "matching specific returned data"
30012 You can add an equals sign and an IP address after a &%dnslists%& domain name
30013 in order to restrict its action to DNS records with a matching right hand side.
30014 For example,
30015 .code
30016 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30017 .endd
30018 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30019 any address record is considered to be a match. For the moment, we assume
30020 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30021 describes how multiple records are handled.
30022
30023 More than one IP address may be given for checking, using a comma as a
30024 separator. These are alternatives &-- if any one of them matches, the
30025 &%dnslists%& condition is true. For example:
30026 .code
30027 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30028 .endd
30029 If you want to specify a constraining address list and also specify names or IP
30030 addresses to be looked up, the constraining address list must be specified
30031 first. For example:
30032 .code
30033 deny dnslists = dsn.rfc-ignorant.org\
30034                 =127.0.0.2/$sender_address_domain
30035 .endd
30036
30037 If the character &`&&`& is used instead of &`=`&, the comparison for each
30038 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30039 In other words, the listed addresses are used as bit masks. The comparison is
30040 true if all the bits in the mask are present in the address that is being
30041 tested. For example:
30042 .code
30043 dnslists = a.b.c&0.0.0.3
30044 .endd
30045 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30046 want to test whether one bit or another bit is present (as opposed to both
30047 being present), you must use multiple values. For example:
30048 .code
30049 dnslists = a.b.c&0.0.0.1,0.0.0.2
30050 .endd
30051 matches if the final component of the address is an odd number or two times
30052 an odd number.
30053
30054
30055
30056 .section "Negated DNS matching conditions" "SECID205"
30057 You can supply a negative list of IP addresses as part of a &%dnslists%&
30058 condition. Whereas
30059 .code
30060 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30061 .endd
30062 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30063 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30064 .code
30065 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30066 .endd
30067 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30068 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30069 words, the result of the test is inverted if an exclamation mark appears before
30070 the &`=`& (or the &`&&`&) sign.
30071
30072 &*Note*&: This kind of negation is not the same as negation in a domain,
30073 host, or address list (which is why the syntax is different).
30074
30075 If you are using just one list, the negation syntax does not gain you much. The
30076 previous example is precisely equivalent to
30077 .code
30078 deny  dnslists = a.b.c
30079      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30080 .endd
30081 However, if you are using multiple lists, the negation syntax is clearer.
30082 Consider this example:
30083 .code
30084 deny  dnslists = sbl.spamhaus.org : \
30085                  list.dsbl.org : \
30086                  dnsbl.njabl.org!=127.0.0.3 : \
30087                  relays.ordb.org
30088 .endd
30089 Using only positive lists, this would have to be:
30090 .code
30091 deny  dnslists = sbl.spamhaus.org : \
30092                  list.dsbl.org
30093 deny  dnslists = dnsbl.njabl.org
30094      !dnslists = dnsbl.njabl.org=127.0.0.3
30095 deny  dnslists = relays.ordb.org
30096 .endd
30097 which is less clear, and harder to maintain.
30098
30099
30100
30101
30102 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30103 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30104 thereby providing more than one IP address. When an item in a &%dnslists%& list
30105 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30106 the match to specific results from the DNS lookup, there are two ways in which
30107 the checking can be handled. For example, consider the condition:
30108 .code
30109 dnslists = a.b.c=127.0.0.1
30110 .endd
30111 What happens if the DNS lookup for the incoming IP address yields both
30112 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30113 condition true because at least one given value was found, or is it false
30114 because at least one of the found values was not listed? And how does this
30115 affect negated conditions? Both possibilities are provided for with the help of
30116 additional separators &`==`& and &`=&&`&.
30117
30118 .ilist
30119 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30120 IP addresses matches one of the listed addresses. For the example above, the
30121 condition is true because 127.0.0.1 matches.
30122 .next
30123 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30124 looked up IP addresses matches one of the listed addresses. If the condition is
30125 changed to:
30126 .code
30127 dnslists = a.b.c==127.0.0.1
30128 .endd
30129 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30130 false because 127.0.0.2 is not listed. You would need to have:
30131 .code
30132 dnslists = a.b.c==127.0.0.1,127.0.0.2
30133 .endd
30134 for the condition to be true.
30135 .endlist
30136
30137 When &`!`& is used to negate IP address matching, it inverts the result, giving
30138 the precise opposite of the behaviour above. Thus:
30139 .ilist
30140 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30141 addresses matches one of the listed addresses. Consider:
30142 .code
30143 dnslists = a.b.c!&0.0.0.1
30144 .endd
30145 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30146 false because 127.0.0.1 matches.
30147 .next
30148 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30149 looked up IP address that does not match. Consider:
30150 .code
30151 dnslists = a.b.c!=&0.0.0.1
30152 .endd
30153 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30154 true, because 127.0.0.2 does not match. You would need to have:
30155 .code
30156 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30157 .endd
30158 for the condition to be false.
30159 .endlist
30160 When the DNS lookup yields only a single IP address, there is no difference
30161 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30162
30163
30164
30165
30166 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30167 .cindex "DNS list" "information from merged"
30168 When the facility for restricting the matching IP values in a DNS list is used,
30169 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30170 the true reason for rejection. This happens when lists are merged and the IP
30171 address in the A record is used to distinguish them; unfortunately there is
30172 only one TXT record. One way round this is not to use merged lists, but that
30173 can be inefficient because it requires multiple DNS lookups where one would do
30174 in the vast majority of cases when the host of interest is not on any of the
30175 lists.
30176
30177 A less inefficient way of solving this problem is available. If
30178 two domain names, comma-separated, are given, the second is used first to
30179 do an initial check, making use of any IP value restrictions that are set.
30180 If there is a match, the first domain is used, without any IP value
30181 restrictions, to get the TXT record. As a byproduct of this, there is also
30182 a check that the IP being tested is indeed on the first list. The first
30183 domain is the one that is put in &$dnslist_domain$&. For example:
30184 .code
30185 reject message  = \
30186          rejected because $sender_host_address is blacklisted \
30187          at $dnslist_domain\n$dnslist_text
30188        dnslists = \
30189          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30190          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30191 .endd
30192 For the first blacklist item, this starts by doing a lookup in
30193 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30194 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30195 value, and as long as something is found, it looks for the corresponding TXT
30196 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30197 The second blacklist item is processed similarly.
30198
30199 If you are interested in more than one merged list, the same list must be
30200 given several times, but because the results of the DNS lookups are cached,
30201 the DNS calls themselves are not repeated. For example:
30202 .code
30203 reject dnslists = \
30204          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30205          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30206          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30207          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30208 .endd
30209 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30210 values matches (or if no record is found), this is the only lookup that is
30211 done. Only if there is a match is one of the more specific lists consulted.
30212
30213
30214
30215 .section "DNS lists and IPv6" "SECTmorednslistslast"
30216 .cindex "IPv6" "DNS black lists"
30217 .cindex "DNS list" "IPv6 usage"
30218 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30219 nibble by nibble. For example, if the calling host's IP address is
30220 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30221 .code
30222 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30223   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30224 .endd
30225 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30226 lists contain wildcard records, intended for IPv4, that interact badly with
30227 IPv6. For example, the DNS entry
30228 .code
30229 *.3.some.list.example.    A    127.0.0.1
30230 .endd
30231 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30232 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30233
30234 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30235 &%condition%& condition, as in this example:
30236 .code
30237 deny   condition = ${if isip4{$sender_host_address}}
30238        dnslists  = some.list.example
30239 .endd
30240
30241 If an explicit key is being used for a DNS lookup and it may be an IPv6
30242 address you should specify alternate list separators for both the outer
30243 (DNS list name) list and inner (lookup keys) list:
30244 .code
30245        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30246 .endd
30247
30248 .section "Rate limiting incoming messages" "SECTratelimiting"
30249 .cindex "rate limiting" "client sending"
30250 .cindex "limiting client sending rates"
30251 .oindex "&%smtp_ratelimit_*%&"
30252 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30253 which clients can send email. This is more powerful than the
30254 &%smtp_ratelimit_*%& options, because those options control the rate of
30255 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30256 works across all connections (concurrent and sequential) from the same client
30257 host. The syntax of the &%ratelimit%& condition is:
30258 .display
30259 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30260 .endd
30261 If the average client sending rate is less than &'m'& messages per time
30262 period &'p'& then the condition is false; otherwise it is true.
30263
30264 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30265 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30266 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30267 of &'p'&.
30268
30269 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30270 time interval, for example, &`8h`& for eight hours. A larger time constant
30271 means that it takes Exim longer to forget a client's past behaviour. The
30272 parameter &'m'& is the maximum number of messages that a client is permitted to
30273 send in each time interval. It also specifies the number of messages permitted
30274 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30275 constant, you can allow a client to send more messages in a burst without
30276 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30277 both small, messages must be sent at an even rate.
30278
30279 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30280 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30281 when deploying the &%ratelimit%& ACL condition. The script prints usage
30282 instructions when it is run with no arguments.
30283
30284 The key is used to look up the data for calculating the client's average
30285 sending rate. This data is stored in Exim's spool directory, alongside the
30286 retry and other hints databases. The default key is &$sender_host_address$&,
30287 which means Exim computes the sending rate of each client host IP address.
30288 By changing the key you can change how Exim identifies clients for the purpose
30289 of ratelimiting. For example, to limit the sending rate of each authenticated
30290 user, independent of the computer they are sending from, set the key to
30291 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30292 example, &$authenticated_id$& is only meaningful if the client has
30293 authenticated (which you can check with the &%authenticated%& ACL condition).
30294
30295 The lookup key does not have to identify clients: If you want to limit the
30296 rate at which a recipient receives messages, you can use the key
30297 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30298 ACL.
30299
30300 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30301 specifies what Exim measures the rate of, for example messages or recipients
30302 or bytes. You can adjust the measurement using the &%unique=%& and/or
30303 &%count=%& options. You can also control when Exim updates the recorded rate
30304 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30305 separated by a slash, like the other parameters. They may appear in any order.
30306
30307 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30308 any options that alter the meaning of the stored data. The limit &'m'& is not
30309 stored, so you can alter the configured maximum rate and Exim will still
30310 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30311 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30312 behaviour. The lookup key is not affected by changes to the update mode and
30313 the &%count=%& option.
30314
30315
30316 .section "Ratelimit options for what is being measured" "ratoptmea"
30317 .cindex "rate limiting" "per_* options"
30318 The &%per_conn%& option limits the client's connection rate. It is not
30319 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30320 &%acl_not_smtp_start%& ACLs.
30321
30322 The &%per_mail%& option limits the client's rate of sending messages. This is
30323 the default if none of the &%per_*%& options is specified. It can be used in
30324 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30325 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30326
30327 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30328 the same ACLs as the &%per_mail%& option, though it is best to use this option
30329 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30330 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30331 in its MAIL command, which may be inaccurate or completely missing. You can
30332 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30333 in kilobytes, megabytes, or gigabytes, respectively.
30334
30335 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30336 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30337 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30338 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30339 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30340 in either case the rate limiting engine will see a message with many
30341 recipients as a large high-speed burst.
30342
30343 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30344 number of different recipients that the client has sent messages to in the
30345 last time period. That is, if the client repeatedly sends messages to the same
30346 recipient, its measured rate is not increased. This option can only be used in
30347 &%acl_smtp_rcpt%&.
30348
30349 The &%per_cmd%& option causes Exim to recompute the rate every time the
30350 condition is processed. This can be used to limit the rate of any SMTP
30351 command. If it is used in multiple ACLs it can limit the aggregate rate of
30352 multiple different commands.
30353
30354 The &%count=%& option can be used to alter how much Exim adds to the client's
30355 measured rate. For example, the &%per_byte%& option is equivalent to
30356 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30357 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30358 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30359
30360 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30361
30362
30363 .section "Ratelimit update modes" "ratoptupd"
30364 .cindex "rate limiting" "reading data without updating"
30365 You can specify one of three options with the &%ratelimit%& condition to
30366 control when its database is updated. This section describes the &%readonly%&
30367 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30368
30369 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30370 previously-computed rate to check against the limit.
30371
30372 For example, you can test the client's sending rate and deny it access (when
30373 it is too fast) in the connect ACL. If the client passes this check then it
30374 can go on to send a message, in which case its recorded rate will be updated
30375 in the MAIL ACL. Subsequent connections from the same client will check this
30376 new rate.
30377 .code
30378 acl_check_connect:
30379  deny ratelimit = 100 / 5m / readonly
30380     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30381                   (max $sender_rate_limit)
30382 # ...
30383 acl_check_mail:
30384  warn ratelimit = 100 / 5m / strict
30385     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30386                   (max $sender_rate_limit)
30387 .endd
30388
30389 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30390 processing a message then it may increase the client's measured rate more than
30391 it should. For example, this will happen if you check the &%per_rcpt%& option
30392 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30393 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30394 multiple update problems by using the &%readonly%& option on later ratelimit
30395 checks.
30396
30397 The &%per_*%& options described above do not make sense in some ACLs. If you
30398 use a &%per_*%& option in an ACL where it is not normally permitted then the
30399 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30400 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30401 next section) so you must specify the &%readonly%& option explicitly.
30402
30403
30404 .section "Ratelimit options for handling fast clients" "ratoptfast"
30405 .cindex "rate limiting" "strict and leaky modes"
30406 If a client's average rate is greater than the maximum, the rate limiting
30407 engine can react in two possible ways, depending on the presence of the
30408 &%strict%& or &%leaky%& update modes. This is independent of the other
30409 counter-measures (such as rejecting the message) that may be specified by the
30410 rest of the ACL.
30411
30412 The &%leaky%& (default) option means that the client's recorded rate is not
30413 updated if it is above the limit. The effect of this is that Exim measures the
30414 client's average rate of successfully sent email, which cannot be greater than
30415 the maximum allowed. If the client is over the limit it may suffer some
30416 counter-measures (as specified in the ACL), but it will still be able to send
30417 email at the configured maximum rate, whatever the rate of its attempts. This
30418 is generally the better choice if you have clients that retry automatically.
30419 For example, it does not prevent a sender with an over-aggressive retry rate
30420 from getting any email through.
30421
30422 The &%strict%& option means that the client's recorded rate is always
30423 updated. The effect of this is that Exim measures the client's average rate
30424 of attempts to send email, which can be much higher than the maximum it is
30425 actually allowed. If the client is over the limit it may be subjected to
30426 counter-measures by the ACL. It must slow down and allow sufficient time to
30427 pass that its computed rate falls below the maximum before it can send email
30428 again. The time (the number of smoothing periods) it must wait and not
30429 attempt to send mail can be calculated with this formula:
30430 .code
30431         ln(peakrate/maxrate)
30432 .endd
30433
30434
30435 .section "Limiting the rate of different events" "ratoptuniq"
30436 .cindex "rate limiting" "counting unique events"
30437 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30438 rate of different events. For example, the &%per_addr%& option uses this
30439 mechanism to count the number of different recipients that the client has
30440 sent messages to in the last time period; it is equivalent to
30441 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30442 measure the rate that a client uses different sender addresses with the
30443 options &`per_mail/unique=$sender_address`&.
30444
30445 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30446 has seen for that key. The whole set is thrown away when it is older than the
30447 rate smoothing period &'p'&, so each different event is counted at most once
30448 per period. In the &%leaky%& update mode, an event that causes the client to
30449 go over the limit is not added to the set, in the same way that the client's
30450 recorded rate is not updated in the same situation.
30451
30452 When you combine the &%unique=%& and &%readonly%& options, the specific
30453 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30454 rate.
30455
30456 The &%unique=%& mechanism needs more space in the ratelimit database than the
30457 other &%ratelimit%& options in order to store the event set. The number of
30458 unique values is potentially as large as the rate limit, so the extra space
30459 required increases with larger limits.
30460
30461 The uniqueification is not perfect: there is a small probability that Exim
30462 will think a new event has happened before. If the sender's rate is less than
30463 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30464 the measured rate can go above the limit, in which case Exim may under-count
30465 events by a significant margin. Fortunately, if the rate is high enough (2.7
30466 times the limit) that the false positive rate goes above 9%, then Exim will
30467 throw away the over-full event set before the measured rate falls below the
30468 limit. Therefore the only harm should be that exceptionally high sending rates
30469 are logged incorrectly; any countermeasures you configure will be as effective
30470 as intended.
30471
30472
30473 .section "Using rate limiting" "useratlim"
30474 Exim's other ACL facilities are used to define what counter-measures are taken
30475 when the rate limit is exceeded. This might be anything from logging a warning
30476 (for example, while measuring existing sending rates in order to define
30477 policy), through time delays to slow down fast senders, up to rejecting the
30478 message. For example:
30479 .code
30480 # Log all senders' rates
30481 warn ratelimit = 0 / 1h / strict
30482      log_message = Sender rate $sender_rate / $sender_rate_period
30483
30484 # Slow down fast senders; note the need to truncate $sender_rate
30485 # at the decimal point.
30486 warn ratelimit = 100 / 1h / per_rcpt / strict
30487      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30488                    $sender_rate_limit }s
30489
30490 # Keep authenticated users under control
30491 deny authenticated = *
30492      ratelimit = 100 / 1d / strict / $authenticated_id
30493
30494 # System-wide rate limit
30495 defer message = Sorry, too busy. Try again later.
30496      ratelimit = 10 / 1s / $primary_hostname
30497
30498 # Restrict incoming rate from each host, with a default
30499 # set using a macro and special cases looked up in a table.
30500 defer message = Sender rate exceeds $sender_rate_limit \
30501                messages per $sender_rate_period
30502      ratelimit = ${lookup {$sender_host_address} \
30503                    cdb {DB/ratelimits.cdb} \
30504                    {$value} {RATELIMIT} }
30505 .endd
30506 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30507 especially with the &%per_rcpt%& option, you may suffer from a performance
30508 bottleneck caused by locking on the ratelimit hints database. Apart from
30509 making your ACLs less complicated, you can reduce the problem by using a
30510 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30511 this means that Exim will lose its hints data after a reboot (including retry
30512 hints, the callout cache, and ratelimit data).
30513
30514
30515
30516 .section "Address verification" "SECTaddressverification"
30517 .cindex "verifying address" "options for"
30518 .cindex "policy control" "address verification"
30519 Several of the &%verify%& conditions described in section
30520 &<<SECTaclconditions>>& cause addresses to be verified. Section
30521 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30522 The verification conditions can be followed by options that modify the
30523 verification process. The options are separated from the keyword and from each
30524 other by slashes, and some of them contain parameters. For example:
30525 .code
30526 verify = sender/callout
30527 verify = recipient/defer_ok/callout=10s,defer_ok
30528 .endd
30529 The first stage of address verification, which always happens, is to run the
30530 address through the routers, in &"verify mode"&. Routers can detect the
30531 difference between verification and routing for delivery, and their actions can
30532 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30533 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30534 The available options are as follows:
30535
30536 .ilist
30537 If the &%callout%& option is specified, successful routing to one or more
30538 remote hosts is followed by a &"callout"& to those hosts as an additional
30539 check. Callouts and their sub-options are discussed in the next section.
30540 .next
30541 If there is a defer error while doing verification routing, the ACL
30542 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30543 options, the condition is forced to be true instead. Note that this is a main
30544 verification option as well as a suboption for callouts.
30545 .next
30546 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30547 discusses the reporting of sender address verification failures.
30548 .next
30549 The &%success_on_redirect%& option causes verification always to succeed
30550 immediately after a successful redirection. By default, if a redirection
30551 generates just one address, that address is also verified. See further
30552 discussion in section &<<SECTredirwhilveri>>&.
30553 .endlist
30554
30555 .cindex "verifying address" "differentiating failures"
30556 .vindex "&$recipient_verify_failure$&"
30557 .vindex "&$sender_verify_failure$&"
30558 .vindex "&$acl_verify_message$&"
30559 After an address verification failure, &$acl_verify_message$& contains the
30560 error message that is associated with the failure. It can be preserved by
30561 coding like this:
30562 .code
30563 warn  !verify = sender
30564        set acl_m0 = $acl_verify_message
30565 .endd
30566 If you are writing your own custom rejection message or log message when
30567 denying access, you can use this variable to include information about the
30568 verification failure.
30569
30570 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30571 appropriate) contains one of the following words:
30572
30573 .ilist
30574 &%qualify%&: The address was unqualified (no domain), and the message
30575 was neither local nor came from an exempted host.
30576 .next
30577 &%route%&: Routing failed.
30578 .next
30579 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30580 occurred at or before the MAIL command (that is, on initial
30581 connection, HELO, or MAIL).
30582 .next
30583 &%recipient%&: The RCPT command in a callout was rejected.
30584 .next
30585 &%postmaster%&: The postmaster check in a callout was rejected.
30586 .endlist
30587
30588 The main use of these variables is expected to be to distinguish between
30589 rejections of MAIL and rejections of RCPT in callouts.
30590
30591
30592
30593
30594 .section "Callout verification" "SECTcallver"
30595 .cindex "verifying address" "by callout"
30596 .cindex "callout" "verification"
30597 .cindex "SMTP" "callout verification"
30598 For non-local addresses, routing verifies the domain, but is unable to do any
30599 checking of the local part. There are situations where some means of verifying
30600 the local part is desirable. One way this can be done is to make an SMTP
30601 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30602 a subsequent host for a recipient address, to see if the host accepts the
30603 address. We use the term &'callout'& to cover both cases. Note that for a
30604 sender address, the callback is not to the client host that is trying to
30605 deliver the message, but to one of the hosts that accepts incoming mail for the
30606 sender's domain.
30607
30608 Exim does not do callouts by default. If you want them to happen, you must
30609 request them by setting appropriate options on the &%verify%& condition, as
30610 described below. This facility should be used with care, because it can add a
30611 lot of resource usage to the cost of verifying an address. However, Exim does
30612 cache the results of callouts, which helps to reduce the cost. Details of
30613 caching are in section &<<SECTcallvercache>>&.
30614
30615 Recipient callouts are usually used only between hosts that are controlled by
30616 the same administration. For example, a corporate gateway host could use
30617 callouts to check for valid recipients on an internal mailserver. A successful
30618 callout does not guarantee that a real delivery to the address would succeed;
30619 on the other hand, a failing callout does guarantee that a delivery would fail.
30620
30621 If the &%callout%& option is present on a condition that verifies an address, a
30622 second stage of verification occurs if the address is successfully routed to
30623 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30624 &(manualroute)& router, where the router specifies the hosts. However, if a
30625 router that does not set up hosts routes to an &(smtp)& transport with a
30626 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30627 &%hosts_override%& set, its hosts are always used, whether or not the router
30628 supplies a host list.
30629 Callouts are only supported on &(smtp)& transports.
30630
30631 The port that is used is taken from the transport, if it is specified and is a
30632 remote transport. (For routers that do verification only, no transport need be
30633 specified.) Otherwise, the default SMTP port is used. If a remote transport
30634 specifies an outgoing interface, this is used; otherwise the interface is not
30635 specified. Likewise, the text that is used for the HELO command is taken from
30636 the transport's &%helo_data%& option; if there is no transport, the value of
30637 &$smtp_active_hostname$& is used.
30638
30639 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30640 test whether a bounce message could be delivered to the sender address. The
30641 following SMTP commands are sent:
30642 .display
30643 &`HELO `&<&'local host name'&>
30644 &`MAIL FROM:<>`&
30645 &`RCPT TO:`&<&'the address to be tested'&>
30646 &`QUIT`&
30647 .endd
30648 LHLO is used instead of HELO if the transport's &%protocol%& option is
30649 set to &"lmtp"&.
30650
30651 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30652 settings.
30653
30654 A recipient callout check is similar. By default, it also uses an empty address
30655 for the sender. This default is chosen because most hosts do not make use of
30656 the sender address when verifying a recipient. Using the same address means
30657 that a single cache entry can be used for each recipient. Some sites, however,
30658 do make use of the sender address when verifying. These are catered for by the
30659 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30660
30661 If the response to the RCPT command is a 2&'xx'& code, the verification
30662 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30663 Exim tries the next host, if any. If there is a problem with all the remote
30664 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30665 &%callout%& option is given, in which case the condition is forced to succeed.
30666
30667 .cindex "SMTP" "output flushing, disabling for callout"
30668 A callout may take a little time. For this reason, Exim normally flushes SMTP
30669 output before performing a callout in an ACL, to avoid unexpected timeouts in
30670 clients when the SMTP PIPELINING extension is in use. The flushing can be
30671 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30672
30673
30674
30675
30676 .section "Additional parameters for callouts" "CALLaddparcall"
30677 .cindex "callout" "additional parameters for"
30678 The &%callout%& option can be followed by an equals sign and a number of
30679 optional parameters, separated by commas. For example:
30680 .code
30681 verify = recipient/callout=10s,defer_ok
30682 .endd
30683 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30684 separate verify options, is retained for backwards compatibility, but is now
30685 deprecated. The additional parameters for &%callout%& are as follows:
30686
30687
30688 .vlist
30689 .vitem <&'a&~time&~interval'&>
30690 .cindex "callout" "timeout, specifying"
30691 This specifies the timeout that applies for the callout attempt to each host.
30692 For example:
30693 .code
30694 verify = sender/callout=5s
30695 .endd
30696 The default is 30 seconds. The timeout is used for each response from the
30697 remote host. It is also used for the initial connection, unless overridden by
30698 the &%connect%& parameter.
30699
30700
30701 .vitem &*connect&~=&~*&<&'time&~interval'&>
30702 .cindex "callout" "connection timeout, specifying"
30703 This parameter makes it possible to set a different (usually smaller) timeout
30704 for making the SMTP connection. For example:
30705 .code
30706 verify = sender/callout=5s,connect=1s
30707 .endd
30708 If not specified, this timeout defaults to the general timeout value.
30709
30710 .vitem &*defer_ok*&
30711 .cindex "callout" "defer, action on"
30712 When this parameter is present, failure to contact any host, or any other kind
30713 of temporary error, is treated as success by the ACL. However, the cache is not
30714 updated in this circumstance.
30715
30716 .vitem &*fullpostmaster*&
30717 .cindex "callout" "full postmaster check"
30718 This operates like the &%postmaster%& option (see below), but if the check for
30719 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30720 accordance with the specification in RFC 2821. The RFC states that the
30721 unqualified address &'postmaster'& should be accepted.
30722
30723
30724 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30725 .cindex "callout" "sender when verifying header"
30726 When verifying addresses in header lines using the &%header_sender%&
30727 verification option, Exim behaves by default as if the addresses are envelope
30728 sender addresses from a message. Callout verification therefore tests to see
30729 whether a bounce message could be delivered, by using an empty address in the
30730 MAIL command. However, it is arguable that these addresses might never be used
30731 as envelope senders, and could therefore justifiably reject bounce messages
30732 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30733 address to use in the MAIL command. For example:
30734 .code
30735 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30736 .endd
30737 This parameter is available only for the &%header_sender%& verification option.
30738
30739
30740 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30741 .cindex "callout" "overall timeout, specifying"
30742 This parameter sets an overall timeout for performing a callout verification.
30743 For example:
30744 .code
30745 verify = sender/callout=5s,maxwait=30s
30746 .endd
30747 This timeout defaults to four times the callout timeout for individual SMTP
30748 commands. The overall timeout applies when there is more than one host that can
30749 be tried. The timeout is checked before trying the next host. This prevents
30750 very long delays if there are a large number of hosts and all are timing out
30751 (for example, when network connections are timing out).
30752
30753
30754 .vitem &*no_cache*&
30755 .cindex "callout" "cache, suppressing"
30756 .cindex "caching callout, suppressing"
30757 When this parameter is given, the callout cache is neither read nor updated.
30758
30759 .vitem &*postmaster*&
30760 .cindex "callout" "postmaster; checking"
30761 When this parameter is set, a successful callout check is followed by a similar
30762 check for the local part &'postmaster'& at the same domain. If this address is
30763 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30764 the postmaster check is recorded in a cache record; if it is a failure, this is
30765 used to fail subsequent callouts for the domain without a connection being
30766 made, until the cache record expires.
30767
30768 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30769 The postmaster check uses an empty sender in the MAIL command by default.
30770 You can use this parameter to do a postmaster check using a different address.
30771 For example:
30772 .code
30773 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30774 .endd
30775 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30776 one overrides. The &%postmaster%& parameter is equivalent to this example:
30777 .code
30778 require  verify = sender/callout=postmaster_mailfrom=
30779 .endd
30780 &*Warning*&: The caching arrangements for postmaster checking do not take
30781 account of the sender address. It is assumed that either the empty address or
30782 a fixed non-empty address will be used. All that Exim remembers is that the
30783 postmaster check for the domain succeeded or failed.
30784
30785
30786 .vitem &*random*&
30787 .cindex "callout" "&""random""& check"
30788 When this parameter is set, before doing the normal callout check, Exim does a
30789 check for a &"random"& local part at the same domain. The local part is not
30790 really random &-- it is defined by the expansion of the option
30791 &%callout_random_local_part%&, which defaults to
30792 .code
30793 $primary_hostname-$tod_epoch-testing
30794 .endd
30795 The idea here is to try to determine whether the remote host accepts all local
30796 parts without checking. If it does, there is no point in doing callouts for
30797 specific local parts. If the &"random"& check succeeds, the result is saved in
30798 a cache record, and used to force the current and subsequent callout checks to
30799 succeed without a connection being made, until the cache record expires.
30800
30801 .vitem &*use_postmaster*&
30802 .cindex "callout" "sender for recipient check"
30803 This parameter applies to recipient callouts only. For example:
30804 .code
30805 deny  !verify = recipient/callout=use_postmaster
30806 .endd
30807 .vindex "&$qualify_domain$&"
30808 It causes a non-empty postmaster address to be used in the MAIL command when
30809 performing the callout for the recipient, and also for a &"random"& check if
30810 that is configured. The local part of the address is &`postmaster`& and the
30811 domain is the contents of &$qualify_domain$&.
30812
30813 .vitem &*use_sender*&
30814 This option applies to recipient callouts only. For example:
30815 .code
30816 require  verify = recipient/callout=use_sender
30817 .endd
30818 It causes the message's actual sender address to be used in the MAIL
30819 command when performing the callout, instead of an empty address. There is no
30820 need to use this option unless you know that the called hosts make use of the
30821 sender when checking recipients. If used indiscriminately, it reduces the
30822 usefulness of callout caching.
30823 .endlist
30824
30825 If you use any of the parameters that set a non-empty sender for the MAIL
30826 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30827 &%use_sender%&), you should think about possible loops. Recipient checking is
30828 usually done between two hosts that are under the same management, and the host
30829 that receives the callouts is not normally configured to do callouts itself.
30830 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30831 these circumstances.
30832
30833 However, if you use a non-empty sender address for a callout to an arbitrary
30834 host, there is the likelihood that the remote host will itself initiate a
30835 callout check back to your host. As it is checking what appears to be a message
30836 sender, it is likely to use an empty address in MAIL, thus avoiding a
30837 callout loop. However, to be on the safe side it would be best to set up your
30838 own ACLs so that they do not do sender verification checks when the recipient
30839 is the address you use for header sender or postmaster callout checking.
30840
30841 Another issue to think about when using non-empty senders for callouts is
30842 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30843 by the sender/recipient combination; thus, for any given recipient, many more
30844 actual callouts are performed than when an empty sender or postmaster is used.
30845
30846
30847
30848
30849 .section "Callout caching" "SECTcallvercache"
30850 .cindex "hints database" "callout cache"
30851 .cindex "callout" "cache, description of"
30852 .cindex "caching" "callout"
30853 Exim caches the results of callouts in order to reduce the amount of resources
30854 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30855 option. A hints database called &"callout"& is used for the cache. Two
30856 different record types are used: one records the result of a callout check for
30857 a specific address, and the other records information that applies to the
30858 entire domain (for example, that it accepts the local part &'postmaster'&).
30859
30860 When an original callout fails, a detailed SMTP error message is given about
30861 the failure. However, for subsequent failures use the cache data, this message
30862 is not available.
30863
30864 The expiry times for negative and positive address cache records are
30865 independent, and can be set by the global options &%callout_negative_expire%&
30866 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30867
30868 If a host gives a negative response to an SMTP connection, or rejects any
30869 commands up to and including
30870 .code
30871 MAIL FROM:<>
30872 .endd
30873 (but not including the MAIL command with a non-empty address),
30874 any callout attempt is bound to fail. Exim remembers such failures in a
30875 domain cache record, which it uses to fail callouts for the domain without
30876 making new connections, until the domain record times out. There are two
30877 separate expiry times for domain cache records:
30878 &%callout_domain_negative_expire%& (default 3h) and
30879 &%callout_domain_positive_expire%& (default 7d).
30880
30881 Domain records expire when the negative expiry time is reached if callouts
30882 cannot be made for the domain, or if the postmaster check failed.
30883 Otherwise, they expire when the positive expiry time is reached. This
30884 ensures that, for example, a host that stops accepting &"random"& local parts
30885 will eventually be noticed.
30886
30887 The callout caching mechanism is based on the domain of the address that is
30888 being tested. If the domain routes to several hosts, it is assumed that their
30889 behaviour will be the same.
30890
30891
30892
30893 .section "Sender address verification reporting" "SECTsenaddver"
30894 .cindex "verifying" "suppressing error details"
30895 See section &<<SECTaddressverification>>& for a general discussion of
30896 verification. When sender verification fails in an ACL, the details of the
30897 failure are given as additional output lines before the 550 response to the
30898 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30899 you might see:
30900 .code
30901 MAIL FROM:<xyz@abc.example>
30902 250 OK
30903 RCPT TO:<pqr@def.example>
30904 550-Verification failed for <xyz@abc.example>
30905 550-Called:   192.168.34.43
30906 550-Sent:     RCPT TO:<xyz@abc.example>
30907 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30908 550 Sender verification failed
30909 .endd
30910 If more than one RCPT command fails in the same way, the details are given
30911 only for the first of them. However, some administrators do not want to send
30912 out this much information. You can suppress the details by adding
30913 &`/no_details`& to the ACL statement that requests sender verification. For
30914 example:
30915 .code
30916 verify = sender/no_details
30917 .endd
30918
30919 .section "Redirection while verifying" "SECTredirwhilveri"
30920 .cindex "verifying" "redirection while"
30921 .cindex "address redirection" "while verifying"
30922 A dilemma arises when a local address is redirected by aliasing or forwarding
30923 during verification: should the generated addresses themselves be verified,
30924 or should the successful expansion of the original address be enough to verify
30925 it? By default, Exim takes the following pragmatic approach:
30926
30927 .ilist
30928 When an incoming address is redirected to just one child address, verification
30929 continues with the child address, and if that fails to verify, the original
30930 verification also fails.
30931 .next
30932 When an incoming address is redirected to more than one child address,
30933 verification does not continue. A success result is returned.
30934 .endlist
30935
30936 This seems the most reasonable behaviour for the common use of aliasing as a
30937 way of redirecting different local parts to the same mailbox. It means, for
30938 example, that a pair of alias entries of the form
30939 .code
30940 A.Wol:   aw123
30941 aw123:   :fail: Gone away, no forwarding address
30942 .endd
30943 work as expected, with both local parts causing verification failure. When a
30944 redirection generates more than one address, the behaviour is more like a
30945 mailing list, where the existence of the alias itself is sufficient for
30946 verification to succeed.
30947
30948 It is possible, however, to change the default behaviour so that all successful
30949 redirections count as successful verifications, however many new addresses are
30950 generated. This is specified by the &%success_on_redirect%& verification
30951 option. For example:
30952 .code
30953 require verify = recipient/success_on_redirect/callout=10s
30954 .endd
30955 In this example, verification succeeds if a router generates a new address, and
30956 the callout does not occur, because no address was routed to a remote host.
30957
30958 When verification is being tested via the &%-bv%& option, the treatment of
30959 redirections is as just described, unless the &%-v%& or any debugging option is
30960 also specified. In that case, full verification is done for every generated
30961 address and a report is output for each of them.
30962
30963
30964
30965 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30966 .cindex "CSA" "verifying"
30967 Client SMTP Authorization is a system that allows a site to advertise
30968 which machines are and are not permitted to send email. This is done by placing
30969 special SRV records in the DNS; these are looked up using the client's HELO
30970 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30971 Authorization checks in Exim are performed by the ACL condition:
30972 .code
30973 verify = csa
30974 .endd
30975 This fails if the client is not authorized. If there is a DNS problem, or if no
30976 valid CSA SRV record is found, or if the client is authorized, the condition
30977 succeeds. These three cases can be distinguished using the expansion variable
30978 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30979 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30980 be likely to cause problems for legitimate email.
30981
30982 The error messages produced by the CSA code include slightly more
30983 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30984 looking up the CSA SRV record, or problems looking up the CSA target
30985 address record. There are four reasons for &$csa_status$& being &"fail"&:
30986
30987 .ilist
30988 The client's host name is explicitly not authorized.
30989 .next
30990 The client's IP address does not match any of the CSA target IP addresses.
30991 .next
30992 The client's host name is authorized but it has no valid target IP addresses
30993 (for example, the target's addresses are IPv6 and the client is using IPv4).
30994 .next
30995 The client's host name has no CSA SRV record but a parent domain has asserted
30996 that all subdomains must be explicitly authorized.
30997 .endlist
30998
30999 The &%csa%& verification condition can take an argument which is the domain to
31000 use for the DNS query. The default is:
31001 .code
31002 verify = csa/$sender_helo_name
31003 .endd
31004 This implementation includes an extension to CSA. If the query domain
31005 is an address literal such as [192.0.2.95], or if it is a bare IP
31006 address, Exim searches for CSA SRV records in the reverse DNS as if
31007 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31008 meaningful to say:
31009 .code
31010 verify = csa/$sender_host_address
31011 .endd
31012 In fact, this is the check that Exim performs if the client does not say HELO.
31013 This extension can be turned off by setting the main configuration option
31014 &%dns_csa_use_reverse%& to be false.
31015
31016 If a CSA SRV record is not found for the domain itself, a search
31017 is performed through its parent domains for a record which might be
31018 making assertions about subdomains. The maximum depth of this search is limited
31019 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31020 default. Exim does not look for CSA SRV records in a top level domain, so the
31021 default settings handle HELO domains as long as seven
31022 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31023 of legitimate HELO domains.
31024
31025 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31026 direct SRV lookups, this is not sufficient because of the extra parent domain
31027 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31028 addresses into lookups in the reverse DNS space. The result of a successful
31029 lookup such as:
31030 .code
31031 ${lookup dnsdb {csa=$sender_helo_name}}
31032 .endd
31033 has two space-separated fields: an authorization code and a target host name.
31034 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31035 authorization required but absent, or &"?"& for unknown.
31036
31037
31038
31039
31040 .section "Bounce address tag validation" "SECTverifyPRVS"
31041 .cindex "BATV, verifying"
31042 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31043 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31044 Genuine incoming bounce messages should therefore always be addressed to
31045 recipients that have a valid tag. This scheme is a way of detecting unwanted
31046 bounce messages caused by sender address forgeries (often called &"collateral
31047 spam"&), because the recipients of such messages do not include valid tags.
31048
31049 There are two expansion items to help with the implementation of the BATV
31050 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31051 the original envelope sender address by using a simple key to add a hash of the
31052 address and some time-based randomizing information. The &%prvs%& expansion
31053 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31054 The syntax of these expansion items is described in section
31055 &<<SECTexpansionitems>>&.
31056
31057 As an example, suppose the secret per-address keys are stored in an MySQL
31058 database. A query to look up the key for an address could be defined as a macro
31059 like this:
31060 .code
31061 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31062                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31063                 }{$value}}
31064 .endd
31065 Suppose also that the senders who make use of BATV are defined by an address
31066 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31067 use this:
31068 .code
31069 # Bounces: drop unsigned addresses for BATV senders
31070 deny message = This address does not send an unsigned reverse path
31071      senders = :
31072      recipients = +batv_senders
31073
31074 # Bounces: In case of prvs-signed address, check signature.
31075 deny message = Invalid reverse path signature.
31076      senders = :
31077      condition  = ${prvscheck {$local_part@$domain}\
31078                   {PRVSCHECK_SQL}{1}}
31079      !condition = $prvscheck_result
31080 .endd
31081 The first statement rejects recipients for bounce messages that are addressed
31082 to plain BATV sender addresses, because it is known that BATV senders do not
31083 send out messages with plain sender addresses. The second statement rejects
31084 recipients that are prvs-signed, but with invalid signatures (either because
31085 the key is wrong, or the signature has timed out).
31086
31087 A non-prvs-signed address is not rejected by the second statement, because the
31088 &%prvscheck%& expansion yields an empty string if its first argument is not a
31089 prvs-signed address, thus causing the &%condition%& condition to be false. If
31090 the first argument is a syntactically valid prvs-signed address, the yield is
31091 the third string (in this case &"1"&), whether or not the cryptographic and
31092 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31093 of the checks (empty for failure, &"1"& for success).
31094
31095 There is one more issue you must consider when implementing prvs-signing:
31096 you have to ensure that the routers accept prvs-signed addresses and
31097 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31098 router to remove the signature with a configuration along these lines:
31099 .code
31100 batv_redirect:
31101   driver = redirect
31102   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31103 .endd
31104 This works because, if the third argument of &%prvscheck%& is empty, the result
31105 of the expansion of a prvs-signed address is the decoded value of the original
31106 address. This router should probably be the first of your routers that handles
31107 local addresses.
31108
31109 To create BATV-signed addresses in the first place, a transport of this form
31110 can be used:
31111 .code
31112 external_smtp_batv:
31113   driver = smtp
31114   return_path = ${prvs {$return_path} \
31115                        {${lookup mysql{SELECT \
31116                        secret FROM batv_prvs WHERE \
31117                        sender='${quote_mysql:$sender_address}'} \
31118                        {$value}fail}}}
31119 .endd
31120 If no key can be found for the existing return path, no signing takes place.
31121
31122
31123
31124 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31125 .cindex "&ACL;" "relay control"
31126 .cindex "relaying" "control by ACL"
31127 .cindex "policy control" "relay control"
31128 An MTA is said to &'relay'& a message if it receives it from some host and
31129 delivers it directly to another host as a result of a remote address contained
31130 within it. Redirecting a local address via an alias or forward file and then
31131 passing the message on to another host is not relaying,
31132 .cindex "&""percent hack""&"
31133 but a redirection as a result of the &"percent hack"& is.
31134
31135 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31136 A host which is acting as a gateway or an MX backup is concerned with incoming
31137 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31138 a host which is acting as a smart host for a number of clients is concerned
31139 with outgoing relaying from those clients to the Internet at large. Often the
31140 same host is fulfilling both functions,
31141 . ///
31142 . as illustrated in the diagram below,
31143 . ///
31144 but in principle these two kinds of relaying are entirely independent. What is
31145 not wanted is the transmission of mail from arbitrary remote hosts through your
31146 system to arbitrary domains.
31147
31148
31149 You can implement relay control by means of suitable statements in the ACL that
31150 runs for each RCPT command. For convenience, it is often easiest to use
31151 Exim's named list facility to define the domains and hosts involved. For
31152 example, suppose you want to do the following:
31153
31154 .ilist
31155 Deliver a number of domains to mailboxes on the local host (or process them
31156 locally in some other way). Let's say these are &'my.dom1.example'& and
31157 &'my.dom2.example'&.
31158 .next
31159 Relay mail for a number of other domains for which you are the secondary MX.
31160 These might be &'friend1.example'& and &'friend2.example'&.
31161 .next
31162 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31163 Suppose your LAN is 192.168.45.0/24.
31164 .endlist
31165
31166
31167 In the main part of the configuration, you put the following definitions:
31168 .code
31169 domainlist local_domains    = my.dom1.example : my.dom2.example
31170 domainlist relay_to_domains = friend1.example : friend2.example
31171 hostlist   relay_from_hosts = 192.168.45.0/24
31172 .endd
31173 Now you can use these definitions in the ACL that is run for every RCPT
31174 command:
31175 .code
31176 acl_check_rcpt:
31177   accept domains = +local_domains : +relay_to_domains
31178   accept hosts   = +relay_from_hosts
31179 .endd
31180 The first statement accepts any RCPT command that contains an address in
31181 the local or relay domains. For any other domain, control passes to the second
31182 statement, which accepts the command only if it comes from one of the relay
31183 hosts. In practice, you will probably want to make your ACL more sophisticated
31184 than this, for example, by including sender and recipient verification. The
31185 default configuration includes a more comprehensive example, which is described
31186 in chapter &<<CHAPdefconfil>>&.
31187
31188
31189
31190 .section "Checking a relay configuration" "SECTcheralcon"
31191 .cindex "relaying" "checking control of"
31192 You can check the relay characteristics of your configuration in the same way
31193 that you can test any ACL behaviour for an incoming SMTP connection, by using
31194 the &%-bh%& option to run a fake SMTP session with which you interact.
31195 .ecindex IIDacl
31196
31197
31198
31199 . ////////////////////////////////////////////////////////////////////////////
31200 . ////////////////////////////////////////////////////////////////////////////
31201
31202 .chapter "Content scanning at ACL time" "CHAPexiscan"
31203 .scindex IIDcosca "content scanning" "at ACL time"
31204 The extension of Exim to include content scanning at ACL time, formerly known
31205 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31206 was integrated into the main source for Exim release 4.50, and Tom continues to
31207 maintain it. Most of the wording of this chapter is taken from Tom's
31208 specification.
31209
31210 It is also possible to scan the content of messages at other times. The
31211 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31212 scanning after all the ACLs have run. A transport filter can be used to scan
31213 messages at delivery time (see the &%transport_filter%& option, described in
31214 chapter &<<CHAPtransportgeneric>>&).
31215
31216 If you want to include the ACL-time content-scanning features when you compile
31217 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31218 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31219
31220 .ilist
31221 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31222 for all MIME parts for SMTP and non-SMTP messages, respectively.
31223 .next
31224 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31225 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31226 run at the end of message reception (the &%acl_smtp_data%& ACL).
31227 .next
31228 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31229 of messages, or parts of messages, for debugging purposes.
31230 .next
31231 Additional expansion variables that are set in the new ACL and by the new
31232 conditions.
31233 .next
31234 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31235 .endlist
31236
31237 Content-scanning is continually evolving, and new features are still being
31238 added. While such features are still unstable and liable to incompatible
31239 changes, they are made available in Exim by setting options whose names begin
31240 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31241 this manual. You can find out about them by reading the file called
31242 &_doc/experimental.txt_&.
31243
31244 All the content-scanning facilities work on a MBOX copy of the message that is
31245 temporarily created in a file called:
31246 .display
31247 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31248 .endd
31249 The &_.eml_& extension is a friendly hint to virus scanners that they can
31250 expect an MBOX-like structure inside that file. The file is created when the
31251 first content scanning facility is called. Subsequent calls to content
31252 scanning conditions open the same file again. The directory is recursively
31253 removed when the &%acl_smtp_data%& ACL has finished running, unless
31254 .code
31255 control = no_mbox_unspool
31256 .endd
31257 has been encountered. When the MIME ACL decodes files, they are put into the
31258 same directory by default.
31259
31260
31261
31262 .section "Scanning for viruses" "SECTscanvirus"
31263 .cindex "virus scanning"
31264 .cindex "content scanning" "for viruses"
31265 .cindex "content scanning" "the &%malware%& condition"
31266 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31267 It supports a &"generic"& interface to scanners called via the shell, and
31268 specialized interfaces for &"daemon"& type virus scanners, which are resident
31269 in memory and thus are much faster.
31270
31271 A timeout of 2 minutes is applied to a scanner call (by default);
31272 if it expires then a defer action is taken.
31273
31274 .oindex "&%av_scanner%&"
31275 You can set the &%av_scanner%& option in the main part of the configuration
31276 to specify which scanner to use, together with any additional options that
31277 are needed. The basic syntax is as follows:
31278 .display
31279 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31280 .endd
31281 If you do not set &%av_scanner%&, it defaults to
31282 .code
31283 av_scanner = sophie:/var/run/sophie
31284 .endd
31285 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31286 before use.
31287 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31288 The following scanner types are supported in this release:
31289
31290 .vlist
31291 .vitem &%avast%&
31292 .cindex "virus scanners" "avast"
31293 This is the scanner daemon of Avast. It has been tested with Avast Core
31294 Security (currently at version 1.1.7).
31295 You can get a trial version at &url(http://www.avast.com) or for Linux
31296 at &url(http://www.avast.com/linux-server-antivirus).
31297 This scanner type takes one option,
31298 which can be either a full path to a UNIX socket,
31299 or host and port specifiers separated by white space.
31300 The host may be a name or an IP address; the port is either a
31301 single number or a pair of numbers with a dash between.
31302 Any further options are given, on separate lines,
31303 to the daemon as options before the main scan command.
31304 For example:
31305 .code
31306 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31307 av_scanner = avast:192.168.2.22 5036
31308 .endd
31309 If you omit the argument, the default path
31310 &_/var/run/avast/scan.sock_&
31311 is used.
31312 If you use a remote host,
31313 you need to make Exim's spool directory available to it,
31314 as the scanner is passed a file path, not file contents.
31315 For information about available commands and their options you may use
31316 .code
31317 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31318     FLAGS
31319     SENSITIVITY
31320     PACK
31321 .endd
31322
31323
31324 .vitem &%aveserver%&
31325 .cindex "virus scanners" "Kaspersky"
31326 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31327 at &url(http://www.kaspersky.com). This scanner type takes one option,
31328 which is the path to the daemon's UNIX socket. The default is shown in this
31329 example:
31330 .code
31331 av_scanner = aveserver:/var/run/aveserver
31332 .endd
31333
31334
31335 .vitem &%clamd%&
31336 .cindex "virus scanners" "clamd"
31337 This daemon-type scanner is GPL and free. You can get it at
31338 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31339 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31340 in the MIME ACL. This is no longer believed to be necessary.
31341
31342 The options are a list of server specifiers, which may be
31343 a UNIX socket specification,
31344 a TCP socket specification,
31345 or a (global) option.
31346
31347 A socket specification consists of a space-separated list.
31348 For a Unix socket the first element is a full path for the socket,
31349 for a TCP socket the first element is the IP address
31350 and the second a port number,
31351 Any further elements are per-server (non-global) options.
31352 These per-server options are supported:
31353 .code
31354 retry=<timespec>        Retry on connect fail
31355 .endd
31356
31357 The &`retry`& option specifies a time after which a single retry for
31358 a failed connect is made.  The default is to not retry.
31359
31360 If a Unix socket file is specified, only one server is supported.
31361
31362 Examples:
31363 .code
31364 av_scanner = clamd:/opt/clamd/socket
31365 av_scanner = clamd:192.0.2.3 1234
31366 av_scanner = clamd:192.0.2.3 1234:local
31367 av_scanner = clamd:192.0.2.3 1234 retry=10s
31368 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31369 .endd
31370 If the value of av_scanner points to a UNIX socket file or contains the
31371 &`local`&
31372 option, then the ClamAV interface will pass a filename containing the data
31373 to be scanned, which will should normally result in less I/O happening and be
31374 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31375 Exim does not assume that there is a common filesystem with the remote host.
31376 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31377 you be running a version of ClamAV prior to 0.95.
31378
31379 The final example shows that multiple TCP targets can be specified.  Exim will
31380 randomly use one for each incoming email (i.e. it load balances them).  Note
31381 that only TCP targets may be used if specifying a list of scanners; a UNIX
31382 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31383 unavailable, Exim will try the remaining one(s) until it finds one that works.
31384 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31385 not keep track of scanner state between multiple messages, and the scanner
31386 selection is random, so the message will get logged in the mainlog for each
31387 email that the down scanner gets chosen first (message wrapped to be readable):
31388 .code
31389 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31390    clamd: connection to localhost, port 3310 failed
31391    (Connection refused)
31392 .endd
31393
31394 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31395 contributing the code for this scanner.
31396
31397 .vitem &%cmdline%&
31398 .cindex "virus scanners" "command line interface"
31399 This is the keyword for the generic command line scanner interface. It can be
31400 used to attach virus scanners that are invoked from the shell. This scanner
31401 type takes 3 mandatory options:
31402
31403 .olist
31404 The full path and name of the scanner binary, with all command line options,
31405 and a placeholder (&`%s`&) for the directory to scan.
31406
31407 .next
31408 A regular expression to match against the STDOUT and STDERR output of the
31409 virus scanner. If the expression matches, a virus was found. You must make
31410 absolutely sure that this expression matches on &"virus found"&. This is called
31411 the &"trigger"& expression.
31412
31413 .next
31414 Another regular expression, containing exactly one pair of parentheses, to
31415 match the name of the virus found in the scanners output. This is called the
31416 &"name"& expression.
31417 .endlist olist
31418
31419 For example, Sophos Sweep reports a virus on a line like this:
31420 .code
31421 Virus 'W32/Magistr-B' found in file ./those.bat
31422 .endd
31423 For the trigger expression, we can match the phrase &"found in file"&. For the
31424 name expression, we want to extract the W32/Magistr-B string, so we can match
31425 for the single quotes left and right of it. Altogether, this makes the
31426 configuration setting:
31427 .code
31428 av_scanner = cmdline:\
31429              /path/to/sweep -ss -all -rec -archive %s:\
31430              found in file:'(.+)'
31431 .endd
31432 .vitem &%drweb%&
31433 .cindex "virus scanners" "DrWeb"
31434 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31435 takes one option,
31436 either a full path to a UNIX socket,
31437 or host and port specifiers separated by white space.
31438 The host may be a name or an IP address; the port is either a
31439 single number or a pair of numbers with a dash between.
31440 For example:
31441 .code
31442 av_scanner = drweb:/var/run/drwebd.sock
31443 av_scanner = drweb:192.168.2.20 31337
31444 .endd
31445 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31446 is used. Thanks to Alex Miller for contributing the code for this scanner.
31447
31448 .vitem &%f-protd%&
31449 .cindex "virus scanners" "f-protd"
31450 The f-protd scanner is accessed via HTTP over TCP.
31451 One argument is taken, being a space-separated hostname and port number
31452 (or port-range).
31453 For example:
31454 .code
31455 av_scanner = f-protd:localhost 10200-10204
31456 .endd
31457 If you omit the argument, the default values show above are used.
31458
31459 .vitem &%fsecure%&
31460 .cindex "virus scanners" "F-Secure"
31461 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31462 argument which is the path to a UNIX socket. For example:
31463 .code
31464 av_scanner = fsecure:/path/to/.fsav
31465 .endd
31466 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31467 Thelmen for contributing the code for this scanner.
31468
31469 .vitem &%kavdaemon%&
31470 .cindex "virus scanners" "Kaspersky"
31471 This is the scanner daemon of Kaspersky Version 4. This version of the
31472 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31473 scanner type takes one option, which is the path to the daemon's UNIX socket.
31474 For example:
31475 .code
31476 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31477 .endd
31478 The default path is &_/var/run/AvpCtl_&.
31479
31480 .vitem &%mksd%&
31481 .cindex "virus scanners" "mksd"
31482 This is a daemon type scanner that is aimed mainly at Polish users, though some
31483 parts of documentation are now available in English. You can get it at
31484 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31485 the maximum number of processes used simultaneously to scan the attachments,
31486 provided that mksd has
31487 been run with at least the same number of child processes. For example:
31488 .code
31489 av_scanner = mksd:2
31490 .endd
31491 You can safely omit this option (the default value is 1).
31492
31493 .vitem &%sock%&
31494 .cindex "virus scanners" "simple socket-connected"
31495 This is a general-purpose way of talking to simple scanner daemons
31496 running on the local machine.
31497 There are four options:
31498 an address (which may be an IP address and port, or the path of a Unix socket),
31499 a commandline to send (may include a single %s which will be replaced with
31500 the path to the mail file to be scanned),
31501 an RE to trigger on from the returned data,
31502 an RE to extract malware_name from the returned data.
31503 For example:
31504 .code
31505 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31506 .endd
31507 Default for the socket specifier is &_/tmp/malware.sock_&.
31508 Default for the commandline is &_%s\n_&.
31509 Both regular-expressions are required.
31510
31511 .vitem &%sophie%&
31512 .cindex "virus scanners" "Sophos and Sophie"
31513 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31514 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31515 for this scanner type is the path to the UNIX socket that Sophie uses for
31516 client communication. For example:
31517 .code
31518 av_scanner = sophie:/tmp/sophie
31519 .endd
31520 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31521 the option.
31522 .endlist
31523
31524 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31525 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31526 ACL.
31527
31528 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31529 makes it possible to use different scanners. See further below for an example.
31530 The &%malware%& condition caches its results, so when you use it multiple times
31531 for the same message, the actual scanning process is only carried out once.
31532 However, using expandable items in &%av_scanner%& disables this caching, in
31533 which case each use of the &%malware%& condition causes a new scan of the
31534 message.
31535
31536 The &%malware%& condition takes a right-hand argument that is expanded before
31537 use and taken as a list, slash-separated by default.
31538 The first element can then be one of
31539
31540 .ilist
31541 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31542 The condition succeeds if a virus was found, and fail otherwise. This is the
31543 recommended usage.
31544 .next
31545 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31546 the condition fails immediately.
31547 .next
31548 A regular expression, in which case the message is scanned for viruses. The
31549 condition succeeds if a virus is found and its name matches the regular
31550 expression. This allows you to take special actions on certain types of virus.
31551 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31552 unless the separator is changed (in the usual way).
31553 .endlist
31554
31555 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31556 messages even if there is a problem with the virus scanner.
31557 Otherwise, such a problem causes the ACL to defer.
31558
31559 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31560 specify a non-default timeout.  The default is two minutes.
31561 For example:
31562 .code
31563 malware = * / defer_ok / tmo=10s
31564 .endd
31565 A timeout causes the ACL to defer.
31566
31567 .vindex "&$callout_address$&"
31568 When a connection is made to the scanner the expansion variable &$callout_address$&
31569 is set to record the actual address used.
31570
31571 .vindex "&$malware_name$&"
31572 When a virus is found, the condition sets up an expansion variable called
31573 &$malware_name$& that contains the name of the virus. You can use it in a
31574 &%message%& modifier that specifies the error returned to the sender, and/or in
31575 logging data.
31576
31577 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31578 imposed by your anti-virus scanner.
31579
31580 Here is a very simple scanning example:
31581 .code
31582 deny message = This message contains malware ($malware_name)
31583      malware = *
31584 .endd
31585 The next example accepts messages when there is a problem with the scanner:
31586 .code
31587 deny message = This message contains malware ($malware_name)
31588      malware = */defer_ok
31589 .endd
31590 The next example shows how to use an ACL variable to scan with both sophie and
31591 aveserver. It assumes you have set:
31592 .code
31593 av_scanner = $acl_m0
31594 .endd
31595 in the main Exim configuration.
31596 .code
31597 deny message = This message contains malware ($malware_name)
31598      set acl_m0 = sophie
31599      malware = *
31600
31601 deny message = This message contains malware ($malware_name)
31602      set acl_m0 = aveserver
31603      malware = *
31604 .endd
31605
31606
31607 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31608 .cindex "content scanning" "for spam"
31609 .cindex "spam scanning"
31610 .cindex "SpamAssassin"
31611 .cindex "Rspamd"
31612 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31613 score and a report for the message.
31614 Support is also provided for Rspamd.
31615
31616 For more information about installation and configuration of SpamAssassin or
31617 Rspamd refer to their respective websites at
31618 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31619
31620 SpamAssassin can be installed with CPAN by running:
31621 .code
31622 perl -MCPAN -e 'install Mail::SpamAssassin'
31623 .endd
31624 SpamAssassin has its own set of configuration files. Please review its
31625 documentation to see how you can tweak it. The default installation should work
31626 nicely, however.
31627
31628 .oindex "&%spamd_address%&"
31629 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31630 intend to use an instance running on the local host you do not need to set
31631 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31632 you must set the &%spamd_address%& option in the global part of the Exim
31633 configuration as follows (example):
31634 .code
31635 spamd_address = 192.168.99.45 387
31636 .endd
31637
31638 To use Rspamd (which by default listens on all local addresses
31639 on TCP port 11333)
31640 you should add &%variant=rspamd%& after the address/port pair, for example:
31641 .code
31642 spamd_address = 127.0.0.1 11333 variant=rspamd
31643 .endd
31644
31645 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31646 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31647 file name instead of an address/port pair:
31648 .code
31649 spamd_address = /var/run/spamd_socket
31650 .endd
31651 You can have multiple &%spamd%& servers to improve scalability. These can
31652 reside on other hardware reachable over the network. To specify multiple
31653 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31654 option, separated with colons (the separator can be changed in the usual way):
31655 .code
31656 spamd_address = 192.168.2.10 783 : \
31657                 192.168.2.11 783 : \
31658                 192.168.2.12 783
31659 .endd
31660 Up to 32 &%spamd%& servers are supported.
31661 When a server fails to respond to the connection attempt, all other
31662 servers are tried until one succeeds. If no server responds, the &%spam%&
31663 condition defers.
31664
31665 Unix and TCP socket specifications may be mixed in any order.
31666 Each element of the list is a list itself, space-separated by default
31667 and changeable in the usual way; take care to not double the separator.
31668
31669 For TCP socket specifications a host name or IP (v4 or v6, but
31670 subject to list-separator quoting rules) address can be used,
31671 and the port can be one or a dash-separated pair.
31672 In the latter case, the range is tried in strict order.
31673
31674 Elements after the first for Unix sockets, or second for TCP socket,
31675 are options.
31676 The supported options are:
31677 .code
31678 pri=<priority>      Selection priority
31679 weight=<value>      Selection bias
31680 time=<start>-<end>  Use only between these times of day
31681 retry=<timespec>    Retry on connect fail
31682 tmo=<timespec>      Connection time limit
31683 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31684 .endd
31685
31686 The &`pri`& option specifies a priority for the server within the list,
31687 higher values being tried first.
31688 The default priority is 1.
31689
31690 The &`weight`& option specifies a selection bias.
31691 Within a priority set
31692 servers are queried in a random fashion, weighted by this value.
31693 The default value for selection bias is 1.
31694
31695 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31696 in the local time zone; each element being one or more digits.
31697 Either the seconds or both minutes and seconds, plus the leading &`.`&
31698 characters, may be omitted and will be taken as zero.
31699
31700 Timeout specifications for the &`retry`& and &`tmo`& options
31701 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31702
31703 The &`tmo`& option specifies an overall timeout for communication.
31704 The default value is two minutes.
31705
31706 The &`retry`& option specifies a time after which a single retry for
31707 a failed connect is made.
31708 The default is to not retry.
31709
31710 The &%spamd_address%& variable is expanded before use if it starts with
31711 a dollar sign. In this case, the expansion may return a string that is
31712 used as the list so that multiple spamd servers can be the result of an
31713 expansion.
31714
31715 .vindex "&$callout_address$&"
31716 When a connection is made to the server the expansion variable &$callout_address$&
31717 is set to record the actual address used.
31718
31719 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31720 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31721 .code
31722 deny message = This message was classified as SPAM
31723      spam = joe
31724 .endd
31725 The right-hand side of the &%spam%& condition specifies a name. This is
31726 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31727 to scan using a specific profile, but rather use the SpamAssassin system-wide
31728 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31729 Rspamd does not use this setting. However, you must put something on the
31730 right-hand side.
31731
31732 The name allows you to use per-domain or per-user antispam profiles in
31733 principle, but this is not straightforward in practice, because a message may
31734 have multiple recipients, not necessarily all in the same domain. Because the
31735 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31736 read the contents of the message, the variables &$local_part$& and &$domain$&
31737 are not set.
31738 Careful enforcement of single-recipient messages
31739 (e.g. by responding with defer in the recipient ACL for all recipients
31740 after the first),
31741 or the use of PRDR,
31742 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31743 are needed to use this feature.
31744
31745 The right-hand side of the &%spam%& condition is expanded before being used, so
31746 you can put lookups or conditions there. When the right-hand side evaluates to
31747 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31748
31749
31750 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31751 large ones may cause significant performance degradation. As most spam messages
31752 are quite small, it is recommended that you do not scan the big ones. For
31753 example:
31754 .code
31755 deny message = This message was classified as SPAM
31756      condition = ${if < {$message_size}{10K}}
31757      spam = nobody
31758 .endd
31759
31760 The &%spam%& condition returns true if the threshold specified in the user's
31761 SpamAssassin profile has been matched or exceeded. If you want to use the
31762 &%spam%& condition for its side effects (see the variables below), you can make
31763 it always return &"true"& by appending &`:true`& to the username.
31764
31765 .cindex "spam scanning" "returned variables"
31766 When the &%spam%& condition is run, it sets up a number of expansion
31767 variables.
31768 Except for &$spam_report$&,
31769 these variables are saved with the received message so are
31770 available for use at delivery time.
31771
31772 .vlist
31773 .vitem &$spam_score$&
31774 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31775 for inclusion in log or reject messages.
31776
31777 .vitem &$spam_score_int$&
31778 The spam score of the message, multiplied by ten, as an integer value. For
31779 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31780 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31781 The integer value is useful for numeric comparisons in conditions.
31782
31783 .vitem &$spam_bar$&
31784 A string consisting of a number of &"+"& or &"-"& characters, representing the
31785 integer part of the spam score value. A spam score of 4.4 would have a
31786 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31787 headers, since MUAs can match on such strings. The maximum length of the
31788 spam bar is 50 characters.
31789
31790 .vitem &$spam_report$&
31791 A multiline text table, containing the full SpamAssassin report for the
31792 message. Useful for inclusion in headers or reject messages.
31793 This variable is only usable in a DATA-time ACL.
31794 .new
31795 Beware that SpamAssassin may return non-ASCII characters, especially
31796 when running in country-specific locales, which are not legal
31797 unencoded in headers.
31798 .wen
31799
31800 .vitem &$spam_action$&
31801 For SpamAssassin either 'reject' or 'no action' depending on the
31802 spam score versus threshold.
31803 For Rspamd, the recommended action.
31804
31805 .endlist
31806
31807 The &%spam%& condition caches its results unless expansion in
31808 spamd_address was used. If you call it again with the same user name, it
31809 does not scan again, but rather returns the same values as before.
31810
31811 The &%spam%& condition returns DEFER if there is any error while running
31812 the message through SpamAssassin or if the expansion of spamd_address
31813 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31814 statement block), append &`/defer_ok`& to the right-hand side of the
31815 spam condition, like this:
31816 .code
31817 deny message = This message was classified as SPAM
31818      spam    = joe/defer_ok
31819 .endd
31820 This causes messages to be accepted even if there is a problem with &%spamd%&.
31821
31822 Here is a longer, commented example of the use of the &%spam%&
31823 condition:
31824 .code
31825 # put headers in all messages (no matter if spam or not)
31826 warn  spam = nobody:true
31827       add_header = X-Spam-Score: $spam_score ($spam_bar)
31828       add_header = X-Spam-Report: $spam_report
31829
31830 # add second subject line with *SPAM* marker when message
31831 # is over threshold
31832 warn  spam = nobody
31833       add_header = Subject: *SPAM* $h_Subject:
31834
31835 # reject spam at high scores (> 12)
31836 deny  message = This message scored $spam_score spam points.
31837       spam = nobody:true
31838       condition = ${if >{$spam_score_int}{120}{1}{0}}
31839 .endd
31840
31841
31842
31843 .section "Scanning MIME parts" "SECTscanmimepart"
31844 .cindex "content scanning" "MIME parts"
31845 .cindex "MIME content scanning"
31846 .oindex "&%acl_smtp_mime%&"
31847 .oindex "&%acl_not_smtp_mime%&"
31848 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31849 each MIME part of an SMTP message, including multipart types, in the sequence
31850 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31851 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31852 options may both refer to the same ACL if you want the same processing in both
31853 cases.
31854
31855 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31856 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31857 the case of a non-SMTP message. However, a MIME ACL is called only if the
31858 message contains a &'Content-Type:'& header line. When a call to a MIME
31859 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31860 result code is sent to the client. In the case of an SMTP message, the
31861 &%acl_smtp_data%& ACL is not called when this happens.
31862
31863 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31864 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31865 condition to match against the raw MIME part. You can also use the
31866 &%mime_regex%& condition to match against the decoded MIME part (see section
31867 &<<SECTscanregex>>&).
31868
31869 At the start of a MIME ACL, a number of variables are set from the header
31870 information for the relevant MIME part. These are described below. The contents
31871 of the MIME part are not by default decoded into a disk file except for MIME
31872 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31873 part into a disk file, you can use the &%decode%& condition. The general
31874 syntax is:
31875 .display
31876 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31877 .endd
31878 The right hand side is expanded before use. After expansion,
31879 the value can be:
31880
31881 .olist
31882 &"0"& or &"false"&, in which case no decoding is done.
31883 .next
31884 The string &"default"&. In that case, the file is put in the temporary
31885 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31886 a sequential file name consisting of the message id and a sequence number. The
31887 full path and name is available in &$mime_decoded_filename$& after decoding.
31888 .next
31889 A full path name starting with a slash. If the full name is an existing
31890 directory, it is used as a replacement for the default directory. The filename
31891 is then sequentially assigned. If the path does not exist, it is used as
31892 the full path and file name.
31893 .next
31894 If the string does not start with a slash, it is used as the
31895 filename, and the default path is then used.
31896 .endlist
31897 The &%decode%& condition normally succeeds. It is only false for syntax
31898 errors or unusual circumstances such as memory shortages. You can easily decode
31899 a file with its original, proposed filename using
31900 .code
31901 decode = $mime_filename
31902 .endd
31903 However, you should keep in mind that &$mime_filename$& might contain
31904 anything. If you place files outside of the default path, they are not
31905 automatically unlinked.
31906
31907 For RFC822 attachments (these are messages attached to messages, with a
31908 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31909 as for the primary message, only that the &$mime_is_rfc822$& expansion
31910 variable is set (see below). Attached messages are always decoded to disk
31911 before being checked, and the files are unlinked once the check is done.
31912
31913 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31914 used to match regular expressions against raw and decoded MIME parts,
31915 respectively. They are described in section &<<SECTscanregex>>&.
31916
31917 .cindex "MIME content scanning" "returned variables"
31918 The following list describes all expansion variables that are
31919 available in the MIME ACL:
31920
31921 .vlist
31922 .vitem &$mime_boundary$&
31923 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31924 have a boundary string, which is stored in this variable. If the current part
31925 has no boundary parameter in the &'Content-Type:'& header, this variable
31926 contains the empty string.
31927
31928 .vitem &$mime_charset$&
31929 This variable contains the character set identifier, if one was found in the
31930 &'Content-Type:'& header. Examples for charset identifiers are:
31931 .code
31932 us-ascii
31933 gb2312 (Chinese)
31934 iso-8859-1
31935 .endd
31936 Please note that this value is not normalized, so you should do matches
31937 case-insensitively.
31938
31939 .vitem &$mime_content_description$&
31940 This variable contains the normalized content of the &'Content-Description:'&
31941 header. It can contain a human-readable description of the parts content. Some
31942 implementations repeat the filename for attachments here, but they are usually
31943 only used for display purposes.
31944
31945 .vitem &$mime_content_disposition$&
31946 This variable contains the normalized content of the &'Content-Disposition:'&
31947 header. You can expect strings like &"attachment"& or &"inline"& here.
31948
31949 .vitem &$mime_content_id$&
31950 This variable contains the normalized content of the &'Content-ID:'& header.
31951 This is a unique ID that can be used to reference a part from another part.
31952
31953 .vitem &$mime_content_size$&
31954 This variable is set only after the &%decode%& modifier (see above) has been
31955 successfully run. It contains the size of the decoded part in kilobytes. The
31956 size is always rounded up to full kilobytes, so only a completely empty part
31957 has a &$mime_content_size$& of zero.
31958
31959 .vitem &$mime_content_transfer_encoding$&
31960 This variable contains the normalized content of the
31961 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31962 type. Typical values are &"base64"& and &"quoted-printable"&.
31963
31964 .vitem &$mime_content_type$&
31965 If the MIME part has a &'Content-Type:'& header, this variable contains its
31966 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31967 are some examples of popular MIME types, as they may appear in this variable:
31968 .code
31969 text/plain
31970 text/html
31971 application/octet-stream
31972 image/jpeg
31973 audio/midi
31974 .endd
31975 If the MIME part has no &'Content-Type:'& header, this variable contains the
31976 empty string.
31977
31978 .vitem &$mime_decoded_filename$&
31979 This variable is set only after the &%decode%& modifier (see above) has been
31980 successfully run. It contains the full path and file name of the file
31981 containing the decoded data.
31982 .endlist
31983
31984 .cindex "RFC 2047"
31985 .vlist
31986 .vitem &$mime_filename$&
31987 This is perhaps the most important of the MIME variables. It contains a
31988 proposed filename for an attachment, if one was found in either the
31989 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31990 RFC2047
31991 or RFC2231
31992 decoded, but no additional sanity checks are done.
31993  If no filename was
31994 found, this variable contains the empty string.
31995
31996 .vitem &$mime_is_coverletter$&
31997 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31998 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31999 content in the cover letter, while not restricting attachments at all.
32000
32001 The variable contains 1 (true) for a MIME part believed to be part of the
32002 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32003 follows:
32004
32005 .olist
32006 The outermost MIME part of a message is always a cover letter.
32007
32008 .next
32009 If a multipart/alternative or multipart/related MIME part is a cover letter,
32010 so are all MIME subparts within that multipart.
32011
32012 .next
32013 If any other multipart is a cover letter, the first subpart is a cover letter,
32014 and the rest are attachments.
32015
32016 .next
32017 All parts contained within an attachment multipart are attachments.
32018 .endlist olist
32019
32020 As an example, the following will ban &"HTML mail"& (including that sent with
32021 alternative plain text), while allowing HTML files to be attached. HTML
32022 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32023 .code
32024 deny message = HTML mail is not accepted here
32025 !condition = $mime_is_rfc822
32026 condition = $mime_is_coverletter
32027 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32028 .endd
32029 .vitem &$mime_is_multipart$&
32030 This variable has the value 1 (true) when the current part has the main type
32031 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32032 Since multipart entities only serve as containers for other parts, you may not
32033 want to carry out specific actions on them.
32034
32035 .vitem &$mime_is_rfc822$&
32036 This variable has the value 1 (true) if the current part is not a part of the
32037 checked message itself, but part of an attached message. Attached message
32038 decoding is fully recursive.
32039
32040 .vitem &$mime_part_count$&
32041 This variable is a counter that is raised for each processed MIME part. It
32042 starts at zero for the very first part (which is usually a multipart). The
32043 counter is per-message, so it is reset when processing RFC822 attachments (see
32044 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32045 complete, so you can use it in the DATA ACL to determine the number of MIME
32046 parts of a message. For non-MIME messages, this variable contains the value -1.
32047 .endlist
32048
32049
32050
32051 .section "Scanning with regular expressions" "SECTscanregex"
32052 .cindex "content scanning" "with regular expressions"
32053 .cindex "regular expressions" "content scanning with"
32054 You can specify your own custom regular expression matches on the full body of
32055 the message, or on individual MIME parts.
32056
32057 The &%regex%& condition takes one or more regular expressions as arguments and
32058 matches them against the full message (when called in the DATA ACL) or a raw
32059 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32060 linewise, with a maximum line length of 32K characters. That means you cannot
32061 have multiline matches with the &%regex%& condition.
32062
32063 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32064 to 32K of decoded content (the whole content at once, not linewise). If the
32065 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32066 is decoded automatically when &%mime_regex%& is executed (using default path
32067 and filename values). If the decoded data is larger than  32K, only the first
32068 32K characters are checked.
32069
32070 The regular expressions are passed as a colon-separated list. To include a
32071 literal colon, you must double it. Since the whole right-hand side string is
32072 expanded before being used, you must also escape dollar signs and backslashes
32073 with more backslashes, or use the &`\N`& facility to disable expansion.
32074 Here is a simple example that contains two regular expressions:
32075 .code
32076 deny message = contains blacklisted regex ($regex_match_string)
32077      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32078 .endd
32079 The conditions returns true if any one of the regular expressions matches. The
32080 &$regex_match_string$& expansion variable is then set up and contains the
32081 matching regular expression.
32082 The expansion variables &$regex1$& &$regex2$& etc
32083 are set to any substrings captured by the regular expression.
32084
32085 &*Warning*&: With large messages, these conditions can be fairly
32086 CPU-intensive.
32087
32088 .ecindex IIDcosca
32089
32090
32091
32092
32093 . ////////////////////////////////////////////////////////////////////////////
32094 . ////////////////////////////////////////////////////////////////////////////
32095
32096 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32097          "Local scan function"
32098 .scindex IIDlosca "&[local_scan()]& function" "description of"
32099 .cindex "customizing" "input scan using C function"
32100 .cindex "policy control" "by local scan function"
32101 In these days of email worms, viruses, and ever-increasing spam, some sites
32102 want to apply a lot of checking to messages before accepting them.
32103
32104 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32105 passing messages to external virus and spam scanning software. You can also do
32106 a certain amount in Exim itself through string expansions and the &%condition%&
32107 condition in the ACL that runs after the SMTP DATA command or the ACL for
32108 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32109
32110 To allow for further customization to a site's own requirements, there is the
32111 possibility of linking Exim with a private message scanning function, written
32112 in C. If you want to run code that is written in something other than C, you
32113 can of course use a little C stub to call it.
32114
32115 The local scan function is run once for every incoming message, at the point
32116 when Exim is just about to accept the message.
32117 It can therefore be used to control non-SMTP messages from local processes as
32118 well as messages arriving via SMTP.
32119
32120 Exim applies a timeout to calls of the local scan function, and there is an
32121 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32122 Zero means &"no timeout"&.
32123 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32124 before calling the local scan function, so that the most common types of crash
32125 are caught. If the timeout is exceeded or one of those signals is caught, the
32126 incoming message is rejected with a temporary error if it is an SMTP message.
32127 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32128 code. The incident is logged on the main and reject logs.
32129
32130
32131
32132 .section "Building Exim to use a local scan function" "SECID207"
32133 .cindex "&[local_scan()]& function" "building Exim to use"
32134 To make use of the local scan function feature, you must tell Exim where your
32135 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32136 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32137 directory, so you might set
32138 .code
32139 LOCAL_SCAN_SOURCE=Local/local_scan.c
32140 .endd
32141 for example. The function must be called &[local_scan()]&. It is called by
32142 Exim after it has received a message, when the success return code is about to
32143 be sent. This is after all the ACLs have been run. The return code from your
32144 function controls whether the message is actually accepted or not. There is a
32145 commented template function (that just accepts the message) in the file
32146 _src/local_scan.c_.
32147
32148 If you want to make use of Exim's run time configuration file to set options
32149 for your &[local_scan()]& function, you must also set
32150 .code
32151 LOCAL_SCAN_HAS_OPTIONS=yes
32152 .endd
32153 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32154
32155
32156
32157
32158 .section "API for local_scan()" "SECTapiforloc"
32159 .cindex "&[local_scan()]& function" "API description"
32160 You must include this line near the start of your code:
32161 .code
32162 #include "local_scan.h"
32163 .endd
32164 This header file defines a number of variables and other values, and the
32165 prototype for the function itself. Exim is coded to use unsigned char values
32166 almost exclusively, and one of the things this header defines is a shorthand
32167 for &`unsigned char`& called &`uschar`&.
32168 It also contains the following macro definitions, to simplify casting character
32169 strings and pointers to character strings:
32170 .code
32171 #define CS   (char *)
32172 #define CCS  (const char *)
32173 #define CSS  (char **)
32174 #define US   (unsigned char *)
32175 #define CUS  (const unsigned char *)
32176 #define USS  (unsigned char **)
32177 .endd
32178 The function prototype for &[local_scan()]& is:
32179 .code
32180 extern int local_scan(int fd, uschar **return_text);
32181 .endd
32182 The arguments are as follows:
32183
32184 .ilist
32185 &%fd%& is a file descriptor for the file that contains the body of the message
32186 (the -D file). The file is open for reading and writing, but updating it is not
32187 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32188
32189 The descriptor is positioned at character 19 of the file, which is the first
32190 character of the body itself, because the first 19 characters are the message
32191 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32192 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32193 case this changes in some future version.
32194 .next
32195 &%return_text%& is an address which you can use to return a pointer to a text
32196 string at the end of the function. The value it points to on entry is NULL.
32197 .endlist
32198
32199 The function must return an &%int%& value which is one of the following macros:
32200
32201 .vlist
32202 .vitem &`LOCAL_SCAN_ACCEPT`&
32203 .vindex "&$local_scan_data$&"
32204 The message is accepted. If you pass back a string of text, it is saved with
32205 the message, and made available in the variable &$local_scan_data$&. No
32206 newlines are permitted (if there are any, they are turned into spaces) and the
32207 maximum length of text is 1000 characters.
32208
32209 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32210 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32211 queued without immediate delivery, and is frozen.
32212
32213 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32214 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32215 queued without immediate delivery.
32216
32217 .vitem &`LOCAL_SCAN_REJECT`&
32218 The message is rejected; the returned text is used as an error message which is
32219 passed back to the sender and which is also logged. Newlines are permitted &--
32220 they cause a multiline response for SMTP rejections, but are converted to
32221 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32222 used.
32223
32224 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32225 The message is temporarily rejected; the returned text is used as an error
32226 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32227 problem"& is used.
32228
32229 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32230 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32231 message is not written to the reject log. It has the effect of unsetting the
32232 &%rejected_header%& log selector for just this rejection. If
32233 &%rejected_header%& is already unset (see the discussion of the
32234 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32235 same as LOCAL_SCAN_REJECT.
32236
32237 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32238 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32239 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32240 .endlist
32241
32242 If the message is not being received by interactive SMTP, rejections are
32243 reported by writing to &%stderr%& or by sending an email, as configured by the
32244 &%-oe%& command line options.
32245
32246
32247
32248 .section "Configuration options for local_scan()" "SECTconoptloc"
32249 .cindex "&[local_scan()]& function" "configuration options"
32250 It is possible to have option settings in the main configuration file
32251 that set values in static variables in the &[local_scan()]& module. If you
32252 want to do this, you must have the line
32253 .code
32254 LOCAL_SCAN_HAS_OPTIONS=yes
32255 .endd
32256 in your &_Local/Makefile_& when you build Exim. (This line is in
32257 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32258 file, you must define static variables to hold the option values, and a table
32259 to define them.
32260
32261 The table must be a vector called &%local_scan_options%&, of type
32262 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32263 and a pointer to the variable that holds the value. The entries must appear in
32264 alphabetical order. Following &%local_scan_options%& you must also define a
32265 variable called &%local_scan_options_count%& that contains the number of
32266 entries in the table. Here is a short example, showing two kinds of option:
32267 .code
32268 static int my_integer_option = 42;
32269 static uschar *my_string_option = US"a default string";
32270
32271 optionlist local_scan_options[] = {
32272   { "my_integer", opt_int,       &my_integer_option },
32273   { "my_string",  opt_stringptr, &my_string_option }
32274 };
32275
32276 int local_scan_options_count =
32277   sizeof(local_scan_options)/sizeof(optionlist);
32278 .endd
32279 The values of the variables can now be changed from Exim's runtime
32280 configuration file by including a local scan section as in this example:
32281 .code
32282 begin local_scan
32283 my_integer = 99
32284 my_string = some string of text...
32285 .endd
32286 The available types of option data are as follows:
32287
32288 .vlist
32289 .vitem &*opt_bool*&
32290 This specifies a boolean (true/false) option. The address should point to a
32291 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32292 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32293 whether such a variable has been set at all, you can initialize it to
32294 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32295 values.)
32296
32297 .vitem &*opt_fixed*&
32298 This specifies a fixed point number, such as is used for load averages.
32299 The address should point to a variable of type &`int`&. The value is stored
32300 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32301
32302 .vitem &*opt_int*&
32303 This specifies an integer; the address should point to a variable of type
32304 &`int`&. The value may be specified in any of the integer formats accepted by
32305 Exim.
32306
32307 .vitem &*opt_mkint*&
32308 This is the same as &%opt_int%&, except that when such a value is output in a
32309 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32310 printed with the suffix K or M.
32311
32312 .vitem &*opt_octint*&
32313 This also specifies an integer, but the value is always interpreted as an
32314 octal integer, whether or not it starts with the digit zero, and it is
32315 always output in octal.
32316
32317 .vitem &*opt_stringptr*&
32318 This specifies a string value; the address must be a pointer to a
32319 variable that points to a string (for example, of type &`uschar *`&).
32320
32321 .vitem &*opt_time*&
32322 This specifies a time interval value. The address must point to a variable of
32323 type &`int`&. The value that is placed there is a number of seconds.
32324 .endlist
32325
32326 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32327 out the values of all the &[local_scan()]& options.
32328
32329
32330
32331 .section "Available Exim variables" "SECID208"
32332 .cindex "&[local_scan()]& function" "available Exim variables"
32333 The header &_local_scan.h_& gives you access to a number of C variables. These
32334 are the only ones that are guaranteed to be maintained from release to release.
32335 Note, however, that you can obtain the value of any Exim expansion variable,
32336 including &$recipients$&, by calling &'expand_string()'&. The exported
32337 C variables are as follows:
32338
32339 .vlist
32340 .vitem &*int&~body_linecount*&
32341 This variable contains the number of lines in the message's body.
32342
32343 .vitem &*int&~body_zerocount*&
32344 This variable contains the number of binary zero bytes in the message's body.
32345
32346 .vitem &*unsigned&~int&~debug_selector*&
32347 This variable is set to zero when no debugging is taking place. Otherwise, it
32348 is a bitmap of debugging selectors. Two bits are identified for use in
32349 &[local_scan()]&; they are defined as macros:
32350
32351 .ilist
32352 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32353 testing option that is not privileged &-- any caller may set it. All the
32354 other selector bits can be set only by admin users.
32355
32356 .next
32357 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32358 by the &`+local_scan`& debug selector. It is not included in the default set
32359 of debugging bits.
32360 .endlist ilist
32361
32362 Thus, to write to the debugging output only when &`+local_scan`& has been
32363 selected, you should use code like this:
32364 .code
32365 if ((debug_selector & D_local_scan) != 0)
32366   debug_printf("xxx", ...);
32367 .endd
32368 .vitem &*uschar&~*expand_string_message*&
32369 After a failing call to &'expand_string()'& (returned value NULL), the
32370 variable &%expand_string_message%& contains the error message, zero-terminated.
32371
32372 .vitem &*header_line&~*header_list*&
32373 A pointer to a chain of header lines. The &%header_line%& structure is
32374 discussed below.
32375
32376 .vitem &*header_line&~*header_last*&
32377 A pointer to the last of the header lines.
32378
32379 .vitem &*uschar&~*headers_charset*&
32380 The value of the &%headers_charset%& configuration option.
32381
32382 .vitem &*BOOL&~host_checking*&
32383 This variable is TRUE during a host checking session that is initiated by the
32384 &%-bh%& command line option.
32385
32386 .vitem &*uschar&~*interface_address*&
32387 The IP address of the interface that received the message, as a string. This
32388 is NULL for locally submitted messages.
32389
32390 .vitem &*int&~interface_port*&
32391 The port on which this message was received. When testing with the &%-bh%&
32392 command line option, the value of this variable is -1 unless a port has been
32393 specified via the &%-oMi%& option.
32394
32395 .vitem &*uschar&~*message_id*&
32396 This variable contains Exim's message id for the incoming message (the value of
32397 &$message_exim_id$&) as a zero-terminated string.
32398
32399 .vitem &*uschar&~*received_protocol*&
32400 The name of the protocol by which the message was received.
32401
32402 .vitem &*int&~recipients_count*&
32403 The number of accepted recipients.
32404
32405 .vitem &*recipient_item&~*recipients_list*&
32406 .cindex "recipient" "adding in local scan"
32407 .cindex "recipient" "removing in local scan"
32408 The list of accepted recipients, held in a vector of length
32409 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32410 can add additional recipients by calling &'receive_add_recipient()'& (see
32411 below). You can delete recipients by removing them from the vector and
32412 adjusting the value in &%recipients_count%&. In particular, by setting
32413 &%recipients_count%& to zero you remove all recipients. If you then return the
32414 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32415 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32416 and then call &'receive_add_recipient()'& as often as needed.
32417
32418 .vitem &*uschar&~*sender_address*&
32419 The envelope sender address. For bounce messages this is the empty string.
32420
32421 .vitem &*uschar&~*sender_host_address*&
32422 The IP address of the sending host, as a string. This is NULL for
32423 locally-submitted messages.
32424
32425 .vitem &*uschar&~*sender_host_authenticated*&
32426 The name of the authentication mechanism that was used, or NULL if the message
32427 was not received over an authenticated SMTP connection.
32428
32429 .vitem &*uschar&~*sender_host_name*&
32430 The name of the sending host, if known.
32431
32432 .vitem &*int&~sender_host_port*&
32433 The port on the sending host.
32434
32435 .vitem &*BOOL&~smtp_input*&
32436 This variable is TRUE for all SMTP input, including BSMTP.
32437
32438 .vitem &*BOOL&~smtp_batched_input*&
32439 This variable is TRUE for BSMTP input.
32440
32441 .vitem &*int&~store_pool*&
32442 The contents of this variable control which pool of memory is used for new
32443 requests. See section &<<SECTmemhanloc>>& for details.
32444 .endlist
32445
32446
32447 .section "Structure of header lines" "SECID209"
32448 The &%header_line%& structure contains the members listed below.
32449 You can add additional header lines by calling the &'header_add()'& function
32450 (see below). You can cause header lines to be ignored (deleted) by setting
32451 their type to *.
32452
32453
32454 .vlist
32455 .vitem &*struct&~header_line&~*next*&
32456 A pointer to the next header line, or NULL for the last line.
32457
32458 .vitem &*int&~type*&
32459 A code identifying certain headers that Exim recognizes. The codes are printing
32460 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32461 Notice in particular that any header line whose type is * is not transmitted
32462 with the message. This flagging is used for header lines that have been
32463 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32464 lines.) Effectively, * means &"deleted"&.
32465
32466 .vitem &*int&~slen*&
32467 The number of characters in the header line, including the terminating and any
32468 internal newlines.
32469
32470 .vitem &*uschar&~*text*&
32471 A pointer to the text of the header. It always ends with a newline, followed by
32472 a zero byte. Internal newlines are preserved.
32473 .endlist
32474
32475
32476
32477 .section "Structure of recipient items" "SECID210"
32478 The &%recipient_item%& structure contains these members:
32479
32480 .vlist
32481 .vitem &*uschar&~*address*&
32482 This is a pointer to the recipient address as it was received.
32483
32484 .vitem &*int&~pno*&
32485 This is used in later Exim processing when top level addresses are created by
32486 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32487 and must always contain -1 at this stage.
32488
32489 .vitem &*uschar&~*errors_to*&
32490 If this value is not NULL, bounce messages caused by failing to deliver to the
32491 recipient are sent to the address it contains. In other words, it overrides the
32492 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32493 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32494 an unqualified address, Exim qualifies it using the domain from
32495 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32496 is NULL for all recipients.
32497 .endlist
32498
32499
32500
32501 .section "Available Exim functions" "SECID211"
32502 .cindex "&[local_scan()]& function" "available Exim functions"
32503 The header &_local_scan.h_& gives you access to a number of Exim functions.
32504 These are the only ones that are guaranteed to be maintained from release to
32505 release:
32506
32507 .vlist
32508 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32509        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32510
32511 This function creates a child process that runs the command specified by
32512 &%argv%&. The environment for the process is specified by &%envp%&, which can
32513 be NULL if no environment variables are to be passed. A new umask is supplied
32514 for the process in &%newumask%&.
32515
32516 Pipes to the standard input and output of the new process are set up
32517 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32518 standard error is cloned to the standard output. If there are any file
32519 descriptors &"in the way"& in the new process, they are closed. If the final
32520 argument is TRUE, the new process is made into a process group leader.
32521
32522 The function returns the pid of the new process, or -1 if things go wrong.
32523
32524 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32525 This function waits for a child process to terminate, or for a timeout (in
32526 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32527 return value is as follows:
32528
32529 .ilist
32530 >= 0
32531
32532 The process terminated by a normal exit and the value is the process
32533 ending status.
32534
32535 .next
32536 < 0 and > &--256
32537
32538 The process was terminated by a signal and the value is the negation of the
32539 signal number.
32540
32541 .next
32542 &--256
32543
32544 The process timed out.
32545 .next
32546 &--257
32547
32548 The was some other error in wait(); &%errno%& is still set.
32549 .endlist
32550
32551 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32552 This function provide you with a means of submitting a new message to
32553 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32554 want, but this packages it all up for you.) The function creates a pipe,
32555 forks a subprocess that is running
32556 .code
32557 exim -t -oem -oi -f <>
32558 .endd
32559 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32560 that is connected to the standard input. The yield of the function is the PID
32561 of the subprocess. You can then write a message to the file descriptor, with
32562 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32563
32564 When you have finished, call &'child_close()'& to wait for the process to
32565 finish and to collect its ending status. A timeout value of zero is usually
32566 fine in this circumstance. Unless you have made a mistake with the recipient
32567 addresses, you should get a return code of zero.
32568
32569
32570 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32571        *sender_authentication)*&
32572 This function is a more sophisticated version of &'child_open()'&. The command
32573 that it runs is:
32574 .display
32575 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32576 .endd
32577 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32578
32579
32580 .vitem &*void&~debug_printf(char&~*,&~...)*&
32581 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32582 output is written to the standard error stream. If no debugging is selected,
32583 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32584 conditional on the &`local_scan`& debug selector by coding like this:
32585 .code
32586 if ((debug_selector & D_local_scan) != 0)
32587   debug_printf("xxx", ...);
32588 .endd
32589
32590 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32591 This is an interface to Exim's string expansion code. The return value is the
32592 expanded string, or NULL if there was an expansion failure.
32593 The C variable &%expand_string_message%& contains an error message after an
32594 expansion failure. If expansion does not change the string, the return value is
32595 the pointer to the input string. Otherwise, the return value points to a new
32596 block of memory that was obtained by a call to &'store_get()'&. See section
32597 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32598
32599 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32600 This function allows you to an add additional header line at the end of the
32601 existing ones. The first argument is the type, and should normally be a space
32602 character. The second argument is a format string and any number of
32603 substitution arguments as for &[sprintf()]&. You may include internal newlines
32604 if you want, and you must ensure that the string ends with a newline.
32605
32606 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32607         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32608 This function adds a new header line at a specified point in the header
32609 chain. The header itself is specified as for &'header_add()'&.
32610
32611 If &%name%& is NULL, the new header is added at the end of the chain if
32612 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32613 NULL, the header lines are searched for the first non-deleted header that
32614 matches the name. If one is found, the new header is added before it if
32615 &%after%& is false. If &%after%& is true, the new header is added after the
32616 found header and any adjacent subsequent ones with the same name (even if
32617 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32618 option controls where the header is added. If it is true, addition is at the
32619 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32620 headers, or at the top if there are no &'Received:'& headers, you could use
32621 .code
32622 header_add_at_position(TRUE, US"Received", TRUE,
32623   ' ', "X-xxx: ...");
32624 .endd
32625 Normally, there is always at least one non-deleted &'Received:'& header, but
32626 there may not be if &%received_header_text%& expands to an empty string.
32627
32628
32629 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32630 This function removes header lines. If &%occurrence%& is zero or negative, all
32631 occurrences of the header are removed. If occurrence is greater than zero, that
32632 particular instance of the header is removed. If no header(s) can be found that
32633 match the specification, the function does nothing.
32634
32635
32636 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32637         int&~length,&~BOOL&~notdel)*&"
32638 This function tests whether the given header has the given name. It is not just
32639 a string comparison, because white space is permitted between the name and the
32640 colon. If the &%notdel%& argument is true, a false return is forced for all
32641 &"deleted"& headers; otherwise they are not treated specially. For example:
32642 .code
32643 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32644 .endd
32645 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32646 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32647 This function base64-encodes a string, which is passed by address and length.
32648 The text may contain bytes of any value, including zero. The result is passed
32649 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32650 zero-terminated.
32651
32652 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32653 This function decodes a base64-encoded string. Its arguments are a
32654 zero-terminated base64-encoded string and the address of a variable that is set
32655 to point to the result, which is in dynamic memory. The length of the decoded
32656 string is the yield of the function. If the input is invalid base64 data, the
32657 yield is -1. A zero byte is added to the end of the output string to make it
32658 easy to interpret as a C string (assuming it contains no zeros of its own). The
32659 added zero byte is not included in the returned count.
32660
32661 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32662 This function checks for a match in a domain list. Domains are always
32663 matched caselessly. The return value is one of the following:
32664 .display
32665 &`OK     `& match succeeded
32666 &`FAIL   `& match failed
32667 &`DEFER  `& match deferred
32668 .endd
32669 DEFER is usually caused by some kind of lookup defer, such as the
32670 inability to contact a database.
32671
32672 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32673         BOOL&~caseless)*&"
32674 This function checks for a match in a local part list. The third argument
32675 controls case-sensitivity. The return values are as for
32676 &'lss_match_domain()'&.
32677
32678 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32679         BOOL&~caseless)*&"
32680 This function checks for a match in an address list. The third argument
32681 controls the case-sensitivity of the local part match. The domain is always
32682 matched caselessly. The return values are as for &'lss_match_domain()'&.
32683
32684 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32685         uschar&~*list)*&"
32686 This function checks for a match in a host list. The most common usage is
32687 expected to be
32688 .code
32689 lss_match_host(sender_host_name, sender_host_address, ...)
32690 .endd
32691 .vindex "&$sender_host_address$&"
32692 An empty address field matches an empty item in the host list. If the host name
32693 is NULL, the name corresponding to &$sender_host_address$& is automatically
32694 looked up if a host name is required to match an item in the list. The return
32695 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32696 returns ERROR in the case when it had to look up a host name, but the lookup
32697 failed.
32698
32699 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32700         *format,&~...)*&"
32701 This function writes to Exim's log files. The first argument should be zero (it
32702 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32703 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32704 them. It specifies to which log or logs the message is written. The remaining
32705 arguments are a format and relevant insertion arguments. The string should not
32706 contain any newlines, not even at the end.
32707
32708
32709 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32710 This function adds an additional recipient to the message. The first argument
32711 is the recipient address. If it is unqualified (has no domain), it is qualified
32712 with the &%qualify_recipient%& domain. The second argument must always be -1.
32713
32714 This function does not allow you to specify a private &%errors_to%& address (as
32715 described with the structure of &%recipient_item%& above), because it pre-dates
32716 the addition of that field to the structure. However, it is easy to add such a
32717 value afterwards. For example:
32718 .code
32719  receive_add_recipient(US"monitor@mydom.example", -1);
32720  recipients_list[recipients_count-1].errors_to =
32721    US"postmaster@mydom.example";
32722 .endd
32723
32724 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32725 This is a convenience function to remove a named recipient from the list of
32726 recipients. It returns true if a recipient was removed, and false if no
32727 matching recipient could be found. The argument must be a complete email
32728 address.
32729 .endlist
32730
32731
32732 .cindex "RFC 2047"
32733 .vlist
32734 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32735   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32736 This function decodes strings that are encoded according to RFC 2047. Typically
32737 these are the contents of header lines. First, each &"encoded word"& is decoded
32738 from the Q or B encoding into a byte-string. Then, if provided with the name of
32739 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32740 made  to translate the result to the named character set. If this fails, the
32741 binary string is returned with an error message.
32742
32743 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32744 maximum MIME word length is enforced. The third argument is the target
32745 encoding, or NULL if no translation is wanted.
32746
32747 .cindex "binary zero" "in RFC 2047 decoding"
32748 .cindex "RFC 2047" "binary zero in"
32749 If a binary zero is encountered in the decoded string, it is replaced by the
32750 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32751 not be 0 because header lines are handled as zero-terminated strings.
32752
32753 The function returns the result of processing the string, zero-terminated; if
32754 &%lenptr%& is not NULL, the length of the result is set in the variable to
32755 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32756
32757 If an error is encountered, the function returns NULL and uses the &%error%&
32758 argument to return an error message. The variable pointed to by &%error%& is
32759 set to NULL if there is no error; it may be set non-NULL even when the function
32760 returns a non-NULL value if decoding was successful, but there was a problem
32761 with translation.
32762
32763
32764 .vitem &*int&~smtp_fflush(void)*&
32765 This function is used in conjunction with &'smtp_printf()'&, as described
32766 below.
32767
32768 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32769 The arguments of this function are like &[printf()]&; it writes to the SMTP
32770 output stream. You should use this function only when there is an SMTP output
32771 stream, that is, when the incoming message is being received via interactive
32772 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32773 is FALSE. If you want to test for an incoming message from another host (as
32774 opposed to a local process that used the &%-bs%& command line option), you can
32775 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32776 is involved.
32777
32778 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32779 output function, so it can be used for all forms of SMTP connection.
32780
32781 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32782 must start with an appropriate response code: 550 if you are going to return
32783 LOCAL_SCAN_REJECT, 451 if you are going to return
32784 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32785 initial lines of a multi-line response, the code must be followed by a hyphen
32786 to indicate that the line is not the final response line. You must also ensure
32787 that the lines you write terminate with CRLF. For example:
32788 .code
32789 smtp_printf("550-this is some extra info\r\n");
32790 return LOCAL_SCAN_REJECT;
32791 .endd
32792 Note that you can also create multi-line responses by including newlines in
32793 the data returned via the &%return_text%& argument. The added value of using
32794 &'smtp_printf()'& is that, for instance, you could introduce delays between
32795 multiple output lines.
32796
32797 The &'smtp_printf()'& function does not return any error indication, because it
32798 does not automatically flush pending output, and therefore does not test
32799 the state of the stream. (In the main code of Exim, flushing and error
32800 detection is done when Exim is ready for the next SMTP input command.) If
32801 you want to flush the output and check for an error (for example, the
32802 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32803 arguments. It flushes the output stream, and returns a non-zero value if there
32804 is an error.
32805
32806 .vitem &*void&~*store_get(int)*&
32807 This function accesses Exim's internal store (memory) manager. It gets a new
32808 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32809 runs out of memory. See the next section for a discussion of memory handling.
32810
32811 .vitem &*void&~*store_get_perm(int)*&
32812 This function is like &'store_get()'&, but it always gets memory from the
32813 permanent pool. See the next section for a discussion of memory handling.
32814
32815 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32816 See below.
32817
32818 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32819 See below.
32820
32821 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32822 These three functions create strings using Exim's dynamic memory facilities.
32823 The first makes a copy of an entire string. The second copies up to a maximum
32824 number of characters, indicated by the second argument. The third uses a format
32825 and insertion arguments to create a new string. In each case, the result is a
32826 pointer to a new string in the current memory pool. See the next section for
32827 more discussion.
32828 .endlist
32829
32830
32831
32832 .section "More about Exim's memory handling" "SECTmemhanloc"
32833 .cindex "&[local_scan()]& function" "memory handling"
32834 No function is provided for freeing memory, because that is never needed.
32835 The dynamic memory that Exim uses when receiving a message is automatically
32836 recycled if another message is received by the same process (this applies only
32837 to incoming SMTP connections &-- other input methods can supply only one
32838 message at a time). After receiving the last message, a reception process
32839 terminates.
32840
32841 Because it is recycled, the normal dynamic memory cannot be used for holding
32842 data that must be preserved over a number of incoming messages on the same SMTP
32843 connection. However, Exim in fact uses two pools of dynamic memory; the second
32844 one is not recycled, and can be used for this purpose.
32845
32846 If you want to allocate memory that remains available for subsequent messages
32847 in the same SMTP connection, you should set
32848 .code
32849 store_pool = POOL_PERM
32850 .endd
32851 before calling the function that does the allocation. There is no need to
32852 restore the value if you do not need to; however, if you do want to revert to
32853 the normal pool, you can either restore the previous value of &%store_pool%& or
32854 set it explicitly to POOL_MAIN.
32855
32856 The pool setting applies to all functions that get dynamic memory, including
32857 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32858 There is also a convenience function called &'store_get_perm()'& that gets a
32859 block of memory from the permanent pool while preserving the value of
32860 &%store_pool%&.
32861 .ecindex IIDlosca
32862
32863
32864
32865
32866 . ////////////////////////////////////////////////////////////////////////////
32867 . ////////////////////////////////////////////////////////////////////////////
32868
32869 .chapter "System-wide message filtering" "CHAPsystemfilter"
32870 .scindex IIDsysfil1 "filter" "system filter"
32871 .scindex IIDsysfil2 "filtering all mail"
32872 .scindex IIDsysfil3 "system filter"
32873 The previous chapters (on ACLs and the local scan function) describe checks
32874 that can be applied to messages before they are accepted by a host. There is
32875 also a mechanism for checking messages once they have been received, but before
32876 they are delivered. This is called the &'system filter'&.
32877
32878 The system filter operates in a similar manner to users' filter files, but it
32879 is run just once per message (however many recipients the message has).
32880 It should not normally be used as a substitute for routing, because &%deliver%&
32881 commands in a system router provide new envelope recipient addresses.
32882 The system filter must be an Exim filter. It cannot be a Sieve filter.
32883
32884 The system filter is run at the start of a delivery attempt, before any routing
32885 is done. If a message fails to be completely delivered at the first attempt,
32886 the system filter is run again at the start of every retry.
32887 If you want your filter to do something only once per message, you can make use
32888 of the &%first_delivery%& condition in an &%if%& command in the filter to
32889 prevent it happening on retries.
32890
32891 .vindex "&$domain$&"
32892 .vindex "&$local_part$&"
32893 &*Warning*&: Because the system filter runs just once, variables that are
32894 specific to individual recipient addresses, such as &$local_part$& and
32895 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32896 you want to run a centrally-specified filter for each recipient address
32897 independently, you can do so by setting up a suitable &(redirect)& router, as
32898 described in section &<<SECTperaddfil>>& below.
32899
32900
32901 .section "Specifying a system filter" "SECID212"
32902 .cindex "uid (user id)" "system filter"
32903 .cindex "gid (group id)" "system filter"
32904 The name of the file that contains the system filter must be specified by
32905 setting &%system_filter%&. If you want the filter to run under a uid and gid
32906 other than root, you must also set &%system_filter_user%& and
32907 &%system_filter_group%& as appropriate. For example:
32908 .code
32909 system_filter = /etc/mail/exim.filter
32910 system_filter_user = exim
32911 .endd
32912 If a system filter generates any deliveries directly to files or pipes (via the
32913 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32914 specified by setting &%system_filter_file_transport%& and
32915 &%system_filter_pipe_transport%&, respectively. Similarly,
32916 &%system_filter_reply_transport%& must be set to handle any messages generated
32917 by the &%reply%& command.
32918
32919
32920 .section "Testing a system filter" "SECID213"
32921 You can run simple tests of a system filter in the same way as for a user
32922 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32923 are permitted only in system filters are recognized.
32924
32925 If you want to test the combined effect of a system filter and a user filter,
32926 you can use both &%-bF%& and &%-bf%& on the same command line.
32927
32928
32929
32930 .section "Contents of a system filter" "SECID214"
32931 The language used to specify system filters is the same as for users' filter
32932 files. It is described in the separate end-user document &'Exim's interface to
32933 mail filtering'&. However, there are some additional features that are
32934 available only in system filters; these are described in subsequent sections.
32935 If they are encountered in a user's filter file or when testing with &%-bf%&,
32936 they cause errors.
32937
32938 .cindex "frozen messages" "manual thaw; testing in filter"
32939 There are two special conditions which, though available in users' filter
32940 files, are designed for use in system filters. The condition &%first_delivery%&
32941 is true only for the first attempt at delivering a message, and
32942 &%manually_thawed%& is true only if the message has been frozen, and
32943 subsequently thawed by an admin user. An explicit forced delivery counts as a
32944 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32945
32946 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32947 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32948 succeed, it will not be tried again.
32949 If you want Exim to retry an unseen delivery until it succeeds, you should
32950 arrange to set it up every time the filter runs.
32951
32952 When a system filter finishes running, the values of the variables &$n0$& &--
32953 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32954 users' filter files. Thus a system filter can, for example, set up &"scores"&
32955 to which users' filter files can refer.
32956
32957
32958
32959 .section "Additional variable for system filters" "SECID215"
32960 .vindex "&$recipients$&"
32961 The expansion variable &$recipients$&, containing a list of all the recipients
32962 of the message (separated by commas and white space), is available in system
32963 filters. It is not available in users' filters for privacy reasons.
32964
32965
32966
32967 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32968 .cindex "freezing messages"
32969 .cindex "message" "freezing"
32970 .cindex "message" "forced failure"
32971 .cindex "&%fail%&" "in system filter"
32972 .cindex "&%freeze%& in system filter"
32973 .cindex "&%defer%& in system filter"
32974 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32975 always available in system filters, but are not normally enabled in users'
32976 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32977 for the &(redirect)& router.) These commands can optionally be followed by the
32978 word &%text%& and a string containing an error message, for example:
32979 .code
32980 fail text "this message looks like spam to me"
32981 .endd
32982 The keyword &%text%& is optional if the next character is a double quote.
32983
32984 The &%defer%& command defers delivery of the original recipients of the
32985 message. The &%fail%& command causes all the original recipients to be failed,
32986 and a bounce message to be created. The &%freeze%& command suspends all
32987 delivery attempts for the original recipients. In all cases, any new deliveries
32988 that are specified by the filter are attempted as normal after the filter has
32989 run.
32990
32991 The &%freeze%& command is ignored if the message has been manually unfrozen and
32992 not manually frozen since. This means that automatic freezing by a system
32993 filter can be used as a way of checking out suspicious messages. If a message
32994 is found to be all right, manually unfreezing it allows it to be delivered.
32995
32996 .cindex "log" "&%fail%& command log line"
32997 .cindex "&%fail%&" "log line; reducing"
32998 The text given with a fail command is used as part of the bounce message as
32999 well as being written to the log. If the message is quite long, this can fill
33000 up a lot of log space when such failures are common. To reduce the size of the
33001 log message, Exim interprets the text in a special way if it starts with the
33002 two characters &`<<`& and contains &`>>`& later. The text between these two
33003 strings is written to the log, and the rest of the text is used in the bounce
33004 message. For example:
33005 .code
33006 fail "<<filter test 1>>Your message is rejected \
33007      because it contains attachments that we are \
33008      not prepared to receive."
33009 .endd
33010
33011 .cindex "loop" "caused by &%fail%&"
33012 Take great care with the &%fail%& command when basing the decision to fail on
33013 the contents of the message, because the bounce message will of course include
33014 the contents of the original message and will therefore trigger the &%fail%&
33015 command again (causing a mail loop) unless steps are taken to prevent this.
33016 Testing the &%error_message%& condition is one way to prevent this. You could
33017 use, for example
33018 .code
33019 if $message_body contains "this is spam" and not error_message
33020 then fail text "spam is not wanted here" endif
33021 .endd
33022 though of course that might let through unwanted bounce messages. The
33023 alternative is clever checking of the body and/or headers to detect bounces
33024 generated by the filter.
33025
33026 The interpretation of a system filter file ceases after a
33027 &%defer%&,
33028 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33029 set up earlier in the filter file are honoured, so you can use a sequence such
33030 as
33031 .code
33032 mail ...
33033 freeze
33034 .endd
33035 to send a specified message when the system filter is freezing (or deferring or
33036 failing) a message. The normal deliveries for the message do not, of course,
33037 take place.
33038
33039
33040
33041 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33042 .cindex "header lines" "adding; in system filter"
33043 .cindex "header lines" "removing; in system filter"
33044 .cindex "filter" "header lines; adding/removing"
33045 Two filter commands that are available only in system filters are:
33046 .code
33047 headers add <string>
33048 headers remove <string>
33049 .endd
33050 The argument for the &%headers add%& is a string that is expanded and then
33051 added to the end of the message's headers. It is the responsibility of the
33052 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33053 space is ignored, and if the string is otherwise empty, or if the expansion is
33054 forced to fail, the command has no effect.
33055
33056 You can use &"\n"& within the string, followed by white space, to specify
33057 continued header lines. More than one header may be added in one command by
33058 including &"\n"& within the string without any following white space. For
33059 example:
33060 .code
33061 headers add "X-header-1: ....\n  \
33062              continuation of X-header-1 ...\n\
33063              X-header-2: ...."
33064 .endd
33065 Note that the header line continuation white space after the first newline must
33066 be placed before the backslash that continues the input string, because white
33067 space after input continuations is ignored.
33068
33069 The argument for &%headers remove%& is a colon-separated list of header names.
33070 This command applies only to those headers that are stored with the message;
33071 those that are added at delivery time (such as &'Envelope-To:'& and
33072 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33073 header with the same name, they are all removed.
33074
33075 The &%headers%& command in a system filter makes an immediate change to the set
33076 of header lines that was received with the message (with possible additions
33077 from ACL processing). Subsequent commands in the system filter operate on the
33078 modified set, which also forms the basis for subsequent message delivery.
33079 Unless further modified during routing or transporting, this set of headers is
33080 used for all recipients of the message.
33081
33082 During routing and transporting, the variables that refer to the contents of
33083 header lines refer only to those lines that are in this set. Thus, header lines
33084 that are added by a system filter are visible to users' filter files and to all
33085 routers and transports. This contrasts with the manipulation of header lines by
33086 routers and transports, which is not immediate, but which instead is saved up
33087 until the message is actually being written (see section
33088 &<<SECTheadersaddrem>>&).
33089
33090 If the message is not delivered at the first attempt, header lines that were
33091 added by the system filter are stored with the message, and so are still
33092 present at the next delivery attempt. Header lines that were removed are still
33093 present, but marked &"deleted"& so that they are not transported with the
33094 message. For this reason, it is usual to make the &%headers%& command
33095 conditional on &%first_delivery%& so that the set of header lines is not
33096 modified more than once.
33097
33098 Because header modification in a system filter acts immediately, you have to
33099 use an indirect approach if you want to modify the contents of a header line.
33100 For example:
33101 .code
33102 headers add "Old-Subject: $h_subject:"
33103 headers remove "Subject"
33104 headers add "Subject: new subject (was: $h_old-subject:)"
33105 headers remove "Old-Subject"
33106 .endd
33107
33108
33109
33110 .section "Setting an errors address in a system filter" "SECID217"
33111 .cindex "envelope sender"
33112 In a system filter, if a &%deliver%& command is followed by
33113 .code
33114 errors_to <some address>
33115 .endd
33116 in order to change the envelope sender (and hence the error reporting) for that
33117 delivery, any address may be specified. (In a user filter, only the current
33118 user's address can be set.) For example, if some mail is being monitored, you
33119 might use
33120 .code
33121 unseen deliver monitor@spying.example errors_to root@local.example
33122 .endd
33123 to take a copy which would not be sent back to the normal error reporting
33124 address if its delivery failed.
33125
33126
33127
33128 .section "Per-address filtering" "SECTperaddfil"
33129 .vindex "&$domain$&"
33130 .vindex "&$local_part$&"
33131 In contrast to the system filter, which is run just once per message for each
33132 delivery attempt, it is also possible to set up a system-wide filtering
33133 operation that runs once for each recipient address. In this case, variables
33134 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33135 filter file could be made dependent on them. This is an example of a router
33136 which implements such a filter:
33137 .code
33138 central_filter:
33139   check_local_user
33140   driver = redirect
33141   domains = +local_domains
33142   file = /central/filters/$local_part
33143   no_verify
33144   allow_filter
33145   allow_freeze
33146 .endd
33147 The filter is run in a separate process under its own uid. Therefore, either
33148 &%check_local_user%& must be set (as above), in which case the filter is run as
33149 the local user, or the &%user%& option must be used to specify which user to
33150 use. If both are set, &%user%& overrides.
33151
33152 Care should be taken to ensure that none of the commands in the filter file
33153 specify a significant delivery if the message is to go on to be delivered to
33154 its intended recipient. The router will not then claim to have dealt with the
33155 address, so it will be passed on to subsequent routers to be delivered in the
33156 normal way.
33157 .ecindex IIDsysfil1
33158 .ecindex IIDsysfil2
33159 .ecindex IIDsysfil3
33160
33161
33162
33163
33164
33165
33166 . ////////////////////////////////////////////////////////////////////////////
33167 . ////////////////////////////////////////////////////////////////////////////
33168
33169 .chapter "Message processing" "CHAPmsgproc"
33170 .scindex IIDmesproc "message" "general processing"
33171 Exim performs various transformations on the sender and recipient addresses of
33172 all messages that it handles, and also on the messages' header lines. Some of
33173 these are optional and configurable, while others always take place. All of
33174 this processing, except rewriting as a result of routing, and the addition or
33175 removal of header lines while delivering, happens when a message is received,
33176 before it is placed on Exim's queue.
33177
33178 Some of the automatic processing takes place by default only for
33179 &"locally-originated"& messages. This adjective is used to describe messages
33180 that are not received over TCP/IP, but instead are passed to an Exim process on
33181 its standard input. This includes the interactive &"local SMTP"& case that is
33182 set up by the &%-bs%& command line option.
33183
33184 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33185 or ::1) are not considered to be locally-originated. Exim does not treat the
33186 loopback interface specially in any way.
33187
33188 If you want the loopback interface to be treated specially, you must ensure
33189 that there are appropriate entries in your ACLs.
33190
33191
33192
33193
33194 .section "Submission mode for non-local messages" "SECTsubmodnon"
33195 .cindex "message" "submission"
33196 .cindex "submission mode"
33197 Processing that happens automatically for locally-originated messages (unless
33198 &%suppress_local_fixups%& is set) can also be requested for messages that are
33199 received over TCP/IP. The term &"submission mode"& is used to describe this
33200 state. Submission mode is set by the modifier
33201 .code
33202 control = submission
33203 .endd
33204 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33205 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33206 a local submission, and is normally used when the source of the message is
33207 known to be an MUA running on a client host (as opposed to an MTA). For
33208 example, to set submission mode for messages originating on the IPv4 loopback
33209 interface, you could include the following in the MAIL ACL:
33210 .code
33211 warn  hosts = 127.0.0.1
33212       control = submission
33213 .endd
33214 .cindex "&%sender_retain%& submission option"
33215 There are some options that can be used when setting submission mode. A slash
33216 is used to separate options. For example:
33217 .code
33218 control = submission/sender_retain
33219 .endd
33220 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33221 true and &%local_from_check%& false for the current incoming message. The first
33222 of these allows an existing &'Sender:'& header in the message to remain, and
33223 the second suppresses the check to ensure that &'From:'& matches the
33224 authenticated sender. With this setting, Exim still fixes up messages by adding
33225 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33226 attempt to check sender authenticity in header lines.
33227
33228 When &%sender_retain%& is not set, a submission mode setting may specify a
33229 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33230 example:
33231 .code
33232 control = submission/domain=some.domain
33233 .endd
33234 The domain may be empty. How this value is used is described in sections
33235 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33236 that allows you to specify the user's full name for inclusion in a created
33237 &'Sender:'& or &'From:'& header line. For example:
33238 .code
33239 accept authenticated = *
33240        control = submission/domain=wonderland.example/\
33241                             name=${lookup {$authenticated_id} \
33242                                    lsearch {/etc/exim/namelist}}
33243 .endd
33244 Because the name may contain any characters, including slashes, the &%name%&
33245 option must be given last. The remainder of the string is used as the name. For
33246 the example above, if &_/etc/exim/namelist_& contains:
33247 .code
33248 bigegg:  Humpty Dumpty
33249 .endd
33250 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33251 line would be:
33252 .code
33253 Sender: Humpty Dumpty <bigegg@wonderland.example>
33254 .endd
33255 .cindex "return path" "in submission mode"
33256 By default, submission mode forces the return path to the same address as is
33257 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33258 specified, the return path is also left unchanged.
33259
33260 &*Note*&: The changes caused by submission mode take effect after the predata
33261 ACL. This means that any sender checks performed before the fix-ups use the
33262 untrusted sender address specified by the user, not the trusted sender address
33263 specified by submission mode. Although this might be slightly unexpected, it
33264 does mean that you can configure ACL checks to spot that a user is trying to
33265 spoof another's address.
33266
33267 .section "Line endings" "SECTlineendings"
33268 .cindex "line endings"
33269 .cindex "carriage return"
33270 .cindex "linefeed"
33271 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33272 linefeed) is the line ending for messages transmitted over the Internet using
33273 SMTP over TCP/IP. However, within individual operating systems, different
33274 conventions are used. For example, Unix-like systems use just LF, but others
33275 use CRLF or just CR.
33276
33277 Exim was designed for Unix-like systems, and internally, it stores messages
33278 using the system's convention of a single LF as a line terminator. When
33279 receiving a message, all line endings are translated to this standard format.
33280 Originally, it was thought that programs that passed messages directly to an
33281 MTA within an operating system would use that system's convention. Experience
33282 has shown that this is not the case; for example, there are Unix applications
33283 that use CRLF in this circumstance. For this reason, and for compatibility with
33284 other MTAs, the way Exim handles line endings for all messages is now as
33285 follows:
33286
33287 .ilist
33288 LF not preceded by CR is treated as a line ending.
33289 .next
33290 CR is treated as a line ending; if it is immediately followed by LF, the LF
33291 is ignored.
33292 .next
33293 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33294 nor a local message in the state where a line containing only a dot is a
33295 terminator.
33296 .next
33297 If a bare CR is encountered within a header line, an extra space is added after
33298 the line terminator so as not to end the header line. The reasoning behind this
33299 is that bare CRs in header lines are most likely either to be mistakes, or
33300 people trying to play silly games.
33301 .next
33302 If the first header line received in a message ends with CRLF, a subsequent
33303 bare LF in a header line is treated in the same way as a bare CR in a header
33304 line.
33305 .endlist
33306
33307
33308
33309
33310
33311 .section "Unqualified addresses" "SECID218"
33312 .cindex "unqualified addresses"
33313 .cindex "address" "qualification"
33314 By default, Exim expects every envelope address it receives from an external
33315 host to be fully qualified. Unqualified addresses cause negative responses to
33316 SMTP commands. However, because SMTP is used as a means of transporting
33317 messages from MUAs running on personal workstations, there is sometimes a
33318 requirement to accept unqualified addresses from specific hosts or IP networks.
33319
33320 Exim has two options that separately control which hosts may send unqualified
33321 sender or recipient addresses in SMTP commands, namely
33322 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33323 cases, if an unqualified address is accepted, it is qualified by adding the
33324 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33325
33326 .oindex "&%qualify_domain%&"
33327 .oindex "&%qualify_recipient%&"
33328 Unqualified addresses in header lines are automatically qualified for messages
33329 that are locally originated, unless the &%-bnq%& option is given on the command
33330 line. For messages received over SMTP, unqualified addresses in header lines
33331 are qualified only if unqualified addresses are permitted in SMTP commands. In
33332 other words, such qualification is also controlled by
33333 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33334
33335
33336
33337
33338 .section "The UUCP From line" "SECID219"
33339 .cindex "&""From""& line"
33340 .cindex "UUCP" "&""From""& line"
33341 .cindex "sender" "address"
33342 .oindex "&%uucp_from_pattern%&"
33343 .oindex "&%uucp_from_sender%&"
33344 .cindex "envelope sender"
33345 .cindex "Sendmail compatibility" "&""From""& line"
33346 Messages that have come from UUCP (and some other applications) often begin
33347 with a line containing the envelope sender and a timestamp, following the word
33348 &"From"&. Examples of two common formats are:
33349 .code
33350 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33351 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33352 .endd
33353 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33354 Exim recognizes such lines at the start of messages that are submitted to it
33355 via the command line (that is, on the standard input). It does not recognize
33356 such lines in incoming SMTP messages, unless the sending host matches
33357 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33358 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33359 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33360 default value matches the two common cases shown above and puts the address
33361 that follows &"From"& into &$1$&.
33362
33363 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33364 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33365 a trusted user, the message's sender address is constructed by expanding the
33366 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33367 then parsed as an RFC 2822 address. If there is no domain, the local part is
33368 qualified with &%qualify_domain%& unless it is the empty string. However, if
33369 the command line &%-f%& option is used, it overrides the &"From"& line.
33370
33371 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33372 sender address is not changed. This is also the case for incoming SMTP messages
33373 that are permitted to contain &"From"& lines.
33374
33375 Only one &"From"& line is recognized. If there is more than one, the second is
33376 treated as a data line that starts the body of the message, as it is not valid
33377 as a header line. This also happens if a &"From"& line is present in an
33378 incoming SMTP message from a source that is not permitted to send them.
33379
33380
33381
33382 .section "Resent- header lines" "SECID220"
33383 .cindex "&%Resent-%& header lines"
33384 .cindex "header lines" "Resent-"
33385 RFC 2822 makes provision for sets of header lines starting with the string
33386 &`Resent-`& to be added to a message when it is resent by the original
33387 recipient to somebody else. These headers are &'Resent-Date:'&,
33388 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33389 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33390
33391 .blockquote
33392 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33393 processing of replies or other such automatic actions on messages.'&
33394 .endblockquote
33395
33396 This leaves things a bit vague as far as other processing actions such as
33397 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33398 follows:
33399
33400 .ilist
33401 A &'Resent-From:'& line that just contains the login id of the submitting user
33402 is automatically rewritten in the same way as &'From:'& (see below).
33403 .next
33404 If there's a rewriting rule for a particular header line, it is also applied to
33405 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33406 &'From:'& also rewrites &'Resent-From:'&.
33407 .next
33408 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33409 also removed.
33410 .next
33411 For a locally-submitted message,
33412 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33413 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33414 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33415 included in log lines in this case.
33416 .next
33417 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33418 &%Resent-%& header lines are present.
33419 .endlist
33420
33421
33422
33423
33424 .section "The Auto-Submitted: header line" "SECID221"
33425 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33426 includes the header line:
33427 .code
33428 Auto-Submitted: auto-replied
33429 .endd
33430
33431 .section "The Bcc: header line" "SECID222"
33432 .cindex "&'Bcc:'& header line"
33433 If Exim is called with the &%-t%& option, to take recipient addresses from a
33434 message's header, it removes any &'Bcc:'& header line that may exist (after
33435 extracting its addresses). If &%-t%& is not present on the command line, any
33436 existing &'Bcc:'& is not removed.
33437
33438
33439 .section "The Date: header line" "SECID223"
33440 .cindex "&'Date:'& header line"
33441 .cindex "header lines" "Date:"
33442 If a locally-generated or submission-mode message has no &'Date:'& header line,
33443 Exim adds one, using the current date and time, unless the
33444 &%suppress_local_fixups%& control has been specified.
33445
33446 .section "The Delivery-date: header line" "SECID224"
33447 .cindex "&'Delivery-date:'& header line"
33448 .oindex "&%delivery_date_remove%&"
33449 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33450 set. Exim can be configured to add them to the final delivery of messages. (See
33451 the generic &%delivery_date_add%& transport option.) They should not be present
33452 in messages in transit. If the &%delivery_date_remove%& configuration option is
33453 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33454 messages.
33455
33456
33457 .section "The Envelope-to: header line" "SECID225"
33458 .cindex "&'Envelope-to:'& header line"
33459 .cindex "header lines" "Envelope-to:"
33460 .oindex "&%envelope_to_remove%&"
33461 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33462 Exim can be configured to add them to the final delivery of messages. (See the
33463 generic &%envelope_to_add%& transport option.) They should not be present in
33464 messages in transit. If the &%envelope_to_remove%& configuration option is set
33465 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33466 messages.
33467
33468
33469 .section "The From: header line" "SECTthefrohea"
33470 .cindex "&'From:'& header line"
33471 .cindex "header lines" "From:"
33472 .cindex "Sendmail compatibility" "&""From""& line"
33473 .cindex "message" "submission"
33474 .cindex "submission mode"
33475 If a submission-mode message does not contain a &'From:'& header line, Exim
33476 adds one if either of the following conditions is true:
33477
33478 .ilist
33479 The envelope sender address is not empty (that is, this is not a bounce
33480 message). The added header line copies the envelope sender address.
33481 .next
33482 .vindex "&$authenticated_id$&"
33483 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33484 .olist
33485 .vindex "&$qualify_domain$&"
33486 If no domain is specified by the submission control, the local part is
33487 &$authenticated_id$& and the domain is &$qualify_domain$&.
33488 .next
33489 If a non-empty domain is specified by the submission control, the local
33490 part is &$authenticated_id$&, and the domain is the specified domain.
33491 .next
33492 If an empty domain is specified by the submission control,
33493 &$authenticated_id$& is assumed to be the complete address.
33494 .endlist
33495 .endlist
33496
33497 A non-empty envelope sender takes precedence.
33498
33499 If a locally-generated incoming message does not contain a &'From:'& header
33500 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33501 containing the sender's address. The calling user's login name and full name
33502 are used to construct the address, as described in section &<<SECTconstr>>&.
33503 They are obtained from the password data by calling &[getpwuid()]& (but see the
33504 &%unknown_login%& configuration option). The address is qualified with
33505 &%qualify_domain%&.
33506
33507 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33508 &'From:'& header line containing just the unqualified login name of the calling
33509 user, this is replaced by an address containing the user's login name and full
33510 name as described in section &<<SECTconstr>>&.
33511
33512
33513 .section "The Message-ID: header line" "SECID226"
33514 .cindex "&'Message-ID:'& header line"
33515 .cindex "header lines" "Message-ID:"
33516 .cindex "message" "submission"
33517 .oindex "&%message_id_header_text%&"
33518 If a locally-generated or submission-mode incoming message does not contain a
33519 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33520 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33521 to the message. If there are any &'Resent-:'& headers in the message, it
33522 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33523 message id, preceded by the letter E to ensure it starts with a letter, and
33524 followed by @ and the primary host name. Additional information can be included
33525 in this header line by setting the &%message_id_header_text%& and/or
33526 &%message_id_header_domain%& options.
33527
33528
33529 .section "The Received: header line" "SECID227"
33530 .cindex "&'Received:'& header line"
33531 .cindex "header lines" "Received:"
33532 A &'Received:'& header line is added at the start of every message. The
33533 contents are defined by the &%received_header_text%& configuration option, and
33534 Exim automatically adds a semicolon and a timestamp to the configured string.
33535
33536 The &'Received:'& header is generated as soon as the message's header lines
33537 have been received. At this stage, the timestamp in the &'Received:'& header
33538 line is the time that the message started to be received. This is the value
33539 that is seen by the DATA ACL and by the &[local_scan()]& function.
33540
33541 Once a message is accepted, the timestamp in the &'Received:'& header line is
33542 changed to the time of acceptance, which is (apart from a small delay while the
33543 -H spool file is written) the earliest time at which delivery could start.
33544
33545
33546 .section "The References: header line" "SECID228"
33547 .cindex "&'References:'& header line"
33548 .cindex "header lines" "References:"
33549 Messages created by the &(autoreply)& transport include a &'References:'&
33550 header line. This is constructed according to the rules that are described in
33551 section 3.64 of RFC 2822 (which states that replies should contain such a
33552 header line), and section 3.14 of RFC 3834 (which states that automatic
33553 responses are not different in this respect). However, because some mail
33554 processing software does not cope well with very long header lines, no more
33555 than 12 message IDs are copied from the &'References:'& header line in the
33556 incoming message. If there are more than 12, the first one and then the final
33557 11 are copied, before adding the message ID of the incoming message.
33558
33559
33560
33561 .section "The Return-path: header line" "SECID229"
33562 .cindex "&'Return-path:'& header line"
33563 .cindex "header lines" "Return-path:"
33564 .oindex "&%return_path_remove%&"
33565 &'Return-path:'& header lines are defined as something an MTA may insert when
33566 it does the final delivery of messages. (See the generic &%return_path_add%&
33567 transport option.) Therefore, they should not be present in messages in
33568 transit. If the &%return_path_remove%& configuration option is set (the
33569 default), Exim removes &'Return-path:'& header lines from incoming messages.
33570
33571
33572
33573 .section "The Sender: header line" "SECTthesenhea"
33574 .cindex "&'Sender:'& header line"
33575 .cindex "message" "submission"
33576 .cindex "header lines" "Sender:"
33577 For a locally-originated message from an untrusted user, Exim may remove an
33578 existing &'Sender:'& header line, and it may add a new one. You can modify
33579 these actions by setting the &%local_sender_retain%& option true, the
33580 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33581 control setting.
33582
33583 When a local message is received from an untrusted user and
33584 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33585 control has not been set, a check is made to see if the address given in the
33586 &'From:'& header line is the correct (local) sender of the message. The address
33587 that is expected has the login name as the local part and the value of
33588 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33589 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33590 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33591 line is added to the message.
33592
33593 If you set &%local_from_check%& false, this checking does not occur. However,
33594 the removal of an existing &'Sender:'& line still happens, unless you also set
33595 &%local_sender_retain%& to be true. It is not possible to set both of these
33596 options true at the same time.
33597
33598 .cindex "submission mode"
33599 By default, no processing of &'Sender:'& header lines is done for messages
33600 received over TCP/IP or for messages submitted by trusted users. However, when
33601 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33602 not specified on the submission control, the following processing takes place:
33603
33604 .vindex "&$authenticated_id$&"
33605 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33606 authenticated, and &$authenticated_id$& is not empty, a sender address is
33607 created as follows:
33608
33609 .ilist
33610 .vindex "&$qualify_domain$&"
33611 If no domain is specified by the submission control, the local part is
33612 &$authenticated_id$& and the domain is &$qualify_domain$&.
33613 .next
33614 If a non-empty domain is specified by the submission control, the local part
33615 is &$authenticated_id$&, and the domain is the specified domain.
33616 .next
33617 If an empty domain is specified by the submission control,
33618 &$authenticated_id$& is assumed to be the complete address.
33619 .endlist
33620
33621 This address is compared with the address in the &'From:'& header line. If they
33622 are different, a &'Sender:'& header line containing the created address is
33623 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33624 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33625
33626 .cindex "return path" "created from &'Sender:'&"
33627 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33628 the message (the envelope sender address) is changed to be the same address,
33629 except in the case of submission mode when &%sender_retain%& is specified.
33630
33631
33632
33633 .section "Adding and removing header lines in routers and transports" &&&
33634          "SECTheadersaddrem"
33635 .cindex "header lines" "adding; in router or transport"
33636 .cindex "header lines" "removing; in router or transport"
33637 When a message is delivered, the addition and removal of header lines can be
33638 specified in a system filter, or on any of the routers and transports that
33639 process the message. Section &<<SECTaddremheasys>>& contains details about
33640 modifying headers in a system filter. Header lines can also be added in an ACL
33641 as a message is received (see section &<<SECTaddheadacl>>&).
33642
33643 In contrast to what happens in a system filter, header modifications that are
33644 specified on routers and transports apply only to the particular recipient
33645 addresses that are being processed by those routers and transports. These
33646 changes do not actually take place until a copy of the message is being
33647 transported. Therefore, they do not affect the basic set of header lines, and
33648 they do not affect the values of the variables that refer to header lines.
33649
33650 &*Note*&: In particular, this means that any expansions in the configuration of
33651 the transport cannot refer to the modified header lines, because such
33652 expansions all occur before the message is actually transported.
33653
33654 For both routers and transports, the argument of a &%headers_add%&
33655 option must be in the form of one or more RFC 2822 header lines, separated by
33656 newlines (coded as &"\n"&). For example:
33657 .code
33658 headers_add = X-added-header: added by $primary_hostname\n\
33659               X-added-second: another added header line
33660 .endd
33661 Exim does not check the syntax of these added header lines.
33662
33663 Multiple &%headers_add%& options for a single router or transport can be
33664 specified; the values will append to a single list of header lines.
33665 Each header-line is separately expanded.
33666
33667 The argument of a &%headers_remove%& option must consist of a colon-separated
33668 list of header names. This is confusing, because header names themselves are
33669 often terminated by colons. In this case, the colons are the list separators,
33670 not part of the names. For example:
33671 .code
33672 headers_remove = return-receipt-to:acknowledge-to
33673 .endd
33674
33675 Multiple &%headers_remove%& options for a single router or transport can be
33676 specified; the arguments will append to a single header-names list.
33677 Each item is separately expanded.
33678 Note that colons in complex expansions which are used to
33679 form all or part of a &%headers_remove%& list
33680 will act as list separators.
33681
33682 When &%headers_add%& or &%headers_remove%& is specified on a router,
33683 items are expanded at routing time,
33684 and then associated with all addresses that are
33685 accepted by that router, and also with any new addresses that it generates. If
33686 an address passes through several routers as a result of aliasing or
33687 forwarding, the changes are cumulative.
33688
33689 .oindex "&%unseen%&"
33690 However, this does not apply to multiple routers that result from the use of
33691 the &%unseen%& option. Any header modifications that were specified by the
33692 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33693
33694 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33695 settings cannot be delivered together in a batch, so a transport is always
33696 dealing with a set of addresses that have the same header-processing
33697 requirements.
33698
33699 The transport starts by writing the original set of header lines that arrived
33700 with the message, possibly modified by the system filter. As it writes out
33701 these lines, it consults the list of header names that were attached to the
33702 recipient address(es) by &%headers_remove%& options in routers, and it also
33703 consults the transport's own &%headers_remove%& option. Header lines whose
33704 names are on either of these lists are not written out. If there are multiple
33705 instances of any listed header, they are all skipped.
33706
33707 After the remaining original header lines have been written, new header
33708 lines that were specified by routers' &%headers_add%& options are written, in
33709 the order in which they were attached to the address. These are followed by any
33710 header lines specified by the transport's &%headers_add%& option.
33711
33712 This way of handling header line modifications in routers and transports has
33713 the following consequences:
33714
33715 .ilist
33716 The original set of header lines, possibly modified by the system filter,
33717 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33718 to it, at all times.
33719 .next
33720 Header lines that are added by a router's
33721 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33722 expansion syntax in subsequent routers or the transport.
33723 .next
33724 Conversely, header lines that are specified for removal by &%headers_remove%&
33725 in a router remain visible to subsequent routers and the transport.
33726 .next
33727 Headers added to an address by &%headers_add%& in a router cannot be removed by
33728 a later router or by a transport.
33729 .next
33730 An added header can refer to the contents of an original header that is to be
33731 removed, even it has the same name as the added header. For example:
33732 .code
33733 headers_remove = subject
33734 headers_add = Subject: new subject (was: $h_subject:)
33735 .endd
33736 .endlist
33737
33738 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33739 for a &(redirect)& router that has the &%one_time%& option set.
33740
33741
33742
33743
33744
33745 .section "Constructed addresses" "SECTconstr"
33746 .cindex "address" "constructed"
33747 .cindex "constructed address"
33748 When Exim constructs a sender address for a locally-generated message, it uses
33749 the form
33750 .display
33751 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33752 .endd
33753 For example:
33754 .code
33755 Zaphod Beeblebrox <zaphod@end.univ.example>
33756 .endd
33757 The user name is obtained from the &%-F%& command line option if set, or
33758 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33759 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33760 ampersand character, this is replaced by the login name with the first letter
33761 upper cased, as is conventional in a number of operating systems. See the
33762 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33763 The &%unknown_username%& option can be used to specify user names in cases when
33764 there is no password file entry.
33765
33766 .cindex "RFC 2047"
33767 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33768 parts of it if necessary. In addition, if it contains any non-printing
33769 characters, it is encoded as described in RFC 2047, which defines a way of
33770 including non-ASCII characters in header lines. The value of the
33771 &%headers_charset%& option specifies the name of the encoding that is used (the
33772 characters are assumed to be in this encoding). The setting of
33773 &%print_topbitchars%& controls whether characters with the top bit set (that
33774 is, with codes greater than 127) count as printing characters or not.
33775
33776
33777
33778 .section "Case of local parts" "SECID230"
33779 .cindex "case of local parts"
33780 .cindex "local part" "case of"
33781 RFC 2822 states that the case of letters in the local parts of addresses cannot
33782 be assumed to be non-significant. Exim preserves the case of local parts of
33783 addresses, but by default it uses a lower-cased form when it is routing,
33784 because on most Unix systems, usernames are in lower case and case-insensitive
33785 routing is required. However, any particular router can be made to use the
33786 original case for local parts by setting the &%caseful_local_part%& generic
33787 router option.
33788
33789 .cindex "mixed-case login names"
33790 If you must have mixed-case user names on your system, the best way to proceed,
33791 assuming you want case-independent handling of incoming email, is to set up
33792 your first router to convert incoming local parts in your domains to the
33793 correct case by means of a file lookup. For example:
33794 .code
33795 correct_case:
33796   driver = redirect
33797   domains = +local_domains
33798   data = ${lookup{$local_part}cdb\
33799               {/etc/usercased.cdb}{$value}fail}\
33800               @$domain
33801 .endd
33802 For this router, the local part is forced to lower case by the default action
33803 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33804 up a new local part in the correct case. If you then set &%caseful_local_part%&
33805 on any subsequent routers which process your domains, they will operate on
33806 local parts with the correct case in a case-sensitive manner.
33807
33808
33809
33810 .section "Dots in local parts" "SECID231"
33811 .cindex "dot" "in local part"
33812 .cindex "local part" "dots in"
33813 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33814 part may not begin or end with a dot, nor have two consecutive dots in the
33815 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33816 empty components for compatibility.
33817
33818
33819
33820 .section "Rewriting addresses" "SECID232"
33821 .cindex "rewriting" "addresses"
33822 Rewriting of sender and recipient addresses, and addresses in headers, can
33823 happen automatically, or as the result of configuration options, as described
33824 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33825 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33826
33827 Automatic rewriting includes qualification, as mentioned above. The other case
33828 in which it can happen is when an incomplete non-local domain is given. The
33829 routing process may cause this to be expanded into the full domain name. For
33830 example, a header such as
33831 .code
33832 To: hare@teaparty
33833 .endd
33834 might get rewritten as
33835 .code
33836 To: hare@teaparty.wonderland.fict.example
33837 .endd
33838 Rewriting as a result of routing is the one kind of message processing that
33839 does not happen at input time, as it cannot be done until the address has
33840 been routed.
33841
33842 Strictly, one should not do &'any'& deliveries of a message until all its
33843 addresses have been routed, in case any of the headers get changed as a
33844 result of routing. However, doing this in practice would hold up many
33845 deliveries for unreasonable amounts of time, just because one address could not
33846 immediately be routed. Exim therefore does not delay other deliveries when
33847 routing of one or more addresses is deferred.
33848 .ecindex IIDmesproc
33849
33850
33851
33852 . ////////////////////////////////////////////////////////////////////////////
33853 . ////////////////////////////////////////////////////////////////////////////
33854
33855 .chapter "SMTP processing" "CHAPSMTP"
33856 .scindex IIDsmtpproc1 "SMTP" "processing details"
33857 .scindex IIDsmtpproc2 "LMTP" "processing details"
33858 Exim supports a number of different ways of using the SMTP protocol, and its
33859 LMTP variant, which is an interactive protocol for transferring messages into a
33860 closed mail store application. This chapter contains details of how SMTP is
33861 processed. For incoming mail, the following are available:
33862
33863 .ilist
33864 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33865 .next
33866 SMTP over the standard input and output (the &%-bs%& option);
33867 .next
33868 Batched SMTP on the standard input (the &%-bS%& option).
33869 .endlist
33870
33871 For mail delivery, the following are available:
33872
33873 .ilist
33874 SMTP over TCP/IP (the &(smtp)& transport);
33875 .next
33876 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33877 &"lmtp"&);
33878 .next
33879 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33880 transport);
33881 .next
33882 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33883 the &%use_bsmtp%& option set).
33884 .endlist
33885
33886 &'Batched SMTP'& is the name for a process in which batches of messages are
33887 stored in or read from files (or pipes), in a format in which SMTP commands are
33888 used to contain the envelope information.
33889
33890
33891
33892 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33893 .cindex "SMTP" "outgoing over TCP/IP"
33894 .cindex "outgoing SMTP over TCP/IP"
33895 .cindex "LMTP" "over TCP/IP"
33896 .cindex "outgoing LMTP over TCP/IP"
33897 .cindex "EHLO"
33898 .cindex "HELO"
33899 .cindex "SIZE option on MAIL command"
33900 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33901 The &%protocol%& option selects which protocol is to be used, but the actual
33902 processing is the same in both cases.
33903
33904 If, in response to its EHLO command, Exim is told that the SIZE
33905 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33906 command. The value of <&'n'&> is the message size plus the value of the
33907 &%size_addition%& option (default 1024) to allow for additions to the message
33908 such as per-transport header lines, or changes made in a
33909 .cindex "transport" "filter"
33910 .cindex "filter" "transport filter"
33911 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33912 suppressed.
33913
33914 If the remote server advertises support for PIPELINING, Exim uses the
33915 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33916 required for the transaction.
33917
33918 If the remote server advertises support for the STARTTLS command, and Exim
33919 was built to support TLS encryption, it tries to start a TLS session unless the
33920 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33921 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33922 is called for verification.
33923
33924 If the remote server advertises support for the AUTH command, Exim scans
33925 the authenticators configuration for any suitable client settings, as described
33926 in chapter &<<CHAPSMTPAUTH>>&.
33927
33928 .cindex "carriage return"
33929 .cindex "linefeed"
33930 Responses from the remote host are supposed to be terminated by CR followed by
33931 LF. However, there are known to be hosts that do not send CR characters, so in
33932 order to be able to interwork with such hosts, Exim treats LF on its own as a
33933 line terminator.
33934
33935 If a message contains a number of different addresses, all those with the same
33936 characteristics (for example, the same envelope sender) that resolve to the
33937 same set of hosts, in the same order, are sent in a single SMTP transaction,
33938 even if they are for different domains, unless there are more than the setting
33939 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33940 they are split into groups containing no more than &%max_rcpt%&s addresses
33941 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33942 in parallel sessions. The order of hosts with identical MX values is not
33943 significant when checking whether addresses can be batched in this way.
33944
33945 When the &(smtp)& transport suffers a temporary failure that is not
33946 message-related, Exim updates its transport-specific database, which contains
33947 records indexed by host name that remember which messages are waiting for each
33948 particular host. It also updates the retry database with new retry times.
33949
33950 .cindex "hints database" "retry keys"
33951 Exim's retry hints are based on host name plus IP address, so if one address of
33952 a multi-homed host is broken, it will soon be skipped most of the time.
33953 See the next section for more detail about error handling.
33954
33955 .cindex "SMTP" "passed connection"
33956 .cindex "SMTP" "batching over TCP/IP"
33957 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33958 looks in the hints database for the transport to see if there are any queued
33959 messages waiting for the host to which it is connected. If it finds one, it
33960 creates a new Exim process using the &%-MC%& option (which can only be used by
33961 a process running as root or the Exim user) and passes the TCP/IP socket to it
33962 so that it can deliver another message using the same socket. The new process
33963 does only those deliveries that are routed to the connected host, and may in
33964 turn pass the socket on to a third process, and so on.
33965
33966 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33967 limit the number of messages sent down a single TCP/IP connection.
33968
33969 .cindex "asterisk" "after IP address"
33970 The second and subsequent messages delivered down an existing connection are
33971 identified in the main log by the addition of an asterisk after the closing
33972 square bracket of the IP address.
33973
33974
33975
33976
33977 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33978 .cindex "error" "in outgoing SMTP"
33979 .cindex "SMTP" "errors in outgoing"
33980 .cindex "host" "error"
33981 Three different kinds of error are recognized for outgoing SMTP: host errors,
33982 message errors, and recipient errors.
33983
33984 .vlist
33985 .vitem "&*Host errors*&"
33986 A host error is not associated with a particular message or with a
33987 particular recipient of a message. The host errors are:
33988
33989 .ilist
33990 Connection refused or timed out,
33991 .next
33992 Any error response code on connection,
33993 .next
33994 Any error response code to EHLO or HELO,
33995 .next
33996 Loss of connection at any time, except after &"."&,
33997 .next
33998 I/O errors at any time,
33999 .next
34000 Timeouts during the session, other than in response to MAIL, RCPT or
34001 the &"."& at the end of the data.
34002 .endlist ilist
34003
34004 For a host error, a permanent error response on connection, or in response to
34005 EHLO, causes all addresses routed to the host to be failed. Any other host
34006 error causes all addresses to be deferred, and retry data to be created for the
34007 host. It is not tried again, for any message, until its retry time arrives. If
34008 the current set of addresses are not all delivered in this run (to some
34009 alternative host), the message is added to the list of those waiting for this
34010 host, so if it is still undelivered when a subsequent successful delivery is
34011 made to the host, it will be sent down the same SMTP connection.
34012
34013 .vitem "&*Message errors*&"
34014 .cindex "message" "error"
34015 A message error is associated with a particular message when sent to a
34016 particular host, but not with a particular recipient of the message. The
34017 message errors are:
34018
34019 .ilist
34020 Any error response code to MAIL, DATA, or the &"."& that terminates
34021 the data,
34022 .next
34023 Timeout after MAIL,
34024 .next
34025 Timeout or loss of connection after the &"."& that terminates the data. A
34026 timeout after the DATA command itself is treated as a host error, as is loss of
34027 connection at any other time.
34028 .endlist ilist
34029
34030 For a message error, a permanent error response (5&'xx'&) causes all addresses
34031 to be failed, and a delivery error report to be returned to the sender. A
34032 temporary error response (4&'xx'&), or one of the timeouts, causes all
34033 addresses to be deferred. Retry data is not created for the host, but instead,
34034 a retry record for the combination of host plus message id is created. The
34035 message is not added to the list of those waiting for this host. This ensures
34036 that the failing message will not be sent to this host again until the retry
34037 time arrives. However, other messages that are routed to the host are not
34038 affected, so if it is some property of the message that is causing the error,
34039 it will not stop the delivery of other mail.
34040
34041 If the remote host specified support for the SIZE parameter in its response
34042 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34043 over-large message will cause a message error because the error arrives as a
34044 response to MAIL.
34045
34046 .vitem "&*Recipient errors*&"
34047 .cindex "recipient" "error"
34048 A recipient error is associated with a particular recipient of a message. The
34049 recipient errors are:
34050
34051 .ilist
34052 Any error response to RCPT,
34053 .next
34054 Timeout after RCPT.
34055 .endlist
34056
34057 For a recipient error, a permanent error response (5&'xx'&) causes the
34058 recipient address to be failed, and a bounce message to be returned to the
34059 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34060 address to be deferred, and routing retry data to be created for it. This is
34061 used to delay processing of the address in subsequent queue runs, until its
34062 routing retry time arrives. This applies to all messages, but because it
34063 operates only in queue runs, one attempt will be made to deliver a new message
34064 to the failing address before the delay starts to operate. This ensures that,
34065 if the failure is really related to the message rather than the recipient
34066 (&"message too big for this recipient"& is a possible example), other messages
34067 have a chance of getting delivered. If a delivery to the address does succeed,
34068 the retry information gets cleared, so all stuck messages get tried again, and
34069 the retry clock is reset.
34070
34071 The message is not added to the list of those waiting for this host. Use of the
34072 host for other messages is unaffected, and except in the case of a timeout,
34073 other recipients are processed independently, and may be successfully delivered
34074 in the current SMTP session. After a timeout it is of course impossible to
34075 proceed with the session, so all addresses get deferred. However, those other
34076 than the one that failed do not suffer any subsequent retry delays. Therefore,
34077 if one recipient is causing trouble, the others have a chance of getting
34078 through when a subsequent delivery attempt occurs before the failing
34079 recipient's retry time.
34080 .endlist
34081
34082 In all cases, if there are other hosts (or IP addresses) available for the
34083 current set of addresses (for example, from multiple MX records), they are
34084 tried in this run for any undelivered addresses, subject of course to their
34085 own retry data. In other words, recipient error retry data does not take effect
34086 until the next delivery attempt.
34087
34088 Some hosts have been observed to give temporary error responses to every
34089 MAIL command at certain times (&"insufficient space"& has been seen). It
34090 would be nice if such circumstances could be recognized, and defer data for the
34091 host itself created, but this is not possible within the current Exim design.
34092 What actually happens is that retry data for every (host, message) combination
34093 is created.
34094
34095 The reason that timeouts after MAIL and RCPT are treated specially is that
34096 these can sometimes arise as a result of the remote host's verification
34097 procedures. Exim makes this assumption, and treats them as if a temporary error
34098 response had been received. A timeout after &"."& is treated specially because
34099 it is known that some broken implementations fail to recognize the end of the
34100 message if the last character of the last line is a binary zero. Thus, it is
34101 helpful to treat this case as a message error.
34102
34103 Timeouts at other times are treated as host errors, assuming a problem with the
34104 host, or the connection to it. If a timeout after MAIL, RCPT,
34105 or &"."& is really a connection problem, the assumption is that at the next try
34106 the timeout is likely to occur at some other point in the dialogue, causing it
34107 then to be treated as a host error.
34108
34109 There is experimental evidence that some MTAs drop the connection after the
34110 terminating &"."& if they do not like the contents of the message for some
34111 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34112 should be given. That is why Exim treats this case as a message rather than a
34113 host error, in order not to delay other messages to the same host.
34114
34115
34116
34117
34118 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34119 .cindex "SMTP" "incoming over TCP/IP"
34120 .cindex "incoming SMTP over TCP/IP"
34121 .cindex "inetd"
34122 .cindex "daemon"
34123 Incoming SMTP messages can be accepted in one of two ways: by running a
34124 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34125 &_/etc/inetd.conf_& should be like this:
34126 .code
34127 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34128 .endd
34129 Exim distinguishes between this case and the case of a locally running user
34130 agent using the &%-bs%& option by checking whether or not the standard input is
34131 a socket. When it is, either the port must be privileged (less than 1024), or
34132 the caller must be root or the Exim user. If any other user passes a socket
34133 with an unprivileged port number, Exim prints a message on the standard error
34134 stream and exits with an error code.
34135
34136 By default, Exim does not make a log entry when a remote host connects or
34137 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34138 unexpected. It can be made to write such log entries by setting the
34139 &%smtp_connection%& log selector.
34140
34141 .cindex "carriage return"
34142 .cindex "linefeed"
34143 Commands from the remote host are supposed to be terminated by CR followed by
34144 LF. However, there are known to be hosts that do not send CR characters. In
34145 order to be able to interwork with such hosts, Exim treats LF on its own as a
34146 line terminator.
34147 Furthermore, because common code is used for receiving messages from all
34148 sources, a CR on its own is also interpreted as a line terminator. However, the
34149 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34150
34151 .cindex "EHLO" "invalid data"
34152 .cindex "HELO" "invalid data"
34153 One area that sometimes gives rise to problems concerns the EHLO or
34154 HELO commands. Some clients send syntactically invalid versions of these
34155 commands, which Exim rejects by default. (This is nothing to do with verifying
34156 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34157 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34158 match the broken hosts that send invalid commands.
34159
34160 .cindex "SIZE option on MAIL command"
34161 .cindex "MAIL" "SIZE option"
34162 The amount of disk space available is checked whenever SIZE is received on
34163 a MAIL command, independently of whether &%message_size_limit%& or
34164 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34165 false. A temporary error is given if there is not enough space. If
34166 &%check_spool_space%& is set, the check is for that amount of space plus the
34167 value given with SIZE, that is, it checks that the addition of the incoming
34168 message will not reduce the space below the threshold.
34169
34170 When a message is successfully received, Exim includes the local message id in
34171 its response to the final &"."& that terminates the data. If the remote host
34172 logs this text it can help with tracing what has happened to a message.
34173
34174 The Exim daemon can limit the number of simultaneous incoming connections it is
34175 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34176 number of simultaneous incoming connections from a single remote host (see the
34177 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34178 rejected using the SMTP temporary error code 421.
34179
34180 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34181 subprocess has finished, as this can get lost at busy times. Instead, it looks
34182 for completed subprocesses every time it wakes up. Provided there are other
34183 things happening (new incoming calls, starts of queue runs), completed
34184 processes will be noticed and tidied away. On very quiet systems you may
34185 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34186 it will be noticed when the daemon next wakes up.
34187
34188 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34189 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34190 high system load &-- for details see the &%smtp_accept_reserve%&,
34191 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34192 applies in both the daemon and &'inetd'& cases.
34193
34194 Exim normally starts a delivery process for each message received, though this
34195 can be varied by means of the &%-odq%& command line option and the
34196 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34197 number of simultaneously running delivery processes started in this way from
34198 SMTP input can be limited by the &%smtp_accept_queue%& and
34199 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34200 subsequently received messages are just put on the input queue without starting
34201 a delivery process.
34202
34203 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34204 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34205 started up from the &'inetd'& daemon, because in that case each connection is
34206 handled by an entirely independent Exim process. Control by load average is,
34207 however, available with &'inetd'&.
34208
34209 Exim can be configured to verify addresses in incoming SMTP commands as they
34210 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34211 to rewrite addresses at this time &-- before any syntax checking is done. See
34212 section &<<SECTrewriteS>>&.
34213
34214 Exim can also be configured to limit the rate at which a client host submits
34215 MAIL and RCPT commands in a single SMTP session. See the
34216 &%smtp_ratelimit_hosts%& option.
34217
34218
34219
34220 .section "Unrecognized SMTP commands" "SECID234"
34221 .cindex "SMTP" "unrecognized commands"
34222 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34223 commands during a single SMTP connection, it drops the connection after sending
34224 the error response to the last command. The default value for
34225 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34226 abuse that subvert web servers into making connections to SMTP ports; in these
34227 circumstances, a number of non-SMTP lines are sent first.
34228
34229
34230 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34231 .cindex "SMTP" "syntax errors"
34232 .cindex "SMTP" "protocol errors"
34233 A syntax error is detected if an SMTP command is recognized, but there is
34234 something syntactically wrong with its data, for example, a malformed email
34235 address in a RCPT command. Protocol errors include invalid command
34236 sequencing such as RCPT before MAIL. If Exim receives more than
34237 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34238 drops the connection after sending the error response to the last command. The
34239 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34240 broken clients that loop sending bad commands (yes, it has been seen).
34241
34242
34243
34244 .section "Use of non-mail SMTP commands" "SECID236"
34245 .cindex "SMTP" "non-mail commands"
34246 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34247 DATA. Exim counts such commands, and drops the connection if there are too
34248 many of them in a single SMTP session. This action catches some
34249 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34250 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34251 defines what &"too many"& means. Its default value is 10.
34252
34253 When a new message is expected, one occurrence of RSET is not counted. This
34254 allows a client to send one RSET between messages (this is not necessary,
34255 but some clients do it). Exim also allows one uncounted occurrence of HELO
34256 or EHLO, and one occurrence of STARTTLS between messages. After
34257 starting up a TLS session, another EHLO is expected, and so it too is not
34258 counted.
34259
34260 The first occurrence of AUTH in a connection, or immediately following
34261 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34262 RCPT, DATA, and QUIT are counted.
34263
34264 You can control which hosts are subject to the limit set by
34265 &%smtp_accept_max_nonmail%& by setting
34266 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34267 the limit apply to all hosts. This option means that you can exclude any
34268 specific badly-behaved hosts that you have to live with.
34269
34270
34271
34272
34273 .section "The VRFY and EXPN commands" "SECID237"
34274 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34275 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34276 appropriate) in order to decide whether the command should be accepted or not.
34277
34278 .cindex "VRFY" "processing"
34279 When no ACL is defined for VRFY, or if it rejects without
34280 setting an explicit response code, the command is accepted
34281 (with a 252 SMTP response code)
34282 in order to support awkward clients that do a VRFY before every RCPT.
34283 When VRFY is accepted, it runs exactly the same code as when Exim is
34284 called with the &%-bv%& option, and returns 250/451/550
34285 SMTP response codes.
34286
34287 .cindex "EXPN" "processing"
34288 If no ACL for EXPN is defined, the command is rejected.
34289 When EXPN is accepted, a single-level expansion of the address is done.
34290 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34291 than a verification (the &%-bv%& option). If an unqualified local part is given
34292 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34293 of VRFY and EXPN commands are logged on the main and reject logs, and
34294 VRFY verification failures are logged on the main log for consistency with
34295 RCPT failures.
34296
34297
34298
34299 .section "The ETRN command" "SECTETRN"
34300 .cindex "ETRN" "processing"
34301 RFC 1985 describes an SMTP command called ETRN that is designed to
34302 overcome the security problems of the TURN command (which has fallen into
34303 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34304 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34305 should be accepted or not. If no ACL is defined, the command is rejected.
34306
34307 The ETRN command is concerned with &"releasing"& messages that are awaiting
34308 delivery to certain hosts. As Exim does not organize its message queue by host,
34309 the only form of ETRN that is supported by default is the one where the
34310 text starts with the &"#"& prefix, in which case the remainder of the text is
34311 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34312 the &%-R%& option to happen, with the remainder of the ETRN text as its
34313 argument. For example,
34314 .code
34315 ETRN #brigadoon
34316 .endd
34317 runs the command
34318 .code
34319 exim -R brigadoon
34320 .endd
34321 which causes a delivery attempt on all messages with undelivered addresses
34322 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34323 default), Exim prevents the simultaneous execution of more than one queue run
34324 for the same argument string as a result of an ETRN command. This stops
34325 a misbehaving client from starting more than one queue runner at once.
34326
34327 .cindex "hints database" "ETRN serialization"
34328 Exim implements the serialization by means of a hints database in which a
34329 record is written whenever a process is started by ETRN, and deleted when
34330 the process completes. However, Exim does not keep the SMTP session waiting for
34331 the ETRN process to complete. Once ETRN is accepted, the client is sent
34332 a &"success"& return code. Obviously there is scope for hints records to get
34333 left lying around if there is a system or program crash. To guard against this,
34334 Exim ignores any records that are more than six hours old.
34335
34336 .oindex "&%smtp_etrn_command%&"
34337 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34338 used. This specifies a command that is run whenever ETRN is received,
34339 whatever the form of its argument. For
34340 example:
34341 .code
34342 smtp_etrn_command = /etc/etrn_command $domain \
34343                     $sender_host_address
34344 .endd
34345 .vindex "&$domain$&"
34346 The string is split up into arguments which are independently expanded. The
34347 expansion variable &$domain$& is set to the argument of the ETRN command,
34348 and no syntax checking is done on the contents of this argument. Exim does not
34349 wait for the command to complete, so its status code is not checked. Exim runs
34350 under its own uid and gid when receiving incoming SMTP, so it is not possible
34351 for it to change them before running the command.
34352
34353
34354
34355 .section "Incoming local SMTP" "SECID238"
34356 .cindex "SMTP" "local incoming"
34357 Some user agents use SMTP to pass messages to their local MTA using the
34358 standard input and output, as opposed to passing the envelope on the command
34359 line and writing the message to the standard input. This is supported by the
34360 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34361 messages over TCP/IP (including the use of ACLs), except that the envelope
34362 sender given in a MAIL command is ignored unless the caller is trusted. In
34363 an ACL you can detect this form of SMTP input by testing for an empty host
34364 identification. It is common to have this as the first line in the ACL that
34365 runs for RCPT commands:
34366 .code
34367 accept hosts = :
34368 .endd
34369 This accepts SMTP messages from local processes without doing any other tests.
34370
34371
34372
34373 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34374 .cindex "SMTP" "batched outgoing"
34375 .cindex "batched SMTP output"
34376 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34377 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34378 be output in BSMTP format. No SMTP responses are possible for this form of
34379 delivery. All it is doing is using SMTP commands as a way of transmitting the
34380 envelope along with the message.
34381
34382 The message is written to the file or pipe preceded by the SMTP commands
34383 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34384 the message that start with a dot have an extra dot added. The SMTP command
34385 HELO is not normally used. If it is required, the &%message_prefix%& option
34386 can be used to specify it.
34387
34388 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34389 one recipient address at a time by default. However, you can arrange for them
34390 to handle several addresses at once by setting the &%batch_max%& option. When
34391 this is done for BSMTP, messages may contain multiple RCPT commands. See
34392 chapter &<<CHAPbatching>>& for more details.
34393
34394 .vindex "&$host$&"
34395 When one or more addresses are routed to a BSMTP transport by a router that
34396 sets up a host list, the name of the first host on the list is available to the
34397 transport in the variable &$host$&. Here is an example of such a transport and
34398 router:
34399 .code
34400 begin routers
34401 route_append:
34402   driver = manualroute
34403   transport = smtp_appendfile
34404   route_list = domain.example  batch.host.example
34405
34406 begin transports
34407 smtp_appendfile:
34408   driver = appendfile
34409   directory = /var/bsmtp/$host
34410   batch_max = 1000
34411   use_bsmtp
34412   user = exim
34413 .endd
34414 This causes messages addressed to &'domain.example'& to be written in BSMTP
34415 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34416 message (unless there are more than 1000 recipients).
34417
34418
34419
34420 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34421 .cindex "SMTP" "batched incoming"
34422 .cindex "batched SMTP input"
34423 The &%-bS%& command line option causes Exim to accept one or more messages by
34424 reading SMTP on the standard input, but to generate no responses. If the caller
34425 is trusted, the senders in the MAIL commands are believed; otherwise the
34426 sender is always the caller of Exim. Unqualified senders and receivers are not
34427 rejected (there seems little point) but instead just get qualified. HELO
34428 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34429 as NOOP; QUIT quits.
34430
34431 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34432 ACL is run in the same way as for non-SMTP local input.
34433
34434 If an error is detected while reading a message, including a missing &"."& at
34435 the end, Exim gives up immediately. It writes details of the error to the
34436 standard output in a stylized way that the calling program should be able to
34437 make some use of automatically, for example:
34438 .code
34439 554 Unexpected end of file
34440 Transaction started in line 10
34441 Error detected in line 14
34442 .endd
34443 It writes a more verbose version, for human consumption, to the standard error
34444 file, for example:
34445 .code
34446 An error was detected while processing a file of BSMTP input.
34447 The error message was:
34448
34449 501 '>' missing at end of address
34450
34451 The SMTP transaction started in line 10.
34452 The error was detected in line 12.
34453 The SMTP command at fault was:
34454
34455 rcpt to:<malformed@in.com.plete
34456
34457 1 previous message was successfully processed.
34458 The rest of the batch was abandoned.
34459 .endd
34460 The return code from Exim is zero only if there were no errors. It is 1 if some
34461 messages were accepted before an error was detected, and 2 if no messages were
34462 accepted.
34463 .ecindex IIDsmtpproc1
34464 .ecindex IIDsmtpproc2
34465
34466
34467
34468 . ////////////////////////////////////////////////////////////////////////////
34469 . ////////////////////////////////////////////////////////////////////////////
34470
34471 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34472          "Customizing messages"
34473 When a message fails to be delivered, or remains on the queue for more than a
34474 configured amount of time, Exim sends a message to the original sender, or
34475 to an alternative configured address. The text of these messages is built into
34476 the code of Exim, but it is possible to change it, either by adding a single
34477 string, or by replacing each of the paragraphs by text supplied in a file.
34478
34479 The &'From:'& and &'To:'& header lines are automatically generated; you can
34480 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34481 option. Exim also adds the line
34482 .code
34483 Auto-Submitted: auto-generated
34484 .endd
34485 to all warning and bounce messages,
34486
34487
34488 .section "Customizing bounce messages" "SECID239"
34489 .cindex "customizing" "bounce message"
34490 .cindex "bounce message" "customizing"
34491 If &%bounce_message_text%& is set, its contents are included in the default
34492 message immediately after &"This message was created automatically by mail
34493 delivery software."& The string is not expanded. It is not used if
34494 &%bounce_message_file%& is set.
34495
34496 When &%bounce_message_file%& is set, it must point to a template file for
34497 constructing error messages. The file consists of a series of text items,
34498 separated by lines consisting of exactly four asterisks. If the file cannot be
34499 opened, default text is used and a message is written to the main and panic
34500 logs. If any text item in the file is empty, default text is used for that
34501 item.
34502
34503 .vindex "&$bounce_recipient$&"
34504 .vindex "&$bounce_return_size_limit$&"
34505 Each item of text that is read from the file is expanded, and there are two
34506 expansion variables which can be of use here: &$bounce_recipient$& is set to
34507 the recipient of an error message while it is being created, and
34508 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34509 option, rounded to a whole number.
34510
34511 The items must appear in the file in the following order:
34512
34513 .ilist
34514 The first item is included in the headers, and should include at least a
34515 &'Subject:'& header. Exim does not check the syntax of these headers.
34516 .next
34517 The second item forms the start of the error message. After it, Exim lists the
34518 failing addresses with their error messages.
34519 .next
34520 The third item is used to introduce any text from pipe transports that is to be
34521 returned to the sender. It is omitted if there is no such text.
34522 .next
34523 The fourth, fifth and sixth items will be ignored and may be empty.
34524 The fields exist for back-compatibility
34525 .endlist
34526
34527 The default state (&%bounce_message_file%& unset) is equivalent to the
34528 following file, in which the sixth item is empty. The &'Subject:'& and some
34529 other lines have been split in order to fit them on the page:
34530 .code
34531 Subject: Mail delivery failed
34532   ${if eq{$sender_address}{$bounce_recipient}
34533   {: returning message to sender}}
34534 ****
34535 This message was created automatically by mail delivery software.
34536
34537 A message ${if eq{$sender_address}{$bounce_recipient}
34538   {that you sent }{sent by
34539
34540 <$sender_address>
34541
34542 }}could not be delivered to all of its recipients.
34543 This is a permanent error. The following address(es) failed:
34544 ****
34545 The following text was generated during the delivery attempt(s):
34546 ****
34547 ------ This is a copy of the message, including all the headers.
34548   ------
34549 ****
34550 ------ The body of the message is $message_size characters long;
34551   only the first
34552 ------ $bounce_return_size_limit or so are included here.
34553 ****
34554 .endd
34555 .section "Customizing warning messages" "SECTcustwarn"
34556 .cindex "customizing" "warning message"
34557 .cindex "warning of delay" "customizing the message"
34558 The option &%warn_message_file%& can be pointed at a template file for use when
34559 warnings about message delays are created. In this case there are only three
34560 text sections:
34561
34562 .ilist
34563 The first item is included in the headers, and should include at least a
34564 &'Subject:'& header. Exim does not check the syntax of these headers.
34565 .next
34566 The second item forms the start of the warning message. After it, Exim lists
34567 the delayed addresses.
34568 .next
34569 The third item then ends the message.
34570 .endlist
34571
34572 The default state is equivalent to the following file, except that some lines
34573 have been split here, in order to fit them on the page:
34574 .code
34575 Subject: Warning: message $message_exim_id delayed
34576   $warn_message_delay
34577 ****
34578 This message was created automatically by mail delivery software.
34579
34580 A message ${if eq{$sender_address}{$warn_message_recipients}
34581 {that you sent }{sent by
34582
34583 <$sender_address>
34584
34585 }}has not been delivered to all of its recipients after
34586 more than $warn_message_delay on the queue on $primary_hostname.
34587
34588 The message identifier is:     $message_exim_id
34589 The subject of the message is: $h_subject
34590 The date of the message is:    $h_date
34591
34592 The following address(es) have not yet been delivered:
34593 ****
34594 No action is required on your part. Delivery attempts will
34595 continue for some time, and this warning may be repeated at
34596 intervals if the message remains undelivered. Eventually the
34597 mail delivery software will give up, and when that happens,
34598 the message will be returned to you.
34599 .endd
34600 .vindex "&$warn_message_delay$&"
34601 .vindex "&$warn_message_recipients$&"
34602 However, in the default state the subject and date lines are omitted if no
34603 appropriate headers exist. During the expansion of this file,
34604 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34605 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34606 of recipients for the warning message. There may be more than one if there are
34607 multiple addresses with different &%errors_to%& settings on the routers that
34608 handled them.
34609
34610
34611
34612
34613 . ////////////////////////////////////////////////////////////////////////////
34614 . ////////////////////////////////////////////////////////////////////////////
34615
34616 .chapter "Some common configuration settings" "CHAPcomconreq"
34617 This chapter discusses some configuration settings that seem to be fairly
34618 common. More examples and discussion can be found in the Exim book.
34619
34620
34621
34622 .section "Sending mail to a smart host" "SECID240"
34623 .cindex "smart host" "example router"
34624 If you want to send all mail for non-local domains to a &"smart host"&, you
34625 should replace the default &(dnslookup)& router with a router which does the
34626 routing explicitly:
34627 .code
34628 send_to_smart_host:
34629   driver = manualroute
34630   route_list = !+local_domains smart.host.name
34631   transport = remote_smtp
34632 .endd
34633 You can use the smart host's IP address instead of the name if you wish.
34634 If you are using Exim only to submit messages to a smart host, and not for
34635 receiving incoming messages, you can arrange for it to do the submission
34636 synchronously by setting the &%mua_wrapper%& option (see chapter
34637 &<<CHAPnonqueueing>>&).
34638
34639
34640
34641
34642 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34643 .cindex "mailing lists"
34644 Exim can be used to run simple mailing lists, but for large and/or complicated
34645 requirements, the use of additional specialized mailing list software such as
34646 Majordomo or Mailman is recommended.
34647
34648 The &(redirect)& router can be used to handle mailing lists where each list
34649 is maintained in a separate file, which can therefore be managed by an
34650 independent manager. The &%domains%& router option can be used to run these
34651 lists in a separate domain from normal mail. For example:
34652 .code
34653 lists:
34654   driver = redirect
34655   domains = lists.example
34656   file = /usr/lists/$local_part
34657   forbid_pipe
34658   forbid_file
34659   errors_to = $local_part-request@lists.example
34660   no_more
34661 .endd
34662 This router is skipped for domains other than &'lists.example'&. For addresses
34663 in that domain, it looks for a file that matches the local part. If there is no
34664 such file, the router declines, but because &%no_more%& is set, no subsequent
34665 routers are tried, and so the whole delivery fails.
34666
34667 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34668 expanded into a file name or a pipe delivery, which is usually inappropriate in
34669 a mailing list.
34670
34671 .oindex "&%errors_to%&"
34672 The &%errors_to%& option specifies that any delivery errors caused by addresses
34673 taken from a mailing list are to be sent to the given address rather than the
34674 original sender of the message. However, before acting on this, Exim verifies
34675 the error address, and ignores it if verification fails.
34676
34677 For example, using the configuration above, mail sent to
34678 &'dicts@lists.example'& is passed on to those addresses contained in
34679 &_/usr/lists/dicts_&, with error reports directed to
34680 &'dicts-request@lists.example'&, provided that this address can be verified.
34681 There could be a file called &_/usr/lists/dicts-request_& containing
34682 the address(es) of this particular list's manager(s), but other approaches,
34683 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34684 or &%local_part_suffix%& options) to handle addresses of the form
34685 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34686
34687
34688
34689 .section "Syntax errors in mailing lists" "SECID241"
34690 .cindex "mailing lists" "syntax errors in"
34691 If an entry in redirection data contains a syntax error, Exim normally defers
34692 delivery of the original address. That means that a syntax error in a mailing
34693 list holds up all deliveries to the list. This may not be appropriate when a
34694 list is being maintained automatically from data supplied by users, and the
34695 addresses are not rigorously checked.
34696
34697 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34698 entries that fail to parse, noting the incident in the log. If in addition
34699 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34700 whenever a broken address is skipped. It is usually appropriate to set
34701 &%syntax_errors_to%& to the same address as &%errors_to%&.
34702
34703
34704
34705 .section "Re-expansion of mailing lists" "SECID242"
34706 .cindex "mailing lists" "re-expansion of"
34707 Exim remembers every individual address to which a message has been delivered,
34708 in order to avoid duplication, but it normally stores only the original
34709 recipient addresses with a message. If all the deliveries to a mailing list
34710 cannot be done at the first attempt, the mailing list is re-expanded when the
34711 delivery is next tried. This means that alterations to the list are taken into
34712 account at each delivery attempt, so addresses that have been added to
34713 the list since the message arrived will therefore receive a copy of the
34714 message, even though it pre-dates their subscription.
34715
34716 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34717 on the &(redirect)& router. If this is done, any addresses generated by the
34718 router that fail to deliver at the first attempt are added to the message as
34719 &"top level"& addresses, and the parent address that generated them is marked
34720 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34721 subsequent delivery attempts. The disadvantage of this is that if any of the
34722 failing addresses are incorrect, correcting them in the file has no effect on
34723 pre-existing messages.
34724
34725 The original top-level address is remembered with each of the generated
34726 addresses, and is output in any log messages. However, any intermediate parent
34727 addresses are not recorded. This makes a difference to the log only if the
34728 &%all_parents%& selector is set, but for mailing lists there is normally only
34729 one level of expansion anyway.
34730
34731
34732
34733 .section "Closed mailing lists" "SECID243"
34734 .cindex "mailing lists" "closed"
34735 The examples so far have assumed open mailing lists, to which anybody may
34736 send mail. It is also possible to set up closed lists, where mail is accepted
34737 from specified senders only. This is done by making use of the generic
34738 &%senders%& option to restrict the router that handles the list.
34739
34740 The following example uses the same file as a list of recipients and as a list
34741 of permitted senders. It requires three routers:
34742 .code
34743 lists_request:
34744   driver = redirect
34745   domains = lists.example
34746   local_part_suffix = -request
34747   file = /usr/lists/$local_part$local_part_suffix
34748   no_more
34749
34750 lists_post:
34751   driver = redirect
34752   domains = lists.example
34753   senders = ${if exists {/usr/lists/$local_part}\
34754              {lsearch;/usr/lists/$local_part}{*}}
34755   file = /usr/lists/$local_part
34756   forbid_pipe
34757   forbid_file
34758   errors_to = $local_part-request@lists.example
34759   no_more
34760
34761 lists_closed:
34762   driver = redirect
34763   domains = lists.example
34764   allow_fail
34765   data = :fail: $local_part@lists.example is a closed mailing list
34766 .endd
34767 All three routers have the same &%domains%& setting, so for any other domains,
34768 they are all skipped. The first router runs only if the local part ends in
34769 &%-request%&. It handles messages to the list manager(s) by means of an open
34770 mailing list.
34771
34772 The second router runs only if the &%senders%& precondition is satisfied. It
34773 checks for the existence of a list that corresponds to the local part, and then
34774 checks that the sender is on the list by means of a linear search. It is
34775 necessary to check for the existence of the file before trying to search it,
34776 because otherwise Exim thinks there is a configuration error. If the file does
34777 not exist, the expansion of &%senders%& is *, which matches all senders. This
34778 means that the router runs, but because there is no list, declines, and
34779 &%no_more%& ensures that no further routers are run. The address fails with an
34780 &"unrouteable address"& error.
34781
34782 The third router runs only if the second router is skipped, which happens when
34783 a mailing list exists, but the sender is not on it. This router forcibly fails
34784 the address, giving a suitable error message.
34785
34786
34787
34788
34789 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34790 .cindex "VERP"
34791 .cindex "Variable Envelope Return Paths"
34792 .cindex "envelope sender"
34793 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34794 are a way of helping mailing list administrators discover which subscription
34795 address is the cause of a particular delivery failure. The idea is to encode
34796 the original recipient address in the outgoing envelope sender address, so that
34797 if the message is forwarded by another host and then subsequently bounces, the
34798 original recipient can be extracted from the recipient address of the bounce.
34799
34800 .oindex &%errors_to%&
34801 .oindex &%return_path%&
34802 Envelope sender addresses can be modified by Exim using two different
34803 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34804 list examples), or the &%return_path%& option on a transport. The second of
34805 these is effective only if the message is successfully delivered to another
34806 host; it is not used for errors detected on the local host (see the description
34807 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34808 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34809 .code
34810 verp_smtp:
34811   driver = smtp
34812   max_rcpt = 1
34813   return_path = \
34814     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34815       {$1-request+$local_part=$domain@your.dom.example}fail}
34816 .endd
34817 This has the effect of rewriting the return path (envelope sender) on outgoing
34818 SMTP messages, if the local part of the original return path ends in
34819 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34820 local part and domain of the recipient into the return path. Suppose, for
34821 example, that a message whose return path has been set to
34822 &'somelist-request@your.dom.example'& is sent to
34823 &'subscriber@other.dom.example'&. In the transport, the return path is
34824 rewritten as
34825 .code
34826 somelist-request+subscriber=other.dom.example@your.dom.example
34827 .endd
34828 .vindex "&$local_part$&"
34829 For this to work, you must tell Exim to send multiple copies of messages that
34830 have more than one recipient, so that each copy has just one recipient. This is
34831 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34832 might be sent to several different recipients in the same domain, in which case
34833 &$local_part$& is not available in the transport, because it is not unique.
34834
34835 Unless your host is doing nothing but mailing list deliveries, you should
34836 probably use a separate transport for the VERP deliveries, so as not to use
34837 extra resources in making one-per-recipient copies for other deliveries. This
34838 can easily be done by expanding the &%transport%& option in the router:
34839 .code
34840 dnslookup:
34841   driver = dnslookup
34842   domains = ! +local_domains
34843   transport = \
34844     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34845       {verp_smtp}{remote_smtp}}
34846   no_more
34847 .endd
34848 If you want to change the return path using &%errors_to%& in a router instead
34849 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34850 routers that handle mailing list addresses. This will ensure that all delivery
34851 errors, including those detected on the local host, are sent to the VERP
34852 address.
34853
34854 On a host that does no local deliveries and has no manual routing, only the
34855 &(dnslookup)& router needs to be changed. A special transport is not needed for
34856 SMTP deliveries. Every mailing list recipient has its own return path value,
34857 and so Exim must hand them to the transport one at a time. Here is an example
34858 of a &(dnslookup)& router that implements VERP:
34859 .code
34860 verp_dnslookup:
34861   driver = dnslookup
34862   domains = ! +local_domains
34863   transport = remote_smtp
34864   errors_to = \
34865     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34866      {$1-request+$local_part=$domain@your.dom.example}fail}
34867   no_more
34868 .endd
34869 Before you start sending out messages with VERPed return paths, you must also
34870 configure Exim to accept the bounce messages that come back to those paths.
34871 Typically this is done by setting a &%local_part_suffix%& option for a
34872 router, and using this to route the messages to wherever you want to handle
34873 them.
34874
34875 The overhead incurred in using VERP depends very much on the size of the
34876 message, the number of recipient addresses that resolve to the same remote
34877 host, and the speed of the connection over which the message is being sent. If
34878 a lot of addresses resolve to the same host and the connection is slow, sending
34879 a separate copy of the message for each address may take substantially longer
34880 than sending a single copy with many recipients (for which VERP cannot be
34881 used).
34882
34883
34884
34885
34886
34887
34888 .section "Virtual domains" "SECTvirtualdomains"
34889 .cindex "virtual domains"
34890 .cindex "domain" "virtual"
34891 The phrase &'virtual domain'& is unfortunately used with two rather different
34892 meanings:
34893
34894 .ilist
34895 A domain for which there are no real mailboxes; all valid local parts are
34896 aliases for other email addresses. Common examples are organizational
34897 top-level domains and &"vanity"& domains.
34898 .next
34899 One of a number of independent domains that are all handled by the same host,
34900 with mailboxes on that host, but where the mailbox owners do not necessarily
34901 have login accounts on that host.
34902 .endlist
34903
34904 The first usage is probably more common, and does seem more &"virtual"& than
34905 the second. This kind of domain can be handled in Exim with a straightforward
34906 aliasing router. One approach is to create a separate alias file for each
34907 virtual domain. Exim can test for the existence of the alias file to determine
34908 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34909 to a router of this form:
34910 .code
34911 virtual:
34912   driver = redirect
34913   domains = dsearch;/etc/mail/virtual
34914   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34915   no_more
34916 .endd
34917 The &%domains%& option specifies that the router is to be skipped, unless there
34918 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34919 domain that is being processed. When the router runs, it looks up the local
34920 part in the file to find a new address (or list of addresses). The &%no_more%&
34921 setting ensures that if the lookup fails (leading to &%data%& being an empty
34922 string), Exim gives up on the address without trying any subsequent routers.
34923
34924 This one router can handle all the virtual domains because the alias file names
34925 follow a fixed pattern. Permissions can be arranged so that appropriate people
34926 can edit the different alias files. A successful aliasing operation results in
34927 a new envelope recipient address, which is then routed from scratch.
34928
34929 The other kind of &"virtual"& domain can also be handled in a straightforward
34930 way. One approach is to create a file for each domain containing a list of
34931 valid local parts, and use it in a router like this:
34932 .code
34933 my_domains:
34934   driver = accept
34935   domains = dsearch;/etc/mail/domains
34936   local_parts = lsearch;/etc/mail/domains/$domain
34937   transport = my_mailboxes
34938 .endd
34939 The address is accepted if there is a file for the domain, and the local part
34940 can be found in the file. The &%domains%& option is used to check for the
34941 file's existence because &%domains%& is tested before the &%local_parts%&
34942 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34943 because that option is tested after &%local_parts%&. The transport is as
34944 follows:
34945 .code
34946 my_mailboxes:
34947   driver = appendfile
34948   file = /var/mail/$domain/$local_part
34949   user = mail
34950 .endd
34951 This uses a directory of mailboxes for each domain. The &%user%& setting is
34952 required, to specify which uid is to be used for writing to the mailboxes.
34953
34954 The configuration shown here is just one example of how you might support this
34955 requirement. There are many other ways this kind of configuration can be set
34956 up, for example, by using a database instead of separate files to hold all the
34957 information about the domains.
34958
34959
34960
34961 .section "Multiple user mailboxes" "SECTmulbox"
34962 .cindex "multiple mailboxes"
34963 .cindex "mailbox" "multiple"
34964 .cindex "local part" "prefix"
34965 .cindex "local part" "suffix"
34966 Heavy email users often want to operate with multiple mailboxes, into which
34967 incoming mail is automatically sorted. A popular way of handling this is to
34968 allow users to use multiple sender addresses, so that replies can easily be
34969 identified. Users are permitted to add prefixes or suffixes to their local
34970 parts for this purpose. The wildcard facility of the generic router options
34971 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34972 example, consider this router:
34973 .code
34974 userforward:
34975   driver = redirect
34976   check_local_user
34977   file = $home/.forward
34978   local_part_suffix = -*
34979   local_part_suffix_optional
34980   allow_filter
34981 .endd
34982 .vindex "&$local_part_suffix$&"
34983 It runs a user's &_.forward_& file for all local parts of the form
34984 &'username-*'&. Within the filter file the user can distinguish different
34985 cases by testing the variable &$local_part_suffix$&. For example:
34986 .code
34987 if $local_part_suffix contains -special then
34988 save /home/$local_part/Mail/special
34989 endif
34990 .endd
34991 If the filter file does not exist, or does not deal with such addresses, they
34992 fall through to subsequent routers, and, assuming no subsequent use of the
34993 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34994 control over which suffixes are valid.
34995
34996 Alternatively, a suffix can be used to trigger the use of a different
34997 &_.forward_& file &-- which is the way a similar facility is implemented in
34998 another MTA:
34999 .code
35000 userforward:
35001   driver = redirect
35002   check_local_user
35003   file = $home/.forward$local_part_suffix
35004   local_part_suffix = -*
35005   local_part_suffix_optional
35006   allow_filter
35007 .endd
35008 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35009 example, &_.forward-special_& is used. Once again, if the appropriate file
35010 does not exist, or does not deal with the address, it is passed on to
35011 subsequent routers, which could, if required, look for an unqualified
35012 &_.forward_& file to use as a default.
35013
35014
35015
35016 .section "Simplified vacation processing" "SECID244"
35017 .cindex "vacation processing"
35018 The traditional way of running the &'vacation'& program is for a user to set up
35019 a pipe command in a &_.forward_& file
35020 (see section &<<SECTspecitredli>>& for syntax details).
35021 This is prone to error by inexperienced users. There are two features of Exim
35022 that can be used to make this process simpler for users:
35023
35024 .ilist
35025 A local part prefix such as &"vacation-"& can be specified on a router which
35026 can cause the message to be delivered directly to the &'vacation'& program, or
35027 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35028 &_.forward_& file are then much simpler. For example:
35029 .code
35030 spqr, vacation-spqr
35031 .endd
35032 .next
35033 The &%require_files%& generic router option can be used to trigger a
35034 vacation delivery by checking for the existence of a certain file in the
35035 user's home directory. The &%unseen%& generic option should also be used, to
35036 ensure that the original delivery also proceeds. In this case, all the user has
35037 to do is to create a file called, say, &_.vacation_&, containing a vacation
35038 message.
35039 .endlist
35040
35041 Another advantage of both these methods is that they both work even when the
35042 use of arbitrary pipes by users is locked out.
35043
35044
35045
35046 .section "Taking copies of mail" "SECID245"
35047 .cindex "message" "copying every"
35048 Some installations have policies that require archive copies of all messages to
35049 be made. A single copy of each message can easily be taken by an appropriate
35050 command in a system filter, which could, for example, use a different file for
35051 each day's messages.
35052
35053 There is also a shadow transport mechanism that can be used to take copies of
35054 messages that are successfully delivered by local transports, one copy per
35055 delivery. This could be used, &'inter alia'&, to implement automatic
35056 notification of delivery by sites that insist on doing such things.
35057
35058
35059
35060 .section "Intermittently connected hosts" "SECID246"
35061 .cindex "intermittently connected hosts"
35062 It has become quite common (because it is cheaper) for hosts to connect to the
35063 Internet periodically rather than remain connected all the time. The normal
35064 arrangement is that mail for such hosts accumulates on a system that is
35065 permanently connected.
35066
35067 Exim was designed for use on permanently connected hosts, and so it is not
35068 particularly well-suited to use in an intermittently connected environment.
35069 Nevertheless there are some features that can be used.
35070
35071
35072 .section "Exim on the upstream server host" "SECID247"
35073 It is tempting to arrange for incoming mail for the intermittently connected
35074 host to remain on Exim's queue until the client connects. However, this
35075 approach does not scale very well. Two different kinds of waiting message are
35076 being mixed up in the same queue &-- those that cannot be delivered because of
35077 some temporary problem, and those that are waiting for their destination host
35078 to connect. This makes it hard to manage the queue, as well as wasting
35079 resources, because each queue runner scans the entire queue.
35080
35081 A better approach is to separate off those messages that are waiting for an
35082 intermittently connected host. This can be done by delivering these messages
35083 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35084 format, from where they are transmitted by other software when their
35085 destination connects. This makes it easy to collect all the mail for one host
35086 in a single directory, and to apply local timeout rules on a per-message basis
35087 if required.
35088
35089 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35090 you are doing this, you should configure Exim with a long retry period for the
35091 intermittent host. For example:
35092 .code
35093 cheshire.wonderland.fict.example    *   F,5d,24h
35094 .endd
35095 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35096 which messages it has queued up for that host. Once the intermittent host comes
35097 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35098 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35099 causes all the queued up messages to be delivered, often down a single SMTP
35100 connection. While the host remains connected, any new messages get delivered
35101 immediately.
35102
35103 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35104 issued with a different IP address each time it connects, Exim's retry
35105 mechanisms on the holding host get confused, because the IP address is normally
35106 used as part of the key string for holding retry information. This can be
35107 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35108 Since this has disadvantages for permanently connected hosts, it is best to
35109 arrange a separate transport for the intermittently connected ones.
35110
35111
35112
35113 .section "Exim on the intermittently connected client host" "SECID248"
35114 The value of &%smtp_accept_queue_per_connection%& should probably be
35115 increased, or even set to zero (that is, disabled) on the intermittently
35116 connected host, so that all incoming messages down a single connection get
35117 delivered immediately.
35118
35119 .cindex "SMTP" "passed connection"
35120 .cindex "SMTP" "multiple deliveries"
35121 .cindex "multiple SMTP deliveries"
35122 Mail waiting to be sent from an intermittently connected host will probably
35123 not have been routed, because without a connection DNS lookups are not
35124 possible. This means that if a normal queue run is done at connection time,
35125 each message is likely to be sent in a separate SMTP session. This can be
35126 avoided by starting the queue run with a command line option beginning with
35127 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35128 first pass, routing is done but no deliveries take place. The second pass is a
35129 normal queue run; since all the messages have been previously routed, those
35130 destined for the same host are likely to get sent as multiple deliveries in a
35131 single SMTP connection.
35132
35133
35134
35135 . ////////////////////////////////////////////////////////////////////////////
35136 . ////////////////////////////////////////////////////////////////////////////
35137
35138 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35139          "Exim as a non-queueing client"
35140 .cindex "client, non-queueing"
35141 .cindex "smart host" "suppressing queueing"
35142 On a personal computer, it is a common requirement for all
35143 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35144 configured to operate that way, for all the popular operating systems.
35145 However, there are some MUAs for Unix-like systems that cannot be so
35146 configured: they submit messages using the command line interface of
35147 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35148 messages this way.
35149
35150 If the personal computer runs continuously, there is no problem, because it can
35151 run a conventional MTA that handles delivery to the smart host, and deal with
35152 any delays via its queueing mechanism. However, if the computer does not run
35153 continuously or runs different operating systems at different times, queueing
35154 email is not desirable.
35155
35156 There is therefore a requirement for something that can provide the
35157 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35158 any queueing or retrying facilities. Furthermore, the delivery to the smart
35159 host should be synchronous, so that if it fails, the sending MUA is immediately
35160 informed. In other words, we want something that extends an MUA that submits
35161 to a local MTA via the command line so that it behaves like one that submits
35162 to a remote smart host using TCP/SMTP.
35163
35164 There are a number of applications (for example, there is one called &'ssmtp'&)
35165 that do this job. However, people have found them to be lacking in various
35166 ways. For instance, you might want to allow aliasing and forwarding to be done
35167 before sending a message to the smart host.
35168
35169 Exim already had the necessary infrastructure for doing this job. Just a few
35170 tweaks were needed to make it behave as required, though it is somewhat of an
35171 overkill to use a fully-featured MTA for this purpose.
35172
35173 .oindex "&%mua_wrapper%&"
35174 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35175 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35176 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35177 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35178 compatible router and transport configuration. Typically there will be just one
35179 router and one transport, sending everything to a smart host.
35180
35181 When run in MUA wrapping mode, the behaviour of Exim changes in the
35182 following ways:
35183
35184 .ilist
35185 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35186 In other words, the only way to submit messages is via the command line.
35187 .next
35188 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35189 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35190 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35191 does not finish until the delivery attempt is complete. If the delivery is
35192 successful, a zero return code is given.
35193 .next
35194 Address redirection is permitted, but the final routing for all addresses must
35195 be to the same remote transport, and to the same list of hosts. Furthermore,
35196 the return address (envelope sender) must be the same for all recipients, as
35197 must any added or deleted header lines. In other words, it must be possible to
35198 deliver the message in a single SMTP transaction, however many recipients there
35199 are.
35200 .next
35201 If these conditions are not met, or if routing any address results in a
35202 failure or defer status, or if Exim is unable to deliver all the recipients
35203 successfully to one of the smart hosts, delivery of the entire message fails.
35204 .next
35205 Because no queueing is allowed, all failures are treated as permanent; there
35206 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35207 smart host. Furthermore, because only a single yes/no response can be given to
35208 the caller, it is not possible to deliver to some recipients and not others. If
35209 there is an error (temporary or permanent) for any recipient, all are failed.
35210 .next
35211 If more than one smart host is listed, Exim will try another host after a
35212 connection failure or a timeout, in the normal way. However, if this kind of
35213 failure happens for all the hosts, the delivery fails.
35214 .next
35215 When delivery fails, an error message is written to the standard error stream
35216 (as well as to Exim's log), and Exim exits to the caller with a return code
35217 value 1. The message is expunged from Exim's spool files. No bounce messages
35218 are ever generated.
35219 .next
35220 No retry data is maintained, and any retry rules are ignored.
35221 .next
35222 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35223 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35224 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35225 .endlist
35226
35227 The overall effect is that Exim makes a single synchronous attempt to deliver
35228 the message, failing if there is any kind of problem. Because no local
35229 deliveries are done and no daemon can be run, Exim does not need root
35230 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35231 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35232 the advantages and disadvantages of running without root privilege.
35233
35234
35235
35236
35237 . ////////////////////////////////////////////////////////////////////////////
35238 . ////////////////////////////////////////////////////////////////////////////
35239
35240 .chapter "Log files" "CHAPlog"
35241 .scindex IIDloggen "log" "general description"
35242 .cindex "log" "types of"
35243 Exim writes three different logs, referred to as the main log, the reject log,
35244 and the panic log:
35245
35246 .ilist
35247 .cindex "main log"
35248 The main log records the arrival of each message and each delivery in a single
35249 line in each case. The format is as compact as possible, in an attempt to keep
35250 down the size of log files. Two-character flag sequences make it easy to pick
35251 out these lines. A number of other events are recorded in the main log. Some of
35252 them are optional, in which case the &%log_selector%& option controls whether
35253 they are included or not. A Perl script called &'eximstats'&, which does simple
35254 analysis of main log files, is provided in the Exim distribution (see section
35255 &<<SECTmailstat>>&).
35256 .next
35257 .cindex "reject log"
35258 The reject log records information from messages that are rejected as a result
35259 of a configuration option (that is, for policy reasons).
35260 The first line of each rejection is a copy of the line that is also written to
35261 the main log. Then, if the message's header has been read at the time the log
35262 is written, its contents are written to this log. Only the original header
35263 lines are available; header lines added by ACLs are not logged. You can use the
35264 reject log to check that your policy controls are working correctly; on a busy
35265 host this may be easier than scanning the main log for rejection messages. You
35266 can suppress the writing of the reject log by setting &%write_rejectlog%&
35267 false.
35268 .next
35269 .cindex "panic log"
35270 .cindex "system log"
35271 When certain serious errors occur, Exim writes entries to its panic log. If the
35272 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35273 are usually written to the main log as well, but can get lost amid the mass of
35274 other entries. The panic log should be empty under normal circumstances. It is
35275 therefore a good idea to check it (or to have a &'cron'& script check it)
35276 regularly, in order to become aware of any problems. When Exim cannot open its
35277 panic log, it tries as a last resort to write to the system log (syslog). This
35278 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35279 message itself is written at priority LOG_CRIT.
35280 .endlist
35281
35282 Every log line starts with a timestamp, in the format shown in the following
35283 example. Note that many of the examples shown in this chapter are line-wrapped.
35284 In the log file, this would be all on one line:
35285 .code
35286 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35287   by QUIT
35288 .endd
35289 By default, the timestamps are in the local timezone. There are two
35290 ways of changing this:
35291
35292 .ilist
35293 You can set the &%timezone%& option to a different time zone; in particular, if
35294 you set
35295 .code
35296 timezone = UTC
35297 .endd
35298 the timestamps will be in UTC (aka GMT).
35299 .next
35300 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35301 example:
35302 .code
35303 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35304 .endd
35305 .endlist
35306
35307 .cindex "log" "process ids in"
35308 .cindex "pid (process id)" "in log lines"
35309 Exim does not include its process id in log lines by default, but you can
35310 request that it does so by specifying the &`pid`& log selector (see section
35311 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35312 brackets, immediately after the time and date.
35313
35314
35315
35316
35317 .section "Where the logs are written" "SECTwhelogwri"
35318 .cindex "log" "destination"
35319 .cindex "log" "to file"
35320 .cindex "log" "to syslog"
35321 .cindex "syslog"
35322 The logs may be written to local files, or to syslog, or both. However, it
35323 should be noted that many syslog implementations use UDP as a transport, and
35324 are therefore unreliable in the sense that messages are not guaranteed to
35325 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35326 It has also been reported that on large log files (tens of megabytes) you may
35327 need to tweak syslog to prevent it syncing the file with each write &-- on
35328 Linux this has been seen to make syslog take 90% plus of CPU time.
35329
35330 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35331 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35332 configuration. This latter string is expanded, so it can contain, for example,
35333 references to the host name:
35334 .code
35335 log_file_path = /var/log/$primary_hostname/exim_%slog
35336 .endd
35337 It is generally advisable, however, to set the string in &_Local/Makefile_&
35338 rather than at run time, because then the setting is available right from the
35339 start of Exim's execution. Otherwise, if there's something it wants to log
35340 before it has read the configuration file (for example, an error in the
35341 configuration file) it will not use the path you want, and may not be able to
35342 log at all.
35343
35344 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35345 list, currently limited to at most two items. This is one option where the
35346 facility for changing a list separator may not be used. The list must always be
35347 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35348 otherwise the item must either be an absolute path, containing &`%s`& at the
35349 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35350 implying the use of a default path.
35351
35352 When Exim encounters an empty item in the list, it searches the list defined by
35353 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35354 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35355 mean &"use the path specified at build time"&. It no such item exists, log
35356 files are written in the &_log_& subdirectory of the spool directory. This is
35357 equivalent to the setting:
35358 .code
35359 log_file_path = $spool_directory/log/%slog
35360 .endd
35361 If you do not specify anything at build time or run time,
35362 or if you unset the option at run time (i.e. &`log_file_path = `&),
35363 that is where the logs are written.
35364
35365 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35366 are in use &-- see section &<<SECTdatlogfil>>& below.
35367
35368 Here are some examples of possible settings:
35369 .display
35370 &`LOG_FILE_PATH=syslog                    `& syslog only
35371 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35372 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35373 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35374 .endd
35375 If there are more than two paths in the list, the first is used and a panic
35376 error is logged.
35377
35378
35379
35380 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35381 .cindex "log" "cycling local files"
35382 .cindex "cycling logs"
35383 .cindex "&'exicyclog'&"
35384 .cindex "log" "local files; writing to"
35385 Some operating systems provide centralized and standardized methods for cycling
35386 log files. For those that do not, a utility script called &'exicyclog'& is
35387 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35388 main and reject logs each time it is called. The maximum number of old logs to
35389 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35390
35391 An Exim delivery process opens the main log when it first needs to write to it,
35392 and it keeps the file open in case subsequent entries are required &-- for
35393 example, if a number of different deliveries are being done for the same
35394 message. However, remote SMTP deliveries can take a long time, and this means
35395 that the file may be kept open long after it is renamed if &'exicyclog'& or
35396 something similar is being used to rename log files on a regular basis. To
35397 ensure that a switch of log files is noticed as soon as possible, Exim calls
35398 &[stat()]& on the main log's name before reusing an open file, and if the file
35399 does not exist, or its inode has changed, the old file is closed and Exim
35400 tries to open the main log from scratch. Thus, an old log file may remain open
35401 for quite some time, but no Exim processes should write to it once it has been
35402 renamed.
35403
35404
35405
35406 .section "Datestamped log files" "SECTdatlogfil"
35407 .cindex "log" "datestamped files"
35408 Instead of cycling the main and reject log files by renaming them
35409 periodically, some sites like to use files whose names contain a datestamp,
35410 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35411 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35412 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35413 point where the datestamp is required. For example:
35414 .code
35415 log_file_path = /var/spool/exim/log/%slog-%D
35416 log_file_path = /var/log/exim-%s-%D.log
35417 log_file_path = /var/spool/exim/log/%D-%slog
35418 log_file_path = /var/log/exim/%s.%M
35419 .endd
35420 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35421 examples of names generated by the above examples:
35422 .code
35423 /var/spool/exim/log/mainlog-20021225
35424 /var/log/exim-reject-20021225.log
35425 /var/spool/exim/log/20021225-mainlog
35426 /var/log/exim/main.200212
35427 .endd
35428 When this form of log file is specified, Exim automatically switches to new
35429 files at midnight. It does not make any attempt to compress old logs; you
35430 will need to write your own script if you require this. You should not
35431 run &'exicyclog'& with this form of logging.
35432
35433 The location of the panic log is also determined by &%log_file_path%&, but it
35434 is not datestamped, because rotation of the panic log does not make sense.
35435 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35436 the string. In addition, if it immediately follows a slash, a following
35437 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35438 character is removed. Thus, the four examples above would give these panic
35439 log names:
35440 .code
35441 /var/spool/exim/log/paniclog
35442 /var/log/exim-panic.log
35443 /var/spool/exim/log/paniclog
35444 /var/log/exim/panic
35445 .endd
35446
35447
35448 .section "Logging to syslog" "SECID249"
35449 .cindex "log" "syslog; writing to"
35450 The use of syslog does not change what Exim logs or the format of its messages,
35451 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35452 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35453 that, the same strings are written to syslog as to log files. The syslog
35454 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35455 by default, but you can change these by setting the &%syslog_facility%& and
35456 &%syslog_processname%& options, respectively. If Exim was compiled with
35457 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35458 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35459 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35460 the time and host name to each line.
35461 The three log streams are mapped onto syslog priorities as follows:
35462
35463 .ilist
35464 &'mainlog'& is mapped to LOG_INFO
35465 .next
35466 &'rejectlog'& is mapped to LOG_NOTICE
35467 .next
35468 &'paniclog'& is mapped to LOG_ALERT
35469 .endlist
35470
35471 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35472 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35473 these are routed by syslog to the same place. You can suppress this duplication
35474 by setting &%syslog_duplication%& false.
35475
35476 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35477 entries contain multiple lines when headers are included. To cope with both
35478 these cases, entries written to syslog are split into separate &[syslog()]&
35479 calls at each internal newline, and also after a maximum of
35480 870 data characters. (This allows for a total syslog line length of 1024, when
35481 additions such as timestamps are added.) If you are running a syslog
35482 replacement that can handle lines longer than the 1024 characters allowed by
35483 RFC 3164, you should set
35484 .code
35485 SYSLOG_LONG_LINES=yes
35486 .endd
35487 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35488 lines, but it still splits at internal newlines in &'reject'& log entries.
35489
35490 To make it easy to re-assemble split lines later, each component of a split
35491 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35492 where <&'n'&> is the component number and <&'m'&> is the total number of
35493 components in the entry. The / delimiter is used when the line was split
35494 because it was too long; if it was split because of an internal newline, the \
35495 delimiter is used. For example, supposing the length limit to be 50 instead of
35496 870, the following would be the result of a typical rejection message to
35497 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35498 name, and pid as added by syslog:
35499 .code
35500 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35501 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35502 [3/5]  when scanning for sender: missing or malformed lo
35503 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35504 [5/5] mple>)
35505 .endd
35506 The same error might cause the following lines to be written to &"rejectlog"&
35507 (LOG_NOTICE):
35508 .code
35509 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35510 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35511 [3/18] er when scanning for sender: missing or malformed
35512 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35513 [5\18] .example>)
35514 [6\18] Recipients: ph10@some.domain.cam.example
35515 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35516 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35517 [9\18]        id 16RdAL-0006pc-00
35518 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35519 [11\18] 09:43 +0100
35520 [12\18] F From: <>
35521 [13\18]   Subject: this is a test header
35522 [18\18]   X-something: this is another header
35523 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35524 [16\18] le>
35525 [17\18] B Bcc:
35526 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35527 .endd
35528 Log lines that are neither too long nor contain newlines are written to syslog
35529 without modification.
35530
35531 If only syslog is being used, the Exim monitor is unable to provide a log tail
35532 display, unless syslog is routing &'mainlog'& to a file on the local host and
35533 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35534 where it is.
35535
35536
35537
35538 .section "Log line flags" "SECID250"
35539 One line is written to the main log for each message received, and for each
35540 successful, unsuccessful, and delayed delivery. These lines can readily be
35541 picked out by the distinctive two-character flags that immediately follow the
35542 timestamp. The flags are:
35543 .display
35544 &`<=`&     message arrival
35545 &`(=`&     message fakereject
35546 &`=>`&     normal message delivery
35547 &`->`&     additional address in same delivery
35548 &`>>`&     cutthrough message delivery
35549 &`*>`&     delivery suppressed by &%-N%&
35550 &`**`&     delivery failed; address bounced
35551 &`==`&     delivery deferred; temporary problem
35552 .endd
35553
35554
35555 .section "Logging message reception" "SECID251"
35556 .cindex "log" "reception line"
35557 The format of the single-line entry in the main log that is written for every
35558 message received is shown in the basic example below, which is split over
35559 several lines in order to fit it on the page:
35560 .code
35561 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35562   H=mailer.fict.example [192.168.123.123] U=exim
35563   P=smtp S=5678 id=<incoming message id>
35564 .endd
35565 The address immediately following &"<="& is the envelope sender address. A
35566 bounce message is shown with the sender address &"<>"&, and if it is locally
35567 generated, this is followed by an item of the form
35568 .code
35569 R=<message id>
35570 .endd
35571 which is a reference to the message that caused the bounce to be sent.
35572
35573 .cindex "HELO"
35574 .cindex "EHLO"
35575 For messages from other hosts, the H and U fields identify the remote host and
35576 record the RFC 1413 identity of the user that sent the message, if one was
35577 received. The number given in square brackets is the IP address of the sending
35578 host. If there is a single, unparenthesized  host name in the H field, as
35579 above, it has been verified to correspond to the IP address (see the
35580 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35581 by the remote host in the SMTP HELO or EHLO command, and has not been
35582 verified. If verification yields a different name to that given for HELO or
35583 EHLO, the verified name appears first, followed by the HELO or EHLO
35584 name in parentheses.
35585
35586 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35587 without brackets, in the HELO or EHLO command, leading to entries in
35588 the log containing text like these examples:
35589 .code
35590 H=(10.21.32.43) [192.168.8.34]
35591 H=([10.21.32.43]) [192.168.8.34]
35592 .endd
35593 This can be confusing. Only the final address in square brackets can be relied
35594 on.
35595
35596 For locally generated messages (that is, messages not received over TCP/IP),
35597 the H field is omitted, and the U field contains the login name of the caller
35598 of Exim.
35599
35600 .cindex "authentication" "logging"
35601 .cindex "AUTH" "logging"
35602 For all messages, the P field specifies the protocol used to receive the
35603 message. This is the value that is stored in &$received_protocol$&. In the case
35604 of incoming SMTP messages, the value indicates whether or not any SMTP
35605 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35606 session was encrypted, there is an additional X field that records the cipher
35607 suite that was used.
35608
35609 .cindex log protocol
35610 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35611 hosts that have authenticated themselves using the SMTP AUTH command. The first
35612 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35613 there is an additional item A= followed by the name of the authenticator that
35614 was used. If an authenticated identification was set up by the authenticator's
35615 &%server_set_id%& option, this is logged too, separated by a colon from the
35616 authenticator name.
35617
35618 .cindex "size" "of message"
35619 The id field records the existing message id, if present. The size of the
35620 received message is given by the S field. When the message is delivered,
35621 headers may be removed or added, so that the size of delivered copies of the
35622 message may not correspond with this value (and indeed may be different to each
35623 other).
35624
35625 The &%log_selector%& option can be used to request the logging of additional
35626 data when a message is received. See section &<<SECTlogselector>>& below.
35627
35628
35629
35630 .section "Logging deliveries" "SECID252"
35631 .cindex "log" "delivery line"
35632 The format of the single-line entry in the main log that is written for every
35633 delivery is shown in one of the examples below, for local and remote
35634 deliveries, respectively. Each example has been split into multiple lines in order
35635 to fit it on the page:
35636 .code
35637 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35638   <marv@hitch.fict.example> R=localuser T=local_delivery
35639 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35640   monk@holistic.fict.example R=dnslookup T=remote_smtp
35641   H=holistic.fict.example [192.168.234.234]
35642 .endd
35643 For ordinary local deliveries, the original address is given in angle brackets
35644 after the final delivery address, which might be a pipe or a file. If
35645 intermediate address(es) exist between the original and the final address, the
35646 last of these is given in parentheses after the final address. The R and T
35647 fields record the router and transport that were used to process the address.
35648
35649 If SMTP AUTH was used for the delivery there is an additional item A=
35650 followed by the name of the authenticator that was used.
35651 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35652 option, this is logged too, separated by a colon from the authenticator name.
35653
35654 If a shadow transport was run after a successful local delivery, the log line
35655 for the successful delivery has an item added on the end, of the form
35656 .display
35657 &`ST=<`&&'shadow transport name'&&`>`&
35658 .endd
35659 If the shadow transport did not succeed, the error message is put in
35660 parentheses afterwards.
35661
35662 .cindex "asterisk" "after IP address"
35663 When more than one address is included in a single delivery (for example, two
35664 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35665 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35666 down a single SMTP connection, an asterisk follows the IP address in the log
35667 lines for the second and subsequent messages.
35668
35669 .cindex "delivery" "cutthrough; logging"
35670 .cindex "cutthrough" "logging"
35671 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35672 line precedes the reception line, since cutthrough waits for a possible
35673 rejection from the destination in case it can reject the sourced item.
35674
35675 The generation of a reply message by a filter file gets logged as a
35676 &"delivery"& to the addressee, preceded by &">"&.
35677
35678 The &%log_selector%& option can be used to request the logging of additional
35679 data when a message is delivered. See section &<<SECTlogselector>>& below.
35680
35681
35682 .section "Discarded deliveries" "SECID253"
35683 .cindex "discarded messages"
35684 .cindex "message" "discarded"
35685 .cindex "delivery" "discarded; logging"
35686 When a message is discarded as a result of the command &"seen finish"& being
35687 obeyed in a filter file which generates no deliveries, a log entry of the form
35688 .code
35689 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35690   <low.club@bridge.example> R=userforward
35691 .endd
35692 is written, to record why no deliveries are logged. When a message is discarded
35693 because it is aliased to &":blackhole:"& the log line is like this:
35694 .code
35695 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35696   <hole@nowhere.example> R=blackhole_router
35697 .endd
35698
35699
35700 .section "Deferred deliveries" "SECID254"
35701 When a delivery is deferred, a line of the following form is logged:
35702 .code
35703 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35704   R=dnslookup T=smtp defer (146): Connection refused
35705 .endd
35706 In the case of remote deliveries, the error is the one that was given for the
35707 last IP address that was tried. Details of individual SMTP failures are also
35708 written to the log, so the above line would be preceded by something like
35709 .code
35710 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35711   mail1.endrest.example [192.168.239.239]: Connection refused
35712 .endd
35713 When a deferred address is skipped because its retry time has not been reached,
35714 a message is written to the log, but this can be suppressed by setting an
35715 appropriate value in &%log_selector%&.
35716
35717
35718
35719 .section "Delivery failures" "SECID255"
35720 .cindex "delivery" "failure; logging"
35721 If a delivery fails because an address cannot be routed, a line of the
35722 following form is logged:
35723 .code
35724 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35725   <jim@trek99.example>: unknown mail domain
35726 .endd
35727 If a delivery fails at transport time, the router and transport are shown, and
35728 the response from the remote host is included, as in this example:
35729 .code
35730 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35731   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35732   after pipelined RCPT TO:<ace400@pb.example>: host
35733   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35734   <ace400@pb.example>...Addressee unknown
35735 .endd
35736 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35737 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35738 disabling PIPELINING. The log lines for all forms of delivery failure are
35739 flagged with &`**`&.
35740
35741
35742
35743 .section "Fake deliveries" "SECID256"
35744 .cindex "delivery" "fake; logging"
35745 If a delivery does not actually take place because the &%-N%& option has been
35746 used to suppress it, a normal delivery line is written to the log, except that
35747 &"=>"& is replaced by &"*>"&.
35748
35749
35750
35751 .section "Completion" "SECID257"
35752 A line of the form
35753 .code
35754 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35755 .endd
35756 is written to the main log when a message is about to be removed from the spool
35757 at the end of its processing.
35758
35759
35760
35761
35762 .section "Summary of Fields in Log Lines" "SECID258"
35763 .cindex "log" "summary of fields"
35764 A summary of the field identifiers that are used in log lines is shown in
35765 the following table:
35766 .display
35767 &`A   `&        authenticator name (and optional id and sender)
35768 &`C   `&        SMTP confirmation on delivery
35769 &`    `&        command list for &"no mail in SMTP session"&
35770 &`CV  `&        certificate verification status
35771 &`D   `&        duration of &"no mail in SMTP session"&
35772 &`DN  `&        distinguished name from peer certificate
35773 &`DS  `&        DNSSEC secured lookups
35774 &`DT  `&        on &`=>`& lines: time taken for a delivery
35775 &`F   `&        sender address (on delivery lines)
35776 &`H   `&        host name and IP address
35777 &`I   `&        local interface used
35778 &`K   `&        CHUNKING extension used
35779 &`id  `&        message id for incoming message
35780 &`P   `&        on &`<=`& lines: protocol used
35781 &`    `&        on &`=>`& and &`**`& lines: return path
35782 &`PRDR`&        PRDR extension used
35783 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
35784 &`Q   `&        alternate queue name
35785 &`QT  `&        on &`=>`& lines: time spent on queue so far
35786 &`    `&        on &"Completed"& lines: time spent on queue
35787 &`R   `&        on &`<=`& lines: reference for local bounce
35788 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35789 &`S   `&        size of message in bytes
35790 &`SNI `&        server name indication from TLS client hello
35791 &`ST  `&        shadow transport name
35792 &`T   `&        on &`<=`& lines: message subject (topic)
35793 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35794 &`U   `&        local user or RFC 1413 identity
35795 &`X   `&        TLS cipher suite
35796 .endd
35797
35798
35799 .section "Other log entries" "SECID259"
35800 Various other types of log entry are written from time to time. Most should be
35801 self-explanatory. Among the more common are:
35802
35803 .ilist
35804 .cindex "retry" "time not reached"
35805 &'retry time not reached'&&~&~An address previously suffered a temporary error
35806 during routing or local delivery, and the time to retry has not yet arrived.
35807 This message is not written to an individual message log file unless it happens
35808 during the first delivery attempt.
35809 .next
35810 &'retry time not reached for any host'&&~&~An address previously suffered
35811 temporary errors during remote delivery, and the retry time has not yet arrived
35812 for any of the hosts to which it is routed.
35813 .next
35814 .cindex "spool directory" "file locked"
35815 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35816 some other Exim process is already working on the message. This can be quite
35817 common if queue running processes are started at frequent intervals. The
35818 &'exiwhat'& utility script can be used to find out what Exim processes are
35819 doing.
35820 .next
35821 .cindex "error" "ignored"
35822 &'error ignored'&&~&~There are several circumstances that give rise to this
35823 message:
35824 .olist
35825 Exim failed to deliver a bounce message whose age was greater than
35826 &%ignore_bounce_errors_after%&. The bounce was discarded.
35827 .next
35828 A filter file set up a delivery using the &"noerror"& option, and the delivery
35829 failed. The delivery was discarded.
35830 .next
35831 A delivery set up by a router configured with
35832 . ==== As this is a nested list, any displays it contains must be indented
35833 . ==== as otherwise they are too far to the left.
35834 .code
35835     errors_to = <>
35836 .endd
35837 failed. The delivery was discarded.
35838 .endlist olist
35839 .endlist ilist
35840
35841
35842
35843
35844
35845 .section "Reducing or increasing what is logged" "SECTlogselector"
35846 .cindex "log" "selectors"
35847 By setting the &%log_selector%& global option, you can disable some of Exim's
35848 default logging, or you can request additional logging. The value of
35849 &%log_selector%& is made up of names preceded by plus or minus characters. For
35850 example:
35851 .code
35852 log_selector = +arguments -retry_defer
35853 .endd
35854 The list of optional log items is in the following table, with the default
35855 selection marked by asterisks:
35856 .display
35857 &` 8bitmime                   `&  received 8BITMIME status
35858 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35859 &` address_rewrite            `&  address rewriting
35860 &` all_parents                `&  all parents in => lines
35861 &` arguments                  `&  command line arguments
35862 &`*connection_reject          `&  connection rejections
35863 &`*delay_delivery             `&  immediate delivery delayed
35864 &` deliver_time               `&  time taken to perform delivery
35865 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35866 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35867 &` dnssec                     `&  DNSSEC secured lookups
35868 &`*etrn                       `&  ETRN commands
35869 &`*host_lookup_failed         `&  as it says
35870 &` ident_timeout              `&  timeout for ident connection
35871 &` incoming_interface         `&  local interface on <= and => lines
35872 &` incoming_port              `&  remote port on <= lines
35873 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35874 &` outgoing_interface         `&  local interface on => lines
35875 &` outgoing_port              `&  add remote port to => lines
35876 &`*queue_run                  `&  start and end queue runs
35877 &` queue_time                 `&  time on queue for one recipient
35878 &` queue_time_overall         `&  time on queue for whole message
35879 &` pid                        `&  Exim process id
35880 &` proxy                      `&  proxy address on <= and => lines
35881 &` received_recipients        `&  recipients on <= lines
35882 &` received_sender            `&  sender on <= lines
35883 &`*rejected_header            `&  header contents on reject log
35884 &`*retry_defer                `&  &"retry time not reached"&
35885 &` return_path_on_delivery    `&  put return path on => and ** lines
35886 &` sender_on_delivery         `&  add sender to => lines
35887 &`*sender_verify_fail         `&  sender verification failures
35888 &`*size_reject                `&  rejection because too big
35889 &`*skip_delivery              `&  delivery skipped in a queue run
35890 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35891 &` smtp_connection            `&  incoming SMTP connections
35892 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35893 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35894 &` smtp_no_mail               `&  session with no MAIL commands
35895 &` smtp_protocol_error        `&  SMTP protocol errors
35896 &` smtp_syntax_error          `&  SMTP syntax errors
35897 &` subject                    `&  contents of &'Subject:'& on <= lines
35898 &`*tls_certificate_verified   `&  certificate verification status
35899 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35900 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35901 &` tls_sni                    `&  TLS SNI on <= lines
35902 &` unknown_in_list            `&  DNS lookup failed in list match
35903
35904 &` all                        `&  all of the above
35905 .endd
35906 See also the &%slow_lookup_log%& main configuration option,
35907 section &<<SECID99>>&
35908
35909 More details on each of these items follows:
35910
35911 .ilist
35912 .cindex "8BITMIME"
35913 .cindex "log" "8BITMIME"
35914 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35915 which may help in tracking down interoperability issues with ancient MTAs
35916 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35917 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35918 &`7BIT`& and &`8BITMIME`& respectively.
35919 .next
35920 .cindex "&%warn%& ACL verb" "log when skipping"
35921 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35922 its conditions cannot be evaluated, a log line to this effect is written if
35923 this log selector is set.
35924 .next
35925 .cindex "log" "rewriting"
35926 .cindex "rewriting" "logging"
35927 &%address_rewrite%&: This applies both to global rewrites and per-transport
35928 rewrites, but not to rewrites in filters run as an unprivileged user (because
35929 such users cannot access the log).
35930 .next
35931 .cindex "log" "full parentage"
35932 &%all_parents%&: Normally only the original and final addresses are logged on
35933 delivery lines; with this selector, intermediate parents are given in
35934 parentheses between them.
35935 .next
35936 .cindex "log" "Exim arguments"
35937 .cindex "Exim arguments, logging"
35938 &%arguments%&: This causes Exim to write the arguments with which it was called
35939 to the main log, preceded by the current working directory. This is a debugging
35940 feature, added to make it easier to find out how certain MUAs call
35941 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35942 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35943 that are empty or that contain white space are quoted. Non-printing characters
35944 are shown as escape sequences. This facility cannot log unrecognized arguments,
35945 because the arguments are checked before the configuration file is read. The
35946 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35947 between the caller and Exim.
35948 .next
35949 .cindex "log" "connection rejections"
35950 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35951 connection is rejected, for whatever reason.
35952 .next
35953 .cindex "log" "delayed delivery"
35954 .cindex "delayed delivery, logging"
35955 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35956 started for an incoming message because the load is too high or too many
35957 messages were received on one connection. Logging does not occur if no delivery
35958 process is started because &%queue_only%& is set or &%-odq%& was used.
35959 .next
35960 .cindex "log" "delivery duration"
35961 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35962 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35963 .next
35964 .cindex "log" "message size on delivery"
35965 .cindex "size" "of message"
35966 &%delivery_size%&: For each delivery, the size of message delivered is added to
35967 the &"=>"& line, tagged with S=.
35968 .next
35969 .cindex "log" "dnslist defer"
35970 .cindex "DNS list" "logging defer"
35971 .cindex "black list (DNS)"
35972 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35973 DNS black list suffers a temporary error.
35974 .next
35975 .cindex log dnssec
35976 .cindex dnssec logging
35977 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
35978 dns lookups gave secure results a tag of DS is added.
35979 For acceptance this covers the reverse and forward lookups for host name verification.
35980 It does not cover helo-name verification.
35981 For delivery this covers the SRV, MX, A and/or AAAA lookups.
35982 .next
35983 .cindex "log" "ETRN commands"
35984 .cindex "ETRN" "logging"
35985 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35986 is run to determine whether or not it is actually accepted. An invalid ETRN
35987 command, or one received within a message transaction is not logged by this
35988 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35989 .next
35990 .cindex "log" "host lookup failure"
35991 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35992 any addresses, or when a lookup of an IP address fails to find a host name, a
35993 log line is written. This logging does not apply to direct DNS lookups when
35994 routing email addresses, but it does apply to &"byname"& lookups.
35995 .next
35996 .cindex "log" "ident timeout"
35997 .cindex "RFC 1413" "logging timeout"
35998 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35999 client's ident port times out.
36000 .next
36001 .cindex "log" "incoming interface"
36002 .cindex "log" "local interface"
36003 .cindex "log" "local address and port"
36004 .cindex "TCP/IP" "logging local address and port"
36005 .cindex "interface" "logging"
36006 &%incoming_interface%&: The interface on which a message was received is added
36007 to the &"<="& line as an IP address in square brackets, tagged by I= and
36008 followed by a colon and the port number. The local interface and port are also
36009 added to other SMTP log lines, for example &"SMTP connection from"&, to
36010 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36011 The latter can be disabled by turning off the &%outgoing_interface%& option.
36012 .next
36013 .cindex log "incoming proxy address"
36014 .cindex proxy "logging proxy address"
36015 .cindex "TCP/IP" "logging proxy address"
36016 &%proxy%&: The internal (closest to the system running Exim) IP address
36017 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36018 on a proxied connection
36019 or the &"=>"& line for a message delivered on a proxied connection..
36020 See &<<SECTproxyInbound>>& for more information.
36021 .next
36022 .cindex "log" "incoming remote port"
36023 .cindex "port" "logging remote"
36024 .cindex "TCP/IP" "logging incoming remote port"
36025 .vindex "&$sender_fullhost$&"
36026 .vindex "&$sender_rcvhost$&"
36027 &%incoming_port%&: The remote port number from which a message was received is
36028 added to log entries and &'Received:'& header lines, following the IP address
36029 in square brackets, and separated from it by a colon. This is implemented by
36030 changing the value that is put in the &$sender_fullhost$& and
36031 &$sender_rcvhost$& variables. Recording the remote port number has become more
36032 important with the widening use of NAT (see RFC 2505).
36033 .next
36034 .cindex "log" "dropped connection"
36035 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36036 connection is unexpectedly dropped.
36037 .next
36038 .cindex "log" "outgoing interface"
36039 .cindex "log" "local interface"
36040 .cindex "log" "local address and port"
36041 .cindex "TCP/IP" "logging local address and port"
36042 .cindex "interface" "logging"
36043 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36044 interface on which a message was sent is added to delivery lines as an I= tag
36045 followed by IP address in square brackets. You can disable this by turning
36046 off the &%outgoing_interface%& option.
36047 .next
36048 .cindex "log" "outgoing remote port"
36049 .cindex "port" "logging outgoint remote"
36050 .cindex "TCP/IP" "logging ougtoing remote port"
36051 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36052 containing => tags) following the IP address.
36053 The local port is also added if &%incoming_interface%& and
36054 &%outgoing_interface%& are both enabled.
36055 This option is not included in the default setting, because for most ordinary
36056 configurations, the remote port number is always 25 (the SMTP port), and the
36057 local port is a random ephemeral port.
36058 .next
36059 .cindex "log" "process ids in"
36060 .cindex "pid (process id)" "in log lines"
36061 &%pid%&: The current process id is added to every log line, in square brackets,
36062 immediately after the time and date.
36063 .next
36064 .cindex "log" "queue run"
36065 .cindex "queue runner" "logging"
36066 &%queue_run%&: The start and end of every queue run are logged.
36067 .next
36068 .cindex "log" "queue time"
36069 &%queue_time%&: The amount of time the message has been in the queue on the
36070 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36071 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36072 includes reception time as well as the delivery time for the current address.
36073 This means that it may be longer than the difference between the arrival and
36074 delivery log line times, because the arrival log line is not written until the
36075 message has been successfully received.
36076 .next
36077 &%queue_time_overall%&: The amount of time the message has been in the queue on
36078 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36079 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36080 message, so it includes reception time as well as the total delivery time.
36081 .next
36082 .cindex "log" "recipients"
36083 &%received_recipients%&: The recipients of a message are listed in the main log
36084 as soon as the message is received. The list appears at the end of the log line
36085 that is written when a message is received, preceded by the word &"for"&. The
36086 addresses are listed after they have been qualified, but before any rewriting
36087 has taken place.
36088 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36089 in the list.
36090 .next
36091 .cindex "log" "sender reception"
36092 &%received_sender%&: The unrewritten original sender of a message is added to
36093 the end of the log line that records the message's arrival, after the word
36094 &"from"& (before the recipients if &%received_recipients%& is also set).
36095 .next
36096 .cindex "log" "header lines for rejection"
36097 &%rejected_header%&: If a message's header has been received at the time a
36098 rejection is written to the reject log, the complete header is added to the
36099 log. Header logging can be turned off individually for messages that are
36100 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36101 .next
36102 .cindex "log" "retry defer"
36103 &%retry_defer%&: A log line is written if a delivery is deferred because a
36104 retry time has not yet been reached. However, this &"retry time not reached"&
36105 message is always omitted from individual message logs after the first delivery
36106 attempt.
36107 .next
36108 .cindex "log" "return path"
36109 &%return_path_on_delivery%&: The return path that is being transmitted with
36110 the message is included in delivery and bounce lines, using the tag P=.
36111 This is omitted if no delivery actually happens, for example, if routing fails,
36112 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36113 .next
36114 .cindex "log" "sender on delivery"
36115 &%sender_on_delivery%&: The message's sender address is added to every delivery
36116 and bounce line, tagged by F= (for &"from"&).
36117 This is the original sender that was received with the message; it is not
36118 necessarily the same as the outgoing return path.
36119 .next
36120 .cindex "log" "sender verify failure"
36121 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36122 gives details of a sender verification failure is not written. Log lines for
36123 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36124 detail is lost.
36125 .next
36126 .cindex "log" "size rejection"
36127 &%size_reject%&: A log line is written whenever a message is rejected because
36128 it is too big.
36129 .next
36130 .cindex "log" "frozen messages; skipped"
36131 .cindex "frozen messages" "logging skipping"
36132 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36133 queue run because it is frozen or because another process is already delivering
36134 it.
36135 .cindex "&""spool file is locked""&"
36136 The message that is written is &"spool file is locked"&.
36137 .next
36138 .cindex "log" "smtp confirmation"
36139 .cindex "SMTP" "logging confirmation"
36140 .cindex "LMTP" "logging confirmation"
36141 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36142 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36143 A number of MTAs (including Exim) return an identifying string in this
36144 response.
36145 .next
36146 .cindex "log" "SMTP connections"
36147 .cindex "SMTP" "logging connections"
36148 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36149 established or closed, unless the connection is from a host that matches
36150 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36151 only when the closure is unexpected.) This applies to connections from local
36152 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36153 dropped in the middle of a message, a log line is always written, whether or
36154 not this selector is set, but otherwise nothing is written at the start and end
36155 of connections unless this selector is enabled.
36156
36157 For TCP/IP connections to an Exim daemon, the current number of connections is
36158 included in the log message for each new connection, but note that the count is
36159 reset if the daemon is restarted.
36160 Also, because connections are closed (and the closure is logged) in
36161 subprocesses, the count may not include connections that have been closed but
36162 whose termination the daemon has not yet noticed. Thus, while it is possible to
36163 match up the opening and closing of connections in the log, the value of the
36164 logged counts may not be entirely accurate.
36165 .next
36166 .cindex "log" "SMTP transaction; incomplete"
36167 .cindex "SMTP" "logging incomplete transactions"
36168 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36169 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36170 and the message sender plus any accepted recipients are included in the log
36171 line. This can provide evidence of dictionary attacks.
36172 .next
36173 .cindex "log" "non-MAIL SMTP sessions"
36174 .cindex "MAIL" "logging session without"
36175 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36176 connection terminates without having issued a MAIL command. This includes both
36177 the case when the connection is dropped, and the case when QUIT is used. It
36178 does not include cases where the connection is rejected right at the start (by
36179 an ACL, or because there are too many connections, or whatever). These cases
36180 already have their own log lines.
36181
36182 The log line that is written contains the identity of the client in the usual
36183 way, followed by D= and a time, which records the duration of the connection.
36184 If the connection was authenticated, this fact is logged exactly as it is for
36185 an incoming message, with an A= item. If the connection was encrypted, CV=,
36186 DN=, and X= items may appear as they do for an incoming message, controlled by
36187 the same logging options.
36188
36189 Finally, if any SMTP commands were issued during the connection, a C= item
36190 is added to the line, listing the commands that were used. For example,
36191 .code
36192 C=EHLO,QUIT
36193 .endd
36194 shows that the client issued QUIT straight after EHLO. If there were fewer
36195 than 20 commands, they are all listed. If there were more than 20 commands,
36196 the last 20 are listed, preceded by &"..."&. However, with the default
36197 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36198 have been aborted before 20 non-mail commands are processed.
36199 .next
36200 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36201 colon-separated, is appended to the A= item for a message arrival or delivery
36202 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36203 was accepted or used.
36204 .next
36205 .cindex "log" "SMTP protocol error"
36206 .cindex "SMTP" "logging protocol error"
36207 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36208 encountered. Exim does not have perfect detection of all protocol errors
36209 because of transmission delays and the use of pipelining. If PIPELINING has
36210 been advertised to a client, an Exim server assumes that the client will use
36211 it, and therefore it does not count &"expected"& errors (for example, RCPT
36212 received after rejecting MAIL) as protocol errors.
36213 .next
36214 .cindex "SMTP" "logging syntax errors"
36215 .cindex "SMTP" "syntax errors; logging"
36216 .cindex "SMTP" "unknown command; logging"
36217 .cindex "log" "unknown SMTP command"
36218 .cindex "log" "SMTP syntax error"
36219 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36220 encountered. An unrecognized command is treated as a syntax error. For an
36221 external connection, the host identity is given; for an internal connection
36222 using &%-bs%& the sender identification (normally the calling user) is given.
36223 .next
36224 .cindex "log" "subject"
36225 .cindex "subject, logging"
36226 &%subject%&: The subject of the message is added to the arrival log line,
36227 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36228 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36229 specifies whether characters with values greater than 127 should be logged
36230 unchanged, or whether they should be rendered as escape sequences.
36231 .next
36232 .cindex "log" "certificate verification"
36233 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36234 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36235 verified, and &`CV=no`& if not.
36236 .next
36237 .cindex "log" "TLS cipher"
36238 .cindex "TLS" "logging cipher"
36239 &%tls_cipher%&: When a message is sent or received over an encrypted
36240 connection, the cipher suite used is added to the log line, preceded by X=.
36241 .next
36242 .cindex "log" "TLS peer DN"
36243 .cindex "TLS" "logging peer DN"
36244 &%tls_peerdn%&: When a message is sent or received over an encrypted
36245 connection, and a certificate is supplied by the remote host, the peer DN is
36246 added to the log line, preceded by DN=.
36247 .next
36248 .cindex "log" "TLS SNI"
36249 .cindex "TLS" "logging SNI"
36250 &%tls_sni%&: When a message is received over an encrypted connection, and
36251 the remote host provided the Server Name Indication extension, the SNI is
36252 added to the log line, preceded by SNI=.
36253 .next
36254 .cindex "log" "DNS failure in list"
36255 &%unknown_in_list%&: This setting causes a log entry to be written when the
36256 result of a list match is failure because a DNS lookup failed.
36257 .endlist
36258
36259
36260 .section "Message log" "SECID260"
36261 .cindex "message" "log file for"
36262 .cindex "log" "message log; description of"
36263 .cindex "&_msglog_& directory"
36264 .oindex "&%preserve_message_logs%&"
36265 In addition to the general log files, Exim writes a log file for each message
36266 that it handles. The names of these per-message logs are the message ids, and
36267 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36268 message log contains copies of the log lines that apply to the message. This
36269 makes it easier to inspect the status of an individual message without having
36270 to search the main log. A message log is deleted when processing of the message
36271 is complete, unless &%preserve_message_logs%& is set, but this should be used
36272 only with great care because they can fill up your disk very quickly.
36273
36274 On a heavily loaded system, it may be desirable to disable the use of
36275 per-message logs, in order to reduce disk I/O. This can be done by setting the
36276 &%message_logs%& option false.
36277 .ecindex IIDloggen
36278
36279
36280
36281
36282 . ////////////////////////////////////////////////////////////////////////////
36283 . ////////////////////////////////////////////////////////////////////////////
36284
36285 .chapter "Exim utilities" "CHAPutils"
36286 .scindex IIDutils "utilities"
36287 A number of utility scripts and programs are supplied with Exim and are
36288 described in this chapter. There is also the Exim Monitor, which is covered in
36289 the next chapter. The utilities described here are:
36290
36291 .itable none 0 0 3  7* left  15* left  40* left
36292 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36293   "list what Exim processes are doing"
36294 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36295 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36296 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36297 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36298                                                 various criteria"
36299 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36300 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36301   "extract statistics from the log"
36302 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36303   "check address acceptance from given IP"
36304 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36305 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36306 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36307 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36308 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36309 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36310 .endtable
36311
36312 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36313 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36314 &url(http://duncanthrax.net/exilog/) for details.
36315
36316
36317
36318
36319 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36320 .cindex "&'exiwhat'&"
36321 .cindex "process, querying"
36322 .cindex "SIGUSR1"
36323 On operating systems that can restart a system call after receiving a signal
36324 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36325 a line describing what it is doing to the file &_exim-process.info_& in the
36326 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36327 processes it can find, having first emptied the file. It then waits for one
36328 second to allow the Exim processes to react before displaying the results. In
36329 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36330 send the signal to the Exim processes, so it is normally run as root.
36331
36332 &*Warning*&: This is not an efficient process. It is intended for occasional
36333 use by system administrators. It is not sensible, for example, to set up a
36334 script that sends SIGUSR1 signals to Exim processes at short intervals.
36335
36336
36337 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36338 varies in different operating systems. Not only are different options used,
36339 but the format of the output is different. For this reason, there are some
36340 system configuration options that configure exactly how &'exiwhat'& works. If
36341 it doesn't seem to be working for you, check the following compile-time
36342 options:
36343 .display
36344 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36345 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36346 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36347 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36348 .endd
36349 An example of typical output from &'exiwhat'& is
36350 .code
36351 164 daemon: -q1h, listening on port 25
36352 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36353 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36354   [10.19.42.42] (editor@ref.example)
36355 10592 handling incoming call from [192.168.243.242]
36356 10628 accepting a local non-SMTP message
36357 .endd
36358 The first number in the output line is the process number. The third line has
36359 been split here, in order to fit it on the page.
36360
36361
36362
36363 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36364 .cindex "&'exiqgrep'&"
36365 .cindex "queue" "grepping"
36366 This utility is a Perl script contributed by Matt Hubbard. It runs
36367 .code
36368 exim -bpu
36369 .endd
36370 or (in case &*-a*& switch is specified)
36371 .code
36372 exim -bp
36373 .endd
36374 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36375 contain alternate exim configuration the queue management might be using.
36376
36377 to obtain a queue listing, and then greps the output to select messages
36378 that match given criteria. The following selection options are available:
36379
36380 .vlist
36381 .vitem &*-f*&&~<&'regex'&>
36382 Match the sender address using a case-insensitive search. The field that is
36383 tested is enclosed in angle brackets, so you can test for bounce messages with
36384 .code
36385 exiqgrep -f '^<>$'
36386 .endd
36387 .vitem &*-r*&&~<&'regex'&>
36388 Match a recipient address using a case-insensitive search. The field that is
36389 tested is not enclosed in angle brackets.
36390
36391 .vitem &*-s*&&~<&'regex'&>
36392 Match against the size field.
36393
36394 .vitem &*-y*&&~<&'seconds'&>
36395 Match messages that are younger than the given time.
36396
36397 .vitem &*-o*&&~<&'seconds'&>
36398 Match messages that are older than the given time.
36399
36400 .vitem &*-z*&
36401 Match only frozen messages.
36402
36403 .vitem &*-x*&
36404 Match only non-frozen messages.
36405 .endlist
36406
36407 The following options control the format of the output:
36408
36409 .vlist
36410 .vitem &*-c*&
36411 Display only the count of matching messages.
36412
36413 .vitem &*-l*&
36414 Long format &-- display the full message information as output by Exim. This is
36415 the default.
36416
36417 .vitem &*-i*&
36418 Display message ids only.
36419
36420 .vitem &*-b*&
36421 Brief format &-- one line per message.
36422
36423 .vitem &*-R*&
36424 Display messages in reverse order.
36425
36426 .vitem &*-a*&
36427 Include delivered recipients in queue listing.
36428 .endlist
36429
36430 There is one more option, &%-h%&, which outputs a list of options.
36431
36432
36433
36434 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36435 .cindex "&'exiqsumm'&"
36436 .cindex "queue" "summary"
36437 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36438 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36439 running a command such as
36440 .code
36441 exim -bp | exiqsumm
36442 .endd
36443 The output consists of one line for each domain that has messages waiting for
36444 it, as in the following example:
36445 .code
36446 3   2322   74m   66m  msn.com.example
36447 .endd
36448 Each line lists the number of pending deliveries for a domain, their total
36449 volume, and the length of time that the oldest and the newest messages have
36450 been waiting. Note that the number of pending deliveries is greater than the
36451 number of messages when messages have more than one recipient.
36452
36453 A summary line is output at the end. By default the output is sorted on the
36454 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36455 the output to be sorted by oldest message and by count of messages,
36456 respectively. There are also three options that split the messages for each
36457 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36458 separates frozen messages, and &%-s%& separates messages according to their
36459 sender.
36460
36461 The output of &'exim -bp'& contains the original addresses in the message, so
36462 this also applies to the output from &'exiqsumm'&. No domains from addresses
36463 generated by aliasing or forwarding are included (unless the &%one_time%&
36464 option of the &(redirect)& router has been used to convert them into &"top
36465 level"& addresses).
36466
36467
36468
36469
36470 .section "Extracting specific information from the log (exigrep)" &&&
36471          "SECTextspeinf"
36472 .cindex "&'exigrep'&"
36473 .cindex "log" "extracts; grepping for"
36474 The &'exigrep'& utility is a Perl script that searches one or more main log
36475 files for entries that match a given pattern. When it finds a match, it
36476 extracts all the log entries for the relevant message, not just those that
36477 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36478 given message, or all mail for a given user, or for a given host, for example.
36479 The input files can be in Exim log format or syslog format.
36480 If a matching log line is not associated with a specific message, it is
36481 included in &'exigrep'&'s output without any additional lines. The usage is:
36482 .display
36483 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36484 .endd
36485 If no log file names are given on the command line, the standard input is read.
36486
36487 The &%-t%& argument specifies a number of seconds. It adds an additional
36488 condition for message selection. Messages that are complete are shown only if
36489 they spent more than <&'n'&> seconds on the queue.
36490
36491 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36492 makes it case-sensitive. This may give a performance improvement when searching
36493 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36494 option; with &%-I%& they do not. In both cases it is possible to change the
36495 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36496
36497 The &%-l%& option means &"literal"&, that is, treat all characters in the
36498 pattern as standing for themselves. Otherwise the pattern must be a Perl
36499 regular expression.
36500
36501 The &%-v%& option inverts the matching condition. That is, a line is selected
36502 if it does &'not'& match the pattern.
36503
36504 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36505 that are generated as a result/response to a message that &'exigrep'& matched
36506 normally.
36507
36508 Example of &%-M%&:
36509 user_a sends a message to user_b, which generates a bounce back to user_b. If
36510 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36511 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36512 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36513 when searching for &"user_a"& will show both messages since the bounce is
36514 &"related"& to or a &"result"& of the first message that was found by the
36515 search term.
36516
36517 If the location of a &'zcat'& command is known from the definition of
36518 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36519 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36520 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36521 autodetection of some well known compression extensions.
36522
36523
36524 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36525 .cindex "&'exipick'&"
36526 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36527 lists messages from the queue according to a variety of criteria. For details
36528 of &'exipick'&'s facilities, visit the web page at
36529 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36530 the &%--help%& option.
36531
36532
36533 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36534 .cindex "log" "cycling local files"
36535 .cindex "cycling logs"
36536 .cindex "&'exicyclog'&"
36537 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36538 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36539 you are using log files with datestamps in their names (see section
36540 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36541 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36542 There are two command line options for &'exicyclog'&:
36543 .ilist
36544 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36545 default that is set when Exim is built. The default default is 10.
36546 .next
36547 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36548 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36549 overriding the script's default, which is to find the setting from Exim's
36550 configuration.
36551 .endlist
36552
36553 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36554 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36555 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36556 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36557 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36558 logs are handled similarly.
36559
36560 If the limit is greater than 99, the script uses 3-digit numbers such as
36561 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36562 to one that is greater, or &'vice versa'&, you will have to fix the names of
36563 any existing log files.
36564
36565 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36566 the end are deleted. All files with numbers greater than 01 are compressed,
36567 using a compression command which is configured by the COMPRESS_COMMAND
36568 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36569 root &%crontab%& entry of the form
36570 .code
36571 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36572 .endd
36573 assuming you have used the name &"exim"& for the Exim user. You can run
36574 &'exicyclog'& as root if you wish, but there is no need.
36575
36576
36577
36578 .section "Mail statistics (eximstats)" "SECTmailstat"
36579 .cindex "statistics"
36580 .cindex "&'eximstats'&"
36581 A Perl script called &'eximstats'& is provided for extracting statistical
36582 information from log files. The output is either plain text, or HTML.
36583 Exim log files are also supported by the &'Lire'& system produced by the
36584 LogReport Foundation &url(http://www.logreport.org).
36585
36586 The &'eximstats'& script has been hacked about quite a bit over time. The
36587 latest version is the result of some extensive revision by Steve Campbell. A
36588 lot of information is given by default, but there are options for suppressing
36589 various parts of it. Following any options, the arguments to the script are a
36590 list of files, which should be main log files. For example:
36591 .code
36592 eximstats -nr /var/spool/exim/log/mainlog.01
36593 .endd
36594 By default, &'eximstats'& extracts information about the number and volume of
36595 messages received from or delivered to various hosts. The information is sorted
36596 both by message count and by volume, and the top fifty hosts in each category
36597 are listed on the standard output. Similar information, based on email
36598 addresses or domains instead of hosts can be requested by means of various
36599 options. For messages delivered and received locally, similar statistics are
36600 also produced per user.
36601
36602 The output also includes total counts and statistics about delivery errors, and
36603 histograms showing the number of messages received and deliveries made in each
36604 hour of the day. A delivery with more than one address in its envelope (for
36605 example, an SMTP transaction with more than one RCPT command) is counted
36606 as a single delivery by &'eximstats'&.
36607
36608 Though normally more deliveries than receipts are reported (as messages may
36609 have multiple recipients), it is possible for &'eximstats'& to report more
36610 messages received than delivered, even though the queue is empty at the start
36611 and end of the period in question. If an incoming message contains no valid
36612 recipients, no deliveries are recorded for it. A bounce message is handled as
36613 an entirely separate message.
36614
36615 &'eximstats'& always outputs a grand total summary giving the volume and number
36616 of messages received and deliveries made, and the number of hosts involved in
36617 each case. It also outputs the number of messages that were delayed (that is,
36618 not completely delivered at the first attempt), and the number that had at
36619 least one address that failed.
36620
36621 The remainder of the output is in sections that can be independently disabled
36622 or modified by various options. It consists of a summary of deliveries by
36623 transport, histograms of messages received and delivered per time interval
36624 (default per hour), information about the time messages spent on the queue,
36625 a list of relayed messages, lists of the top fifty sending hosts, local
36626 senders, destination hosts, and destination local users by count and by volume,
36627 and a list of delivery errors that occurred.
36628
36629 The relay information lists messages that were actually relayed, that is, they
36630 came from a remote host and were directly delivered to some other remote host,
36631 without being processed (for example, for aliasing or forwarding) locally.
36632
36633 There are quite a few options for &'eximstats'& to control exactly what it
36634 outputs. These are documented in the Perl script itself, and can be extracted
36635 by running the command &(perldoc)& on the script. For example:
36636 .code
36637 perldoc /usr/exim/bin/eximstats
36638 .endd
36639
36640 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36641 .cindex "&'exim_checkaccess'&"
36642 .cindex "policy control" "checking access"
36643 .cindex "checking access"
36644 The &%-bh%& command line argument allows you to run a fake SMTP session with
36645 debugging output, in order to check what Exim is doing when it is applying
36646 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36647 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36648 sometimes you just want to answer the question &"Does this address have
36649 access?"& without bothering with any further details.
36650
36651 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36652 two arguments, an IP address and an email address:
36653 .code
36654 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36655 .endd
36656 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36657 given email address would be accepted in a RCPT command in a TCP/IP
36658 connection from the host with the given IP address. The output of the utility
36659 is either the word &"accepted"&, or the SMTP error response, for example:
36660 .code
36661 Rejected:
36662 550 Relay not permitted
36663 .endd
36664 When running this test, the utility uses &`<>`& as the envelope sender address
36665 for the MAIL command, but you can change this by providing additional
36666 options. These are passed directly to the Exim command. For example, to specify
36667 that the test is to be run with the sender address &'himself@there.example'&
36668 you can use:
36669 .code
36670 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36671                  -f himself@there.example
36672 .endd
36673 Note that these additional Exim command line items must be given after the two
36674 mandatory arguments.
36675
36676 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36677 while running its checks. You can run checks that include callouts by using
36678 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36679
36680
36681
36682 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36683 .cindex "DBM" "building dbm files"
36684 .cindex "building DBM files"
36685 .cindex "&'exim_dbmbuild'&"
36686 .cindex "lower casing"
36687 .cindex "binary zero" "in lookup key"
36688 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36689 the format used by the &(lsearch)& lookup (see section
36690 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36691 names as keys and the remainder of the information as data. The lower-casing
36692 can be prevented by calling the program with the &%-nolc%& option.
36693
36694 A terminating zero is included as part of the key string. This is expected by
36695 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36696 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36697 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36698 files.
36699
36700 The program requires two arguments: the name of the input file (which can be a
36701 single hyphen to indicate the standard input), and the name of the output file.
36702 It creates the output under a temporary name, and then renames it if all went
36703 well.
36704
36705 .cindex "USE_DB"
36706 If the native DB interface is in use (USE_DB is set in a compile-time
36707 configuration file &-- this is common in free versions of Unix) the two file
36708 names must be different, because in this mode the Berkeley DB functions create
36709 a single output file using exactly the name given. For example,
36710 .code
36711 exim_dbmbuild /etc/aliases /etc/aliases.db
36712 .endd
36713 reads the system alias file and creates a DBM version of it in
36714 &_/etc/aliases.db_&.
36715
36716 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36717 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36718 environment, the suffixes are added to the second argument of
36719 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36720 when the Berkeley functions are used in compatibility mode (though this is not
36721 recommended), because in that case it adds a &_.db_& suffix to the file name.
36722
36723 If a duplicate key is encountered, the program outputs a warning, and when it
36724 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36725 option is used. By default, only the first of a set of duplicates is used &--
36726 this makes it compatible with &(lsearch)& lookups. There is an option
36727 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36728 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36729 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36730 return code is 2.
36731
36732
36733
36734
36735 .section "Finding individual retry times (exinext)" "SECTfinindret"
36736 .cindex "retry" "times"
36737 .cindex "&'exinext'&"
36738 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36739 fish specific information out of the retry database. Given a mail domain (or a
36740 complete address), it looks up the hosts for that domain, and outputs any retry
36741 information for the hosts or for the domain. At present, the retry information
36742 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36743 output. For example:
36744 .code
36745 $ exinext piglet@milne.fict.example
36746 kanga.milne.example:192.168.8.1 error 146: Connection refused
36747   first failed: 21-Feb-1996 14:57:34
36748   last tried:   21-Feb-1996 14:57:34
36749   next try at:  21-Feb-1996 15:02:34
36750 roo.milne.example:192.168.8.3 error 146: Connection refused
36751   first failed: 20-Jan-1996 13:12:08
36752   last tried:   21-Feb-1996 11:42:03
36753   next try at:  21-Feb-1996 19:42:03
36754   past final cutoff time
36755 .endd
36756 You can also give &'exinext'& a local part, without a domain, and it
36757 will give any retry information for that local part in your default domain.
36758 A message id can be used to obtain retry information pertaining to a specific
36759 message. This exists only when an attempt to deliver a message to a remote host
36760 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36761 &'exinext'& is not particularly efficient, but then it is not expected to be
36762 run very often.
36763
36764 The &'exinext'& utility calls Exim to find out information such as the location
36765 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36766 passed on to the &'exim'& commands. The first specifies an alternate Exim
36767 configuration file, and the second sets macros for use within the configuration
36768 file. These features are mainly to help in testing, but might also be useful in
36769 environments where more than one configuration file is in use.
36770
36771
36772
36773 .section "Hints database maintenance" "SECThindatmai"
36774 .cindex "hints database" "maintenance"
36775 .cindex "maintaining Exim's hints database"
36776 Three utility programs are provided for maintaining the DBM files that Exim
36777 uses to contain its delivery hint information. Each program requires two
36778 arguments. The first specifies the name of Exim's spool directory, and the
36779 second is the name of the database it is to operate on. These are as follows:
36780
36781 .ilist
36782 &'retry'&: the database of retry information
36783 .next
36784 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36785 for remote hosts
36786 .next
36787 &'callout'&: the callout cache
36788 .next
36789 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36790 .next
36791 &'misc'&: other hints data
36792 .endlist
36793
36794 The &'misc'& database is used for
36795
36796 .ilist
36797 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36798 .next
36799 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36800 &(smtp)& transport)
36801 .next
36802 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36803 in a transport)
36804 .endlist
36805
36806
36807
36808 .section "exim_dumpdb" "SECID261"
36809 .cindex "&'exim_dumpdb'&"
36810 The entire contents of a database are written to the standard output by the
36811 &'exim_dumpdb'& program, which has no options or arguments other than the
36812 spool and database names. For example, to dump the retry database:
36813 .code
36814 exim_dumpdb /var/spool/exim retry
36815 .endd
36816 Two lines of output are produced for each entry:
36817 .code
36818 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36819 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36820 .endd
36821 The first item on the first line is the key of the record. It starts with one
36822 of the letters R, or T, depending on whether it refers to a routing or
36823 transport retry. For a local delivery, the next part is the local address; for
36824 a remote delivery it is the name of the remote host, followed by its failing IP
36825 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36826 transport). If the remote port is not the standard one (port 25), it is added
36827 to the IP address. Then there follows an error code, an additional error code,
36828 and a textual description of the error.
36829
36830 The three times on the second line are the time of first failure, the time of
36831 the last delivery attempt, and the computed time for the next attempt. The line
36832 ends with an asterisk if the cutoff time for the last retry rule has been
36833 exceeded.
36834
36835 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36836 consists of a host name followed by a list of ids for messages that are or were
36837 waiting to be delivered to that host. If there are a very large number for any
36838 one host, continuation records, with a sequence number added to the host name,
36839 may be seen. The data in these records is often out of date, because a message
36840 may be routed to several alternative hosts, and Exim makes no effort to keep
36841 cross-references.
36842
36843
36844
36845 .section "exim_tidydb" "SECID262"
36846 .cindex "&'exim_tidydb'&"
36847 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36848 database. If run with no options, it removes all records that are more than 30
36849 days old. The age is calculated from the date and time that the record was last
36850 updated. Note that, in the case of the retry database, it is &'not'& the time
36851 since the first delivery failure. Information about a host that has been down
36852 for more than 30 days will remain in the database, provided that the record is
36853 updated sufficiently often.
36854
36855 The cutoff date can be altered by means of the &%-t%& option, which must be
36856 followed by a time. For example, to remove all records older than a week from
36857 the retry database:
36858 .code
36859 exim_tidydb -t 7d /var/spool/exim retry
36860 .endd
36861 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36862 message ids. In the former these appear as data in records keyed by host &--
36863 they were messages that were waiting for that host &-- and in the latter they
36864 are the keys for retry information for messages that have suffered certain
36865 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36866 message ids in database records are those of messages that are still on the
36867 queue. Message ids for messages that no longer exist are removed from
36868 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36869 For the &'retry'& database, records whose keys are non-existent message ids are
36870 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36871 whenever it removes information from the database.
36872
36873 Certain records are automatically removed by Exim when they are no longer
36874 needed, but others are not. For example, if all the MX hosts for a domain are
36875 down, a retry record is created for each one. If the primary MX host comes back
36876 first, its record is removed when Exim successfully delivers to it, but the
36877 records for the others remain because Exim has not tried to use those hosts.
36878
36879 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36880 hints databases. You should do this at a quiet time of day, because it requires
36881 a database to be locked (and therefore inaccessible to Exim) while it does its
36882 work. Removing records from a DBM file does not normally make the file smaller,
36883 but all the common DBM libraries are able to re-use the space that is released.
36884 After an initial phase of increasing in size, the databases normally reach a
36885 point at which they no longer get any bigger, as long as they are regularly
36886 tidied.
36887
36888 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36889 databases is likely to keep on increasing.
36890
36891
36892
36893
36894 .section "exim_fixdb" "SECID263"
36895 .cindex "&'exim_fixdb'&"
36896 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36897 Its main use is for testing Exim, but it might also be occasionally useful for
36898 getting round problems in a live system. It has no options, and its interface
36899 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36900 key of a database record can then be entered, and the data for that record is
36901 displayed.
36902
36903 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36904 except the &'retry'& database, that is the only operation that can be carried
36905 out. For the &'retry'& database, each field is output preceded by a number, and
36906 data for individual fields can be changed by typing the field number followed
36907 by new data, for example:
36908 .code
36909 > 4 951102:1000
36910 .endd
36911 resets the time of the next delivery attempt. Time values are given as a
36912 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36913 used as optional separators.
36914
36915
36916
36917
36918 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36919 .cindex "mailbox" "maintenance"
36920 .cindex "&'exim_lock'&"
36921 .cindex "locking mailboxes"
36922 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36923 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36924 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36925 a user agent while investigating a problem. The utility requires the name of
36926 the file as its first argument. If the locking is successful, the second
36927 argument is run as a command (using C's &[system()]& function); if there is no
36928 second argument, the value of the SHELL environment variable is used; if this
36929 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36930 is unlocked and the utility ends. The following options are available:
36931
36932 .vlist
36933 .vitem &%-fcntl%&
36934 Use &[fcntl()]& locking on the open mailbox.
36935
36936 .vitem &%-flock%&
36937 Use &[flock()]& locking on the open mailbox, provided the operating system
36938 supports it.
36939
36940 .vitem &%-interval%&
36941 This must be followed by a number, which is a number of seconds; it sets the
36942 interval to sleep between retries (default 3).
36943
36944 .vitem &%-lockfile%&
36945 Create a lock file before opening the mailbox.
36946
36947 .vitem &%-mbx%&
36948 Lock the mailbox using MBX rules.
36949
36950 .vitem &%-q%&
36951 Suppress verification output.
36952
36953 .vitem &%-retries%&
36954 This must be followed by a number; it sets the number of times to try to get
36955 the lock (default 10).
36956
36957 .vitem &%-restore_time%&
36958 This option causes &%exim_lock%& to restore the modified and read times to the
36959 locked file before exiting. This allows you to access a locked mailbox (for
36960 example, to take a backup copy) without disturbing the times that the user
36961 subsequently sees.
36962
36963 .vitem &%-timeout%&
36964 This must be followed by a number, which is a number of seconds; it sets a
36965 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36966 default), a non-blocking call is used.
36967
36968 .vitem &%-v%&
36969 Generate verbose output.
36970 .endlist
36971
36972 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36973 default is to create a lock file and also to use &[fcntl()]& locking on the
36974 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36975 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36976 requires that the directory containing the file be writeable. Locking by lock
36977 file does not last for ever; Exim assumes that a lock file is expired if it is
36978 more than 30 minutes old.
36979
36980 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36981 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36982 to be taken out on the open mailbox, and an exclusive lock on the file
36983 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36984 number of the mailbox file. When the locking is released, if an exclusive lock
36985 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36986
36987 The default output contains verification of the locking that takes place. The
36988 &%-v%& option causes some additional information to be given. The &%-q%& option
36989 suppresses all output except error messages.
36990
36991 A command such as
36992 .code
36993 exim_lock /var/spool/mail/spqr
36994 .endd
36995 runs an interactive shell while the file is locked, whereas
36996 .display
36997 &`exim_lock -q /var/spool/mail/spqr <<End`&
36998 <&'some commands'&>
36999 &`End`&
37000 .endd
37001 runs a specific non-interactive sequence of commands while the file is locked,
37002 suppressing all verification output. A single command can be run by a command
37003 such as
37004 .code
37005 exim_lock -q /var/spool/mail/spqr \
37006   "cp /var/spool/mail/spqr /some/where"
37007 .endd
37008 Note that if a command is supplied, it must be entirely contained within the
37009 second argument &-- hence the quotes.
37010 .ecindex IIDutils
37011
37012
37013 . ////////////////////////////////////////////////////////////////////////////
37014 . ////////////////////////////////////////////////////////////////////////////
37015
37016 .chapter "The Exim monitor" "CHAPeximon"
37017 .scindex IIDeximon "Exim monitor" "description"
37018 .cindex "X-windows"
37019 .cindex "&'eximon'&"
37020 .cindex "Local/eximon.conf"
37021 .cindex "&_exim_monitor/EDITME_&"
37022 The Exim monitor is an application which displays in an X window information
37023 about the state of Exim's queue and what Exim is doing. An admin user can
37024 perform certain operations on messages from this GUI interface; however all
37025 such facilities are also available from the command line, and indeed, the
37026 monitor itself makes use of the command line to perform any actions requested.
37027
37028
37029
37030 .section "Running the monitor" "SECID264"
37031 The monitor is started by running the script called &'eximon'&. This is a shell
37032 script that sets up a number of environment variables, and then runs the
37033 binary called &_eximon.bin_&. The default appearance of the monitor window can
37034 be changed by editing the &_Local/eximon.conf_& file created by editing
37035 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37036 parameters are for.
37037
37038 The parameters that get built into the &'eximon'& script can be overridden for
37039 a particular invocation by setting up environment variables of the same names,
37040 preceded by &`EXIMON_`&. For example, a shell command such as
37041 .code
37042 EXIMON_LOG_DEPTH=400 eximon
37043 .endd
37044 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37045 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37046 overrides the Exim log file configuration. This makes it possible to have
37047 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37048 syslog messages are routed to a file on the local host.
37049
37050 X resources can be used to change the appearance of the window in the normal
37051 way. For example, a resource setting of the form
37052 .code
37053 Eximon*background: gray94
37054 .endd
37055 changes the colour of the background to light grey rather than white. The
37056 stripcharts are drawn with both the data lines and the reference lines in
37057 black. This means that the reference lines are not visible when on top of the
37058 data. However, their colour can be changed by setting a resource called
37059 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37060 For example, if your X server is running Unix, you could set up lighter
37061 reference lines in the stripcharts by obeying
37062 .code
37063 xrdb -merge <<End
37064 Eximon*highlight: gray
37065 End
37066 .endd
37067 .cindex "admin user"
37068 In order to see the contents of messages on the queue, and to operate on them,
37069 &'eximon'& must either be run as root or by an admin user.
37070
37071 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37072 contain X11 resource parameters interpreted by the X11 library.  In addition,
37073 if the first parameter starts with the string "gdb" then it is removed and the
37074 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37075 versioned variants of gdb can be invoked).
37076
37077 The monitor's window is divided into three parts. The first contains one or
37078 more stripcharts and two action buttons, the second contains a &"tail"& of the
37079 main log file, and the third is a display of the queue of messages awaiting
37080 delivery, with two more action buttons. The following sections describe these
37081 different parts of the display.
37082
37083
37084
37085
37086 .section "The stripcharts" "SECID265"
37087 .cindex "stripchart"
37088 The first stripchart is always a count of messages on the queue. Its name can
37089 be configured by setting QUEUE_STRIPCHART_NAME in the
37090 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37091 configuration script by regular expression matches on log file entries, making
37092 it possible to display, for example, counts of messages delivered to certain
37093 hosts or using certain transports. The supplied defaults display counts of
37094 received and delivered messages, and of local and SMTP deliveries. The default
37095 period between stripchart updates is one minute; this can be adjusted by a
37096 parameter in the &_Local/eximon.conf_& file.
37097
37098 The stripchart displays rescale themselves automatically as the value they are
37099 displaying changes. There are always 10 horizontal lines in each chart; the
37100 title string indicates the value of each division when it is greater than one.
37101 For example, &"x2"& means that each division represents a value of 2.
37102
37103 It is also possible to have a stripchart which shows the percentage fullness of
37104 a particular disk partition, which is useful when local deliveries are confined
37105 to a single partition.
37106
37107 .cindex "&%statvfs%& function"
37108 This relies on the availability of the &[statvfs()]& function or equivalent in
37109 the operating system. Most, but not all versions of Unix that support Exim have
37110 this. For this particular stripchart, the top of the chart always represents
37111 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37112 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37113 &_Local/eximon.conf_& file.
37114
37115
37116
37117
37118 .section "Main action buttons" "SECID266"
37119 .cindex "size" "of monitor window"
37120 .cindex "Exim monitor" "window size"
37121 .cindex "window size"
37122 Below the stripcharts there is an action button for quitting the monitor. Next
37123 to this is another button marked &"Size"&. They are placed here so that
37124 shrinking the window to its default minimum size leaves just the queue count
37125 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37126 the window to expand to its maximum size, unless it is already at the maximum,
37127 in which case it is reduced to its minimum.
37128
37129 When expanding to the maximum, if the window cannot be fully seen where it
37130 currently is, it is moved back to where it was the last time it was at full
37131 size. When it is expanding from its minimum size, the old position is
37132 remembered, and next time it is reduced to the minimum it is moved back there.
37133
37134 The idea is that you can keep a reduced window just showing one or two
37135 stripcharts at a convenient place on your screen, easily expand it to show
37136 the full window when required, and just as easily put it back to what it was.
37137 The idea is copied from what the &'twm'& window manager does for its
37138 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37139 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37140
37141 Normally, the monitor starts up with the window at its full size, but it can be
37142 built so that it starts up with the window at its smallest size, by setting
37143 START_SMALL=yes in &_Local/eximon.conf_&.
37144
37145
37146
37147 .section "The log display" "SECID267"
37148 .cindex "log" "tail of; in monitor"
37149 The second section of the window is an area in which a display of the tail of
37150 the main log is maintained.
37151 To save space on the screen, the timestamp on each log line is shortened by
37152 removing the date and, if &%log_timezone%& is set, the timezone.
37153 The log tail is not available when the only destination for logging data is
37154 syslog, unless the syslog lines are routed to a local file whose name is passed
37155 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37156
37157 The log sub-window has a scroll bar at its lefthand side which can be used to
37158 move back to look at earlier text, and the up and down arrow keys also have a
37159 scrolling effect. The amount of log that is kept depends on the setting of
37160 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37161 to use. When this is full, the earlier 50% of data is discarded &-- this is
37162 much more efficient than throwing it away line by line. The sub-window also has
37163 a horizontal scroll bar for accessing the ends of long log lines. This is the
37164 only means of horizontal scrolling; the right and left arrow keys are not
37165 available. Text can be cut from this part of the window using the mouse in the
37166 normal way. The size of this subwindow is controlled by parameters in the
37167 configuration file &_Local/eximon.conf_&.
37168
37169 Searches of the text in the log window can be carried out by means of the ^R
37170 and ^S keystrokes, which default to a reverse and a forward search,
37171 respectively. The search covers only the text that is displayed in the window.
37172 It cannot go further back up the log.
37173
37174 The point from which the search starts is indicated by a caret marker. This is
37175 normally at the end of the text in the window, but can be positioned explicitly
37176 by pointing and clicking with the left mouse button, and is moved automatically
37177 by a successful search. If new text arrives in the window when it is scrolled
37178 back, the caret remains where it is, but if the window is not scrolled back,
37179 the caret is moved to the end of the new text.
37180
37181 Pressing ^R or ^S pops up a window into which the search text can be typed.
37182 There are buttons for selecting forward or reverse searching, for carrying out
37183 the search, and for cancelling. If the &"Search"& button is pressed, the search
37184 happens and the window remains so that further searches can be done. If the
37185 &"Return"& key is pressed, a single search is done and the window is closed. If
37186 ^C is typed the search is cancelled.
37187
37188 The searching facility is implemented using the facilities of the Athena text
37189 widget. By default this pops up a window containing both &"search"& and
37190 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37191 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37192 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37193 provided version of &%TextPop%& when the remaining parts of the text widget
37194 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37195 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37196 on these systems, at the expense of having unwanted items in the search popup
37197 window.
37198
37199
37200
37201 .section "The queue display" "SECID268"
37202 .cindex "queue" "display in monitor"
37203 The bottom section of the monitor window contains a list of all messages that
37204 are on the queue, which includes those currently being received or delivered,
37205 as well as those awaiting delivery. The size of this subwindow is controlled by
37206 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37207 at which it is updated is controlled by another parameter in the same file &--
37208 the default is 5 minutes, since queue scans can be quite expensive. However,
37209 there is an &"Update"& action button just above the display which can be used
37210 to force an update of the queue display at any time.
37211
37212 When a host is down for some time, a lot of pending mail can build up for it,
37213 and this can make it hard to deal with other messages on the queue. To help
37214 with this situation there is a button next to &"Update"& called &"Hide"&. If
37215 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37216 type anything in here and press &"Return"&, the text is added to a chain of
37217 such texts, and if every undelivered address in a message matches at least one
37218 of the texts, the message is not displayed.
37219
37220 If there is an address that does not match any of the texts, all the addresses
37221 are displayed as normal. The matching happens on the ends of addresses so, for
37222 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37223 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37224 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37225 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37226 a hide request is automatically cancelled after one hour.
37227
37228 While the dialogue box is displayed, you can't press any buttons or do anything
37229 else to the monitor window. For this reason, if you want to cut text from the
37230 queue display to use in the dialogue box, you have to do the cutting before
37231 pressing the &"Hide"& button.
37232
37233 The queue display contains, for each unhidden queued message, the length of
37234 time it has been on the queue, the size of the message, the message id, the
37235 message sender, and the first undelivered recipient, all on one line. If it is
37236 a bounce message, the sender is shown as &"<>"&. If there is more than one
37237 recipient to which the message has not yet been delivered, subsequent ones are
37238 listed on additional lines, up to a maximum configured number, following which
37239 an ellipsis is displayed. Recipients that have already received the message are
37240 not shown.
37241
37242 .cindex "frozen messages" "display"
37243 If a message is frozen, an asterisk is displayed at the left-hand side.
37244
37245 The queue display has a vertical scroll bar, and can also be scrolled by means
37246 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37247 The text searching facilities, as described above for the log window, are also
37248 available, but the caret is always moved to the end of the text when the queue
37249 display is updated.
37250
37251
37252
37253 .section "The queue menu" "SECID269"
37254 .cindex "queue" "menu in monitor"
37255 If the &%shift%& key is held down and the left button is clicked when the mouse
37256 pointer is over the text for any message, an action menu pops up, and the first
37257 line of the queue display for the message is highlighted. This does not affect
37258 any selected text.
37259
37260 If you want to use some other event for popping up the menu, you can set the
37261 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37262 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37263 value set in this parameter is a standard X event description. For example, to
37264 run eximon using &%ctrl%& rather than &%shift%& you could use
37265 .code
37266 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37267 .endd
37268 The title of the menu is the message id, and it contains entries which act as
37269 follows:
37270
37271 .ilist
37272 &'message log'&: The contents of the message log for the message are displayed
37273 in a new text window.
37274 .next
37275 &'headers'&: Information from the spool file that contains the envelope
37276 information and headers is displayed in a new text window. See chapter
37277 &<<CHAPspool>>& for a description of the format of spool files.
37278 .next
37279 &'body'&: The contents of the spool file containing the body of the message are
37280 displayed in a new text window. There is a default limit of 20,000 bytes to the
37281 amount of data displayed. This can be changed by setting the BODY_MAX
37282 option at compile time, or the EXIMON_BODY_MAX option at run time.
37283 .next
37284 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37285 delivery of the message. This causes an automatic thaw if the message is
37286 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37287 a new text window. The delivery is run in a separate process, to avoid holding
37288 up the monitor while the delivery proceeds.
37289 .next
37290 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37291 that the message be frozen.
37292 .next
37293 .cindex "thawing messages"
37294 .cindex "unfreezing messages"
37295 .cindex "frozen messages" "thawing"
37296 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37297 that the message be thawed.
37298 .next
37299 .cindex "delivery" "forcing failure"
37300 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37301 that Exim gives up trying to deliver the message. A bounce message is generated
37302 for any remaining undelivered addresses.
37303 .next
37304 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37305 that the message be deleted from the system without generating a bounce
37306 message.
37307 .next
37308 &'add recipient'&: A dialog box is displayed into which a recipient address can
37309 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37310 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37311 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37312 causes a call to Exim to be made using the &%-Mar%& option to request that an
37313 additional recipient be added to the message, unless the entry box is empty, in
37314 which case no action is taken.
37315 .next
37316 &'mark delivered'&: A dialog box is displayed into which a recipient address
37317 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37318 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37319 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37320 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37321 recipient address as already delivered, unless the entry box is empty, in which
37322 case no action is taken.
37323 .next
37324 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37325 mark all recipient addresses as already delivered.
37326 .next
37327 &'edit sender'&: A dialog box is displayed initialized with the current
37328 sender's address. Pressing RETURN causes a call to Exim to be made using the
37329 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37330 in which case no action is taken. If you want to set an empty sender (as in
37331 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37332 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37333 the address is qualified with that domain.
37334 .endlist
37335
37336 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37337 other cases when a call to Exim is made, if there is any output from Exim (in
37338 particular, if the command fails) a window containing the command and the
37339 output is displayed. Otherwise, the results of the action are normally apparent
37340 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37341 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37342 if no output is generated.
37343
37344 The queue display is automatically updated for actions such as freezing and
37345 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37346 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37347 force an update of the display after one of these actions.
37348
37349 In any text window that is displayed as result of a menu action, the normal
37350 cut-and-paste facility is available, and searching can be carried out using ^R
37351 and ^S, as described above for the log tail window.
37352 .ecindex IIDeximon
37353
37354
37355
37356
37357
37358 . ////////////////////////////////////////////////////////////////////////////
37359 . ////////////////////////////////////////////////////////////////////////////
37360
37361 .chapter "Security considerations" "CHAPsecurity"
37362 .scindex IIDsecurcon "security" "discussion of"
37363 This chapter discusses a number of issues concerned with security, some of
37364 which are also covered in other parts of this manual.
37365
37366 For reasons that this author does not understand, some people have promoted
37367 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37368 existence of this chapter in the documentation. However, the intent of the
37369 chapter is simply to describe the way Exim works in relation to certain
37370 security concerns, not to make any specific claims about the effectiveness of
37371 its security as compared with other MTAs.
37372
37373 What follows is a description of the way Exim is supposed to be. Best efforts
37374 have been made to try to ensure that the code agrees with the theory, but an
37375 absence of bugs can never be guaranteed. Any that are reported will get fixed
37376 as soon as possible.
37377
37378
37379 .section "Building a more &""hardened""& Exim" "SECID286"
37380 .cindex "security" "build-time features"
37381 There are a number of build-time options that can be set in &_Local/Makefile_&
37382 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37383 Exim administrator who does not have the root password, or by someone who has
37384 penetrated the Exim (but not the root) account. These options are as follows:
37385
37386 .ilist
37387 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37388 start of any file names used with the &%-C%& option. When it is set, these file
37389 names are also not allowed to contain the sequence &"/../"&. (However, if the
37390 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37391 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37392 default setting for &%ALT_CONFIG_PREFIX%&.
37393
37394 If the permitted configuration files are confined to a directory to
37395 which only root has access, this guards against someone who has broken
37396 into the Exim account from running a privileged Exim with an arbitrary
37397 configuration file, and using it to break into other accounts.
37398 .next
37399
37400 If a non-trusted configuration file (i.e. not the default configuration file
37401 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37402 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37403 the next item), then root privilege is retained only if the caller of Exim is
37404 root. This locks out the possibility of testing a configuration using &%-C%&
37405 right through message reception and delivery, even if the caller is root. The
37406 reception works, but by that time, Exim is running as the Exim user, so when
37407 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37408 privilege to be lost. However, root can test reception and delivery using two
37409 separate commands.
37410
37411 .next
37412 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37413 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37414 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37415 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37416 the restrictive side.  Requiring build-time selection of safe macros is onerous
37417 but this option is intended solely as a transition mechanism to permit
37418 previously-working configurations to continue to work after release 4.73.
37419 .next
37420 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37421 is disabled.
37422 .next
37423 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37424 never to be used for any deliveries. This is like the &%never_users%& runtime
37425 option, but it cannot be overridden; the runtime option adds additional users
37426 to the list. The default setting is &"root"&; this prevents a non-root user who
37427 is permitted to modify the runtime file from using Exim as a way to get root.
37428 .endlist
37429
37430
37431
37432 .section "Root privilege" "SECID270"
37433 .cindex "setuid"
37434 .cindex "root privilege"
37435 The Exim binary is normally setuid to root, which means that it gains root
37436 privilege (runs as root) when it starts execution. In some special cases (for
37437 example, when the daemon is not in use and there are no local deliveries), it
37438 may be possible to run Exim setuid to some user other than root. This is
37439 discussed in the next section. However, in most installations, root privilege
37440 is required for two things:
37441
37442 .ilist
37443 To set up a socket connected to the standard SMTP port (25) when initialising
37444 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37445 not required.
37446 .next
37447 To be able to change uid and gid in order to read users' &_.forward_& files and
37448 perform local deliveries as the receiving user or as specified in the
37449 configuration.
37450 .endlist
37451
37452 It is not necessary to be root to do any of the other things Exim does, such as
37453 receiving messages and delivering them externally over SMTP, and it is
37454 obviously more secure if Exim does not run as root except when necessary.
37455 For this reason, a user and group for Exim to use must be defined in
37456 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37457 group"&. Their values can be changed by the run time configuration, though this
37458 is not recommended. Often a user called &'exim'& is used, but some sites use
37459 &'mail'& or another user name altogether.
37460
37461 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37462 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37463 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37464
37465 After a new Exim process has interpreted its command line options, it changes
37466 uid and gid in the following cases:
37467
37468 .ilist
37469 .oindex "&%-C%&"
37470 .oindex "&%-D%&"
37471 If the &%-C%& option is used to specify an alternate configuration file, or if
37472 the &%-D%& option is used to define macro values for the configuration, and the
37473 calling process is not running as root, the uid and gid are changed to those of
37474 the calling process.
37475 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37476 option may not be used at all.
37477 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37478 can be supplied if the calling process is running as root, the Exim run-time
37479 user or CONFIGURE_OWNER, if defined.
37480 .next
37481 .oindex "&%-be%&"
37482 .oindex "&%-bf%&"
37483 .oindex "&%-bF%&"
37484 If the expansion test option (&%-be%&) or one of the filter testing options
37485 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37486 calling process.
37487 .next
37488 If the process is not a daemon process or a queue runner process or a delivery
37489 process or a process for testing address routing (started with &%-bt%&), the
37490 uid and gid are changed to the Exim user and group. This means that Exim always
37491 runs under its own uid and gid when receiving messages. This also applies when
37492 testing address verification
37493 .oindex "&%-bv%&"
37494 .oindex "&%-bh%&"
37495 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37496 option).
37497 .next
37498 For a daemon, queue runner, delivery, or address testing process, the uid
37499 remains as root at this stage, but the gid is changed to the Exim group.
37500 .endlist
37501
37502 The processes that initially retain root privilege behave as follows:
37503
37504 .ilist
37505 A daemon process changes the gid to the Exim group and the uid to the Exim
37506 user after setting up one or more listening sockets. The &[initgroups()]&
37507 function is called, so that if the Exim user is in any additional groups, they
37508 will be used during message reception.
37509 .next
37510 A queue runner process retains root privilege throughout its execution. Its
37511 job is to fork a controlled sequence of delivery processes.
37512 .next
37513 A delivery process retains root privilege throughout most of its execution,
37514 but any actual deliveries (that is, the transports themselves) are run in
37515 subprocesses which always change to a non-root uid and gid. For local
37516 deliveries this is typically the uid and gid of the owner of the mailbox; for
37517 remote deliveries, the Exim uid and gid are used. Once all the delivery
37518 subprocesses have been run, a delivery process changes to the Exim uid and gid
37519 while doing post-delivery tidying up such as updating the retry database and
37520 generating bounce and warning messages.
37521
37522 While the recipient addresses in a message are being routed, the delivery
37523 process runs as root. However, if a user's filter file has to be processed,
37524 this is done in a subprocess that runs under the individual user's uid and
37525 gid. A system filter is run as root unless &%system_filter_user%& is set.
37526 .next
37527 A process that is testing addresses (the &%-bt%& option) runs as root so that
37528 the routing is done in the same environment as a message delivery.
37529 .endlist
37530
37531
37532
37533
37534 .section "Running Exim without privilege" "SECTrunexiwitpri"
37535 .cindex "privilege, running without"
37536 .cindex "unprivileged running"
37537 .cindex "root privilege" "running without"
37538 Some installations like to run Exim in an unprivileged state for more of its
37539 operation, for added security. Support for this mode of operation is provided
37540 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37541 gid are changed to the Exim user and group at the start of a delivery process
37542 (and also queue runner and address testing processes). This means that address
37543 routing is no longer run as root, and the deliveries themselves cannot change
37544 to any other uid.
37545
37546 .cindex SIGHUP
37547 .cindex "daemon" "restarting"
37548 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37549 that the daemon can still be started in the usual way, and it can respond
37550 correctly to SIGHUP because the re-invocation regains root privilege.
37551
37552 An alternative approach is to make Exim setuid to the Exim user and also setgid
37553 to the Exim group. If you do this, the daemon must be started from a root
37554 process. (Calling Exim from a root process makes it behave in the way it does
37555 when it is setuid root.) However, the daemon cannot restart itself after a
37556 SIGHUP signal because it cannot regain privilege.
37557
37558 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37559 stops Exim from trying to re-invoke itself to do a delivery after a message has
37560 been received. Such a re-invocation is a waste of resources because it has no
37561 effect.
37562
37563 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37564 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37565 to the Exim user seems a clean approach, but there is one complication:
37566
37567 In this style of operation, Exim is running with the real uid and gid set to
37568 those of the calling process, and the effective uid/gid set to Exim's values.
37569 Ideally, any association with the calling process' uid/gid should be dropped,
37570 that is, the real uid/gid should be reset to the effective values so as to
37571 discard any privileges that the caller may have. While some operating systems
37572 have a function that permits this action for a non-root effective uid, quite a
37573 number of them do not. Because of this lack of standardization, Exim does not
37574 address this problem at this time.
37575
37576 For this reason, the recommended approach for &"mostly unprivileged"& running
37577 is to keep the Exim binary setuid to root, and to set
37578 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37579 be used in the most straightforward way.
37580
37581 If you configure Exim not to run delivery processes as root, there are a
37582 number of restrictions on what you can do:
37583
37584 .ilist
37585 You can deliver only as the Exim user/group. You should  explicitly use the
37586 &%user%& and &%group%& options to override routers or local transports that
37587 normally deliver as the recipient. This makes sure that configurations that
37588 work in this mode function the same way in normal mode. Any implicit or
37589 explicit specification of another user causes an error.
37590 .next
37591 Use of &_.forward_& files is severely restricted, such that it is usually
37592 not worthwhile to include them in the configuration.
37593 .next
37594 Users who wish to use &_.forward_& would have to make their home directory and
37595 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37596 and their equivalents in Exim filters, cannot be used. While they could be
37597 enabled in the Exim user's name, that would be insecure and not very useful.
37598 .next
37599 Unless the local user mailboxes are all owned by the Exim user (possible in
37600 some POP3 or IMAP-only environments):
37601
37602 .olist
37603 They must be owned by the Exim group and be writeable by that group. This
37604 implies you must set &%mode%& in the appendfile configuration, as well as the
37605 mode of the mailbox files themselves.
37606 .next
37607 You must set &%no_check_owner%&, since most or all of the files will not be
37608 owned by the Exim user.
37609 .next
37610 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37611 on a newly created mailbox when unprivileged. This also implies that new
37612 mailboxes need to be created manually.
37613 .endlist olist
37614 .endlist ilist
37615
37616
37617 These restrictions severely restrict what can be done in local deliveries.
37618 However, there are no restrictions on remote deliveries. If you are running a
37619 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37620 gives more security at essentially no cost.
37621
37622 If you are using the &%mua_wrapper%& facility (see chapter
37623 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37624
37625
37626
37627
37628 .section "Delivering to local files" "SECID271"
37629 Full details of the checks applied by &(appendfile)& before it writes to a file
37630 are given in chapter &<<CHAPappendfile>>&.
37631
37632
37633
37634 .section "Running local commands" "SECTsecconslocalcmds"
37635 .cindex "security" "local commands"
37636 .cindex "security" "command injection attacks"
37637 There are a number of ways in which an administrator can configure Exim to run
37638 commands based upon received, untrustworthy, data. Further, in some
37639 configurations a user who can control a &_.forward_& file can also arrange to
37640 run commands. Configuration to check includes, but is not limited to:
37641
37642 .ilist
37643 Use of &%use_shell%& in the pipe transport: various forms of shell command
37644 injection may be possible with this option present. It is dangerous and should
37645 be used only with considerable caution. Consider constraints which whitelist
37646 allowed characters in a variable which is to be used in a pipe transport that
37647 has &%use_shell%& enabled.
37648 .next
37649 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37650 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37651 &_.forward_& files in a redirect router. If Exim is running on a central mail
37652 hub to which ordinary users do not have shell access, but home directories are
37653 NFS mounted (for instance) then administrators should review the list of these
37654 forbid options available, and should bear in mind that the options that may
37655 need forbidding can change as new features are added between releases.
37656 .next
37657 The &%${run...}%& expansion item does not use a shell by default, but
37658 administrators can configure use of &_/bin/sh_& as part of the command.
37659 Such invocations should be viewed with prejudicial suspicion.
37660 .next
37661 Administrators who use embedded Perl are advised to explore how Perl's
37662 taint checking might apply to their usage.
37663 .next
37664 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37665 administrators are well advised to view its use with suspicion, in case (for
37666 instance) it allows a local-part to contain embedded Exim directives.
37667 .next
37668 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37669 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37670 each can reference arbitrary lists and files, rather than just being a list
37671 of opaque strings.
37672 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37673 real-world security vulnerabilities caused by its use with untrustworthy data
37674 injected in, for SQL injection attacks.
37675 Consider the use of the &%inlisti%& expansion condition instead.
37676 .endlist
37677
37678
37679
37680
37681 .section "Trust in configuration data" "SECTsecconfdata"
37682 .cindex "security" "data sources"
37683 .cindex "security" "regular expressions"
37684 .cindex "regular expressions" "security"
37685 .cindex "PCRE" "security"
37686 If configuration data for Exim can come from untrustworthy sources, there
37687 are some issues to be aware of:
37688
37689 .ilist
37690 Use of &%${expand...}%& may provide a path for shell injection attacks.
37691 .next
37692 Letting untrusted data provide a regular expression is unwise.
37693 .next
37694 Using &%${match...}%& to apply a fixed regular expression against untrusted
37695 data may result in pathological behaviour within PCRE.  Be aware of what
37696 "backtracking" means and consider options for being more strict with a regular
37697 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37698 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37699 possessive quantifiers or just not using regular expressions against untrusted
37700 data.
37701 .next
37702 It can be important to correctly use &%${quote:...}%&,
37703 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37704 items to ensure that data is correctly constructed.
37705 .next
37706 Some lookups might return multiple results, even though normal usage is only
37707 expected to yield one result.
37708 .endlist
37709
37710
37711
37712
37713 .section "IPv4 source routing" "SECID272"
37714 .cindex "source routing" "in IP packets"
37715 .cindex "IP source routing"
37716 Many operating systems suppress IP source-routed packets in the kernel, but
37717 some cannot be made to do this, so Exim does its own check. It logs incoming
37718 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37719 IPv6. No special checking is currently done.
37720
37721
37722
37723 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37724 Support for these SMTP commands is disabled by default. If required, they can
37725 be enabled by defining suitable ACLs.
37726
37727
37728
37729
37730 .section "Privileged users" "SECID274"
37731 .cindex "trusted users"
37732 .cindex "admin user"
37733 .cindex "privileged user"
37734 .cindex "user" "trusted"
37735 .cindex "user" "admin"
37736 Exim recognizes two sets of users with special privileges. Trusted users are
37737 able to submit new messages to Exim locally, but supply their own sender
37738 addresses and information about a sending host. For other users submitting
37739 local messages, Exim sets up the sender address from the uid, and doesn't
37740 permit a remote host to be specified.
37741
37742 .oindex "&%-f%&"
37743 However, an untrusted user is permitted to use the &%-f%& command line option
37744 in the special form &%-f <>%& to indicate that a delivery failure for the
37745 message should not cause an error report. This affects the message's envelope,
37746 but it does not affect the &'Sender:'& header. Untrusted users may also be
37747 permitted to use specific forms of address with the &%-f%& option by setting
37748 the &%untrusted_set_sender%& option.
37749
37750 Trusted users are used to run processes that receive mail messages from some
37751 other mail domain and pass them on to Exim for delivery either locally, or over
37752 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37753 as any user listed in the &%trusted_users%& configuration option, or under any
37754 group listed in the &%trusted_groups%& option.
37755
37756 Admin users are permitted to do things to the messages on Exim's queue. They
37757 can freeze or thaw messages, cause them to be returned to their senders, remove
37758 them entirely, or modify them in various ways. In addition, admin users can run
37759 the Exim monitor and see all the information it is capable of providing, which
37760 includes the contents of files on the spool.
37761
37762 .oindex "&%-M%&"
37763 .oindex "&%-q%&"
37764 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37765 delivery of messages on its queue is restricted to admin users. This
37766 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37767 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37768 queue is also restricted to admin users. This restriction can be relaxed by
37769 setting &%no_queue_list_requires_admin%&.
37770
37771 Exim recognizes an admin user if the calling process is running as root or as
37772 the Exim user or if any of the groups associated with the calling process is
37773 the Exim group. It is not necessary actually to be running under the Exim
37774 group. However, if admin users who are not root or the Exim user are to access
37775 the contents of files on the spool via the Exim monitor (which runs
37776 unprivileged), Exim must be built to allow group read access to its spool
37777 files.
37778
37779
37780
37781 .section "Spool files" "SECID275"
37782 .cindex "spool directory" "files"
37783 Exim's spool directory and everything it contains is owned by the Exim user and
37784 set to the Exim group. The mode for spool files is defined in the
37785 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37786 any user who is a member of the Exim group can access these files.
37787
37788
37789
37790 .section "Use of argv[0]" "SECID276"
37791 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37792 of specific strings, Exim assumes certain options. For example, calling Exim
37793 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37794 to calling it with the option &%-bS%&. There are no security implications in
37795 this.
37796
37797
37798
37799 .section "Use of %f formatting" "SECID277"
37800 The only use made of &"%f"& by Exim is in formatting load average values. These
37801 are actually stored in integer variables as 1000 times the load average.
37802 Consequently, their range is limited and so therefore is the length of the
37803 converted output.
37804
37805
37806
37807 .section "Embedded Exim path" "SECID278"
37808 Exim uses its own path name, which is embedded in the code, only when it needs
37809 to re-exec in order to regain root privilege. Therefore, it is not root when it
37810 does so. If some bug allowed the path to get overwritten, it would lead to an
37811 arbitrary program's being run as exim, not as root.
37812
37813
37814
37815 .section "Dynamic module directory" "SECTdynmoddir"
37816 Any dynamically loadable modules must be installed into the directory
37817 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37818 loading it.
37819
37820
37821 .section "Use of sprintf()" "SECID279"
37822 .cindex "&[sprintf()]&"
37823 A large number of occurrences of &"sprintf"& in the code are actually calls to
37824 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37825 The intermediate formatting is done into a large fixed buffer by a function
37826 that runs through the format string itself, and checks the length of each
37827 conversion before performing it, thus preventing buffer overruns.
37828
37829 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37830 the output buffer is known to be sufficiently long to contain the converted
37831 string.
37832
37833
37834
37835 .section "Use of debug_printf() and log_write()" "SECID280"
37836 Arbitrary strings are passed to both these functions, but they do their
37837 formatting by calling the function &'string_vformat()'&, which runs through
37838 the format string itself, and checks the length of each conversion.
37839
37840
37841
37842 .section "Use of strcat() and strcpy()" "SECID281"
37843 These are used only in cases where the output buffer is known to be large
37844 enough to hold the result.
37845 .ecindex IIDsecurcon
37846
37847
37848
37849
37850 . ////////////////////////////////////////////////////////////////////////////
37851 . ////////////////////////////////////////////////////////////////////////////
37852
37853 .chapter "Format of spool files" "CHAPspool"
37854 .scindex IIDforspo1 "format" "spool files"
37855 .scindex IIDforspo2 "spool directory" "format of files"
37856 .scindex IIDforspo3 "spool files" "format of"
37857 .cindex "spool files" "editing"
37858 A message on Exim's queue consists of two files, whose names are the message id
37859 followed by -D and -H, respectively. The data portion of the message is kept in
37860 the -D file on its own. The message's envelope, status, and headers are all
37861 kept in the -H file, whose format is described in this chapter. Each of these
37862 two files contains the final component of its own name as its first line. This
37863 is insurance against disk crashes where the directory is lost but the files
37864 themselves are recoverable.
37865
37866 Some people are tempted into editing -D files in order to modify messages. You
37867 need to be extremely careful if you do this; it is not recommended and you are
37868 on your own if you do it. Here are some of the pitfalls:
37869
37870 .ilist
37871 You must ensure that Exim does not try to deliver the message while you are
37872 fiddling with it. The safest way is to take out a write lock on the -D file,
37873 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37874 place, the lock will be retained. If you write a new file and rename it, the
37875 lock will be lost at the instant of rename.
37876 .next
37877 .vindex "&$body_linecount$&"
37878 If you change the number of lines in the file, the value of
37879 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37880 present, this value is not used by Exim, but there is no guarantee that this
37881 will always be the case.
37882 .next
37883 If the message is in MIME format, you must take care not to break it.
37884 .next
37885 If the message is cryptographically signed, any change will invalidate the
37886 signature.
37887 .endlist
37888 All in all, modifying -D files is fraught with danger.
37889
37890 Files whose names end with -J may also be seen in the &_input_& directory (or
37891 its subdirectories when &%split_spool_directory%& is set). These are journal
37892 files, used to record addresses to which the message has been delivered during
37893 the course of a delivery attempt. If there are still undelivered recipients at
37894 the end, the -H file is updated, and the -J file is deleted. If, however, there
37895 is some kind of crash (for example, a power outage) before this happens, the -J
37896 file remains in existence. When Exim next processes the message, it notices the
37897 -J file and uses it to update the -H file before starting the next delivery
37898 attempt.
37899
37900 .section "Format of the -H file" "SECID282"
37901 .cindex "uid (user id)" "in spool file"
37902 .cindex "gid (group id)" "in spool file"
37903 The second line of the -H file contains the login name for the uid of the
37904 process that called Exim to read the message, followed by the numerical uid and
37905 gid. For a locally generated message, this is normally the user who sent the
37906 message. For a message received over TCP/IP via the daemon, it is
37907 normally the Exim user.
37908
37909 The third line of the file contains the address of the message's sender as
37910 transmitted in the envelope, contained in angle brackets. The sender address is
37911 empty for bounce messages. For incoming SMTP mail, the sender address is given
37912 in the MAIL command. For locally generated mail, the sender address is
37913 created by Exim from the login name of the current user and the configured
37914 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37915 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37916 &"<>"& or an address that matches &%untrusted_set_senders%&.
37917
37918 The fourth line contains two numbers. The first is the time that the message
37919 was received, in the conventional Unix form &-- the number of seconds since the
37920 start of the epoch. The second number is a count of the number of messages
37921 warning of delayed delivery that have been sent to the sender.
37922
37923 There follow a number of lines starting with a hyphen. These can appear in any
37924 order, and are omitted when not relevant:
37925
37926 .vlist
37927 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37928 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37929 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37930 recognized, to provide backward compatibility. In the old format, a line of
37931 this form is present for every ACL variable that is not empty. The number
37932 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37933 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37934 the data string for the variable. The string itself starts at the beginning of
37935 the next line, and is followed by a newline character. It may contain internal
37936 newlines.
37937
37938 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37939 A line of this form is present for every ACL connection variable that is
37940 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37941 The length is the length of the data string for the variable. The string itself
37942 starts at the beginning of the next line, and is followed by a newline
37943 character. It may contain internal newlines.
37944
37945 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37946 A line of this form is present for every ACL message variable that is defined.
37947 Note that there is a space between &%-aclm%& and the rest of the name. The
37948 length is the length of the data string for the variable. The string itself
37949 starts at the beginning of the next line, and is followed by a newline
37950 character. It may contain internal newlines.
37951
37952 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37953 This is present if, when the message was received over SMTP, the value of
37954 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37955
37956 .vitem &%-allow_unqualified_recipient%&
37957 This is present if unqualified recipient addresses are permitted in header
37958 lines (to stop such addresses from being qualified if rewriting occurs at
37959 transport time). Local messages that were input using &%-bnq%& and remote
37960 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37961
37962 .vitem &%-allow_unqualified_sender%&
37963 This is present if unqualified sender addresses are permitted in header lines
37964 (to stop such addresses from being qualified if rewriting occurs at transport
37965 time). Local messages that were input using &%-bnq%& and remote messages from
37966 hosts that match &%sender_unqualified_hosts%& set this flag.
37967
37968 .vitem "&%-auth_id%&&~<&'text'&>"
37969 The id information for a message received on an authenticated SMTP connection
37970 &-- the value of the &$authenticated_id$& variable.
37971
37972 .vitem "&%-auth_sender%&&~<&'address'&>"
37973 The address of an authenticated sender &-- the value of the
37974 &$authenticated_sender$& variable.
37975
37976 .vitem "&%-body_linecount%&&~<&'number'&>"
37977 This records the number of lines in the body of the message, and is always
37978 present.
37979
37980 .vitem "&%-body_zerocount%&&~<&'number'&>"
37981 This records the number of binary zero bytes in the body of the message, and is
37982 present if the number is greater than zero.
37983
37984 .vitem &%-deliver_firsttime%&
37985 This is written when a new message is first added to the spool. When the spool
37986 file is updated after a deferral, it is omitted.
37987
37988 .vitem "&%-frozen%&&~<&'time'&>"
37989 .cindex "frozen messages" "spool data"
37990 The message is frozen, and the freezing happened at <&'time'&>.
37991
37992 .vitem "&%-helo_name%&&~<&'text'&>"
37993 This records the host name as specified by a remote host in a HELO or EHLO
37994 command.
37995
37996 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37997 This records the IP address of the host from which the message was received and
37998 the remote port number that was used. It is omitted for locally generated
37999 messages.
38000
38001 .vitem "&%-host_auth%&&~<&'text'&>"
38002 If the message was received on an authenticated SMTP connection, this records
38003 the name of the authenticator &-- the value of the
38004 &$sender_host_authenticated$& variable.
38005
38006 .vitem &%-host_lookup_failed%&
38007 This is present if an attempt to look up the sending host's name from its IP
38008 address failed. It corresponds to the &$host_lookup_failed$& variable.
38009
38010 .vitem "&%-host_name%&&~<&'text'&>"
38011 .cindex "reverse DNS lookup"
38012 .cindex "DNS" "reverse lookup"
38013 This records the name of the remote host from which the message was received,
38014 if the host name was looked up from the IP address when the message was being
38015 received. It is not present if no reverse lookup was done.
38016
38017 .vitem "&%-ident%&&~<&'text'&>"
38018 For locally submitted messages, this records the login of the originating user,
38019 unless it was a trusted user and the &%-oMt%& option was used to specify an
38020 ident value. For messages received over TCP/IP, this records the ident string
38021 supplied by the remote host, if any.
38022
38023 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38024 This records the IP address of the local interface and the port number through
38025 which a message was received from a remote host. It is omitted for locally
38026 generated messages.
38027
38028 .vitem &%-local%&
38029 The message is from a local sender.
38030
38031 .vitem &%-localerror%&
38032 The message is a locally-generated bounce message.
38033
38034 .vitem "&%-local_scan%&&~<&'string'&>"
38035 This records the data string that was returned by the &[local_scan()]& function
38036 when the message was received &-- the value of the &$local_scan_data$&
38037 variable. It is omitted if no data was returned.
38038
38039 .vitem &%-manual_thaw%&
38040 The message was frozen but has been thawed manually, that is, by an explicit
38041 Exim command rather than via the auto-thaw process.
38042
38043 .vitem &%-N%&
38044 A testing delivery process was started using the &%-N%& option to suppress any
38045 actual deliveries, but delivery was deferred. At any further delivery attempts,
38046 &%-N%& is assumed.
38047
38048 .vitem &%-received_protocol%&
38049 This records the value of the &$received_protocol$& variable, which contains
38050 the name of the protocol by which the message was received.
38051
38052 .vitem &%-sender_set_untrusted%&
38053 The envelope sender of this message was set by an untrusted local caller (used
38054 to ensure that the caller is displayed in queue listings).
38055
38056 .vitem "&%-spam_score_int%&&~<&'number'&>"
38057 If a message was scanned by SpamAssassin, this is present. It records the value
38058 of &$spam_score_int$&.
38059
38060 .vitem &%-tls_certificate_verified%&
38061 A TLS certificate was received from the client that sent this message, and the
38062 certificate was verified by the server.
38063
38064 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38065 When the message was received over an encrypted connection, this records the
38066 name of the cipher suite that was used.
38067
38068 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38069 When the message was received over an encrypted connection, and a certificate
38070 was received from the client, this records the Distinguished Name from that
38071 certificate.
38072 .endlist
38073
38074 Following the options there is a list of those addresses to which the message
38075 is not to be delivered. This set of addresses is initialized from the command
38076 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38077 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38078 the address is added to this set. The addresses are kept internally as a
38079 balanced binary tree, and it is a representation of that tree which is written
38080 to the spool file. If an address is expanded via an alias or forward file, the
38081 original address is added to the tree when deliveries to all its child
38082 addresses are complete.
38083
38084 If the tree is empty, there is a single line in the spool file containing just
38085 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38086 Y or N, followed by an address. The address is the value for the node of the
38087 tree, and the letters indicate whether the node has a left branch and/or a
38088 right branch attached to it, respectively. If branches exist, they immediately
38089 follow. Here is an example of a three-node tree:
38090 .code
38091 YY darcy@austen.fict.example
38092 NN alice@wonderland.fict.example
38093 NN editor@thesaurus.ref.example
38094 .endd
38095 After the non-recipients tree, there is a list of the message's recipients.
38096 This is a simple list, preceded by a count. It includes all the original
38097 recipients of the message, including those to whom the message has already been
38098 delivered. In the simplest case, the list contains one address per line. For
38099 example:
38100 .code
38101 4
38102 editor@thesaurus.ref.example
38103 darcy@austen.fict.example
38104 rdo@foundation
38105 alice@wonderland.fict.example
38106 .endd
38107 However, when a child address has been added to the top-level addresses as a
38108 result of the use of the &%one_time%& option on a &(redirect)& router, each
38109 line is of the following form:
38110 .display
38111 <&'top-level address'&> <&'errors_to address'&> &&&
38112   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38113 .endd
38114 The 01 flag bit indicates the presence of the three other fields that follow
38115 the top-level address. Other bits may be used in future to support additional
38116 fields. The <&'parent number'&> is the offset in the recipients list of the
38117 original parent of the &"one time"& address. The first two fields are the
38118 envelope sender that is associated with this address and its length. If the
38119 length is zero, there is no special envelope sender (there are then two space
38120 characters in the line). A non-empty field can arise from a &(redirect)& router
38121 that has an &%errors_to%& setting.
38122
38123
38124 A blank line separates the envelope and status information from the headers
38125 which follow. A header may occupy several lines of the file, and to save effort
38126 when reading it in, each header is preceded by a number and an identifying
38127 character. The number is the number of characters in the header, including any
38128 embedded newlines and the terminating newline. The character is one of the
38129 following:
38130
38131 .table2 50pt
38132 .row <&'blank'&>         "header in which Exim has no special interest"
38133 .row &`B`&               "&'Bcc:'& header"
38134 .row &`C`&               "&'Cc:'& header"
38135 .row &`F`&               "&'From:'& header"
38136 .row &`I`&               "&'Message-id:'& header"
38137 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38138 .row &`R`&               "&'Reply-To:'& header"
38139 .row &`S`&               "&'Sender:'& header"
38140 .row &`T`&               "&'To:'& header"
38141 .row &`*`&               "replaced or deleted header"
38142 .endtable
38143
38144 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38145 purposes. They are not transmitted when the message is delivered. Here is a
38146 typical set of headers:
38147 .code
38148 111P Received: by hobbit.fict.example with local (Exim 4.00)
38149 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38150 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38151 038* X-rewrote-sender: bb@hobbit.fict.example
38152 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38153 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38154 099* To: alice@wonderland.fict.example, rdo@foundation,
38155 darcy@austen.fict.example, editor@thesaurus.ref.example
38156 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38157 darcy@austen.fict.example, editor@thesaurus.ref.example
38158 038  Date: Fri, 11 May 2001 10:28:59 +0100
38159 .endd
38160 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38161 &'To:'& header have been rewritten, the last one because routing expanded the
38162 unqualified domain &'foundation'&.
38163 .ecindex IIDforspo1
38164 .ecindex IIDforspo2
38165 .ecindex IIDforspo3
38166
38167 . ////////////////////////////////////////////////////////////////////////////
38168 . ////////////////////////////////////////////////////////////////////////////
38169
38170 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38171          "DKIM Support"
38172 .cindex "DKIM"
38173
38174 DKIM is a mechanism by which messages sent by some entity can be provably
38175 linked to a domain which that entity controls.  It permits reputation to
38176 be tracked on a per-domain basis, rather than merely upon source IP address.
38177 DKIM is documented in RFC 4871.
38178
38179 DKIM support is compiled into Exim by default if TLS support is present.
38180 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38181
38182 Exim's DKIM implementation allows for
38183 .olist
38184 Signing outgoing messages: This function is implemented in the SMTP transport.
38185 It can co-exist with all other Exim features
38186 (including transport filters)
38187 except cutthrough delivery.
38188 .next
38189 Verifying signatures in incoming messages: This is implemented by an additional
38190 ACL (acl_smtp_dkim), which can be called several times per message, with
38191 different signature contexts.
38192 .endlist
38193
38194 In typical Exim style, the verification implementation does not include any
38195 default "policy". Instead it enables you to build your own policy using
38196 Exim's standard controls.
38197
38198 Please note that verification of DKIM signatures in incoming mail is turned
38199 on by default for logging purposes. For each signature in incoming email,
38200 exim will log a line displaying the most important signature details, and the
38201 signature status. Here is an example (with line-breaks added for clarity):
38202 .code
38203 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38204     d=facebookmail.com s=q1-2009b
38205     c=relaxed/relaxed a=rsa-sha1
38206     i=@facebookmail.com t=1252484542 [verification succeeded]
38207 .endd
38208 You might want to turn off DKIM verification processing entirely for internal
38209 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38210 control modifier. This should typically be done in the RCPT ACL, at points
38211 where you accept mail from relay sources (internal hosts or authenticated
38212 senders).
38213
38214
38215 .section "Signing outgoing messages" "SECDKIMSIGN"
38216 .cindex "DKIM" "signing"
38217
38218 Signing is enabled by setting private options on the SMTP transport.
38219 These options take (expandable) strings as arguments.
38220
38221 .option dkim_domain smtp string&!! unset
38222 MANDATORY:
38223 The domain you want to sign with. The result of this expanded
38224 option is put into the &%$dkim_domain%& expansion variable.
38225
38226 .option dkim_selector smtp string&!! unset
38227 MANDATORY:
38228 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38229 variable to look up a matching selector. The result is put in the expansion
38230 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38231 option along with &%$dkim_domain%&.
38232
38233 .option dkim_private_key smtp string&!! unset
38234 MANDATORY:
38235 This sets the private key to use. You can use the &%$dkim_domain%& and
38236 &%$dkim_selector%& expansion variables to determine the private key to use.
38237 The result can either
38238 .ilist
38239 be a valid RSA private key in ASCII armor, including line breaks.
38240 .next
38241 start with a slash, in which case it is treated as a file that contains
38242 the private key.
38243 .next
38244 be "0", "false" or the empty string, in which case the message will not
38245 be signed. This case will not result in an error, even if &%dkim_strict%&
38246 is set.
38247 .endlist
38248
38249 .option dkim_canon smtp string&!! unset
38250 OPTIONAL:
38251 This option sets the canonicalization method used when signing a message.
38252 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38253 The option defaults to "relaxed" when unset. Note: the current implementation
38254 only supports using the same canonicalization method for both headers and body.
38255
38256 .option dkim_strict smtp string&!! unset
38257 OPTIONAL:
38258 This  option  defines  how  Exim  behaves  when  signing a message that
38259 should be signed fails for some reason.  When the expansion evaluates to
38260 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38261 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38262 variables here.
38263
38264 .option dkim_sign_headers smtp string&!! unset
38265 OPTIONAL:
38266 When set, this option must expand to (or be specified as) a colon-separated
38267 list of header names. Headers with these names will be included in the message
38268 signature. When unspecified, the header names recommended in RFC4871 will be
38269 used.
38270
38271
38272 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38273 .cindex "DKIM" "verification"
38274
38275 Verification of DKIM signatures in SMTP incoming email is implemented via the
38276 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38277 syntactically(!) correct signature in the incoming message.
38278 A missing ACL definition defaults to accept.
38279 If any ACL call does not accept, the message is not accepted.
38280 If a cutthrough delivery was in progress for the message it is
38281 summarily dropped (having wasted the transmission effort).
38282
38283 To evaluate the signature in the ACL a large number of expansion variables
38284 containing the signature status and its details are set up during the
38285 runtime of the ACL.
38286
38287 Calling the ACL only for existing signatures is not sufficient to build
38288 more advanced policies. For that reason, the global option
38289 &%dkim_verify_signers%&, and a global expansion variable
38290 &%$dkim_signers%& exist.
38291
38292 The global option &%dkim_verify_signers%& can be set to a colon-separated
38293 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38294 called. It is expanded when the message has been received. At this point,
38295 the expansion variable &%$dkim_signers%& already contains a colon-separated
38296 list of signer domains and identities for the message. When
38297 &%dkim_verify_signers%& is not specified in the main configuration,
38298 it defaults as:
38299 .code
38300 dkim_verify_signers = $dkim_signers
38301 .endd
38302 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38303 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38304 call the ACL for known domains or identities. This would be achieved as follows:
38305 .code
38306 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38307 .endd
38308 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38309 and "ebay.com", plus all domains and identities that have signatures in the message.
38310 You can also be more creative in constructing your policy. For example:
38311 .code
38312 dkim_verify_signers = $sender_address_domain:$dkim_signers
38313 .endd
38314
38315 If a domain or identity is listed several times in the (expanded) value of
38316 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38317
38318
38319 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38320 available (from most to least important):
38321
38322
38323 .vlist
38324 .vitem &%$dkim_cur_signer%&
38325 The signer that is being evaluated in this ACL run. This can be a domain or
38326 an identity. This is one of the list items from the expanded main option
38327 &%dkim_verify_signers%& (see above).
38328
38329 .vitem &%$dkim_verify_status%&
38330 A string describing the general status of the signature. One of
38331 .ilist
38332 &%none%&: There is no signature in the message for the current domain or
38333 identity (as reflected by &%$dkim_cur_signer%&).
38334 .next
38335 &%invalid%&: The signature could not be verified due to a processing error.
38336 More detail is available in &%$dkim_verify_reason%&.
38337 .next
38338 &%fail%&: Verification of the signature failed.  More detail is
38339 available in &%$dkim_verify_reason%&.
38340 .next
38341 &%pass%&: The signature passed verification. It is valid.
38342 .endlist
38343
38344 .vitem &%$dkim_verify_reason%&
38345 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38346 "fail" or "invalid". One of
38347 .ilist
38348 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38349 key for the domain could not be retrieved. This may be a temporary problem.
38350 .next
38351 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38352 record for the domain is syntactically invalid.
38353 .next
38354 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38355 body hash does not match the one specified in the signature header. This
38356 means that the message body was modified in transit.
38357 .next
38358 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38359 could not be verified. This may mean that headers were modified,
38360 re-written or otherwise changed in a way which is incompatible with
38361 DKIM verification. It may of course also mean that the signature is forged.
38362 .endlist
38363
38364 .vitem &%$dkim_domain%&
38365 The signing domain. IMPORTANT: This variable is only populated if there is
38366 an actual signature in the message for the current domain or identity (as
38367 reflected by &%$dkim_cur_signer%&).
38368
38369 .vitem &%$dkim_identity%&
38370 The signing identity, if present. IMPORTANT: This variable is only populated
38371 if there is an actual signature in the message for the current domain or
38372 identity (as reflected by &%$dkim_cur_signer%&).
38373
38374 .vitem &%$dkim_selector%&
38375 The key record selector string.
38376
38377 .vitem &%$dkim_algo%&
38378 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38379
38380 .vitem &%$dkim_canon_body%&
38381 The body canonicalization method. One of 'relaxed' or 'simple'.
38382
38383 .vitem &%dkim_canon_headers%&
38384 The header canonicalization method. One of 'relaxed' or 'simple'.
38385
38386 .vitem &%$dkim_copiedheaders%&
38387 A transcript of headers and their values which are included in the signature
38388 (copied from the 'z=' tag of the signature).
38389 .new
38390 Note that RFC6376 requires that verification fail if the From: header is
38391 not included in the signature.  Exim does not enforce this; sites wishing
38392 strict enforcement should code the check explicitly.
38393 .wen
38394
38395 .vitem &%$dkim_bodylength%&
38396 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38397 limit was set by the signer, "9999999999999" is returned. This makes sure
38398 that this variable always expands to an integer value.
38399
38400 .vitem &%$dkim_created%&
38401 UNIX timestamp reflecting the date and time when the signature was created.
38402 When this was not specified by the signer, "0" is returned.
38403
38404 .vitem &%$dkim_expires%&
38405 UNIX timestamp reflecting the date and time when the signer wants the
38406 signature to be treated as "expired". When this was not specified by the
38407 signer, "9999999999999" is returned. This makes it possible to do useful
38408 integer size comparisons against this value.
38409
38410 .vitem &%$dkim_headernames%&
38411 A colon-separated list of names of headers included in the signature.
38412
38413 .vitem &%$dkim_key_testing%&
38414 "1" if the key record has the "testing" flag set, "0" if not.
38415
38416 .vitem &%$dkim_key_nosubdomains%&
38417 "1" if the key record forbids subdomaining, "0" otherwise.
38418
38419 .vitem &%$dkim_key_srvtype%&
38420 Service type (tag s=) from the key record. Defaults to "*" if not specified
38421 in the key record.
38422
38423 .vitem &%$dkim_key_granularity%&
38424 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38425 in the key record.
38426
38427 .vitem &%$dkim_key_notes%&
38428 Notes from the key record (tag n=).
38429
38430 .vitem &%$dkim_key_length%&
38431 Number of bits in the key.
38432 .endlist
38433
38434 In addition, two ACL conditions are provided:
38435
38436 .vlist
38437 .vitem &%dkim_signers%&
38438 ACL condition that checks a colon-separated list of domains or identities
38439 for a match against the domain or identity that the ACL is currently verifying
38440 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38441 verb to a group of domains or identities. For example:
38442
38443 .code
38444 # Warn when Mail purportedly from GMail has no gmail signature
38445 warn log_message = GMail sender without gmail.com DKIM signature
38446      sender_domains = gmail.com
38447      dkim_signers = gmail.com
38448      dkim_status = none
38449 .endd
38450
38451 .new
38452 Note that the above does not check for a total lack of DKIM signing;
38453 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38454 .wen
38455
38456 .vitem &%dkim_status%&
38457 ACL condition that checks a colon-separated list of possible DKIM verification
38458 results against the actual result of verification. This is typically used
38459 to restrict an ACL verb to a list of verification outcomes, for example:
38460
38461 .code
38462 deny message = Mail from Paypal with invalid/missing signature
38463      sender_domains = paypal.com:paypal.de
38464      dkim_signers = paypal.com:paypal.de
38465      dkim_status = none:invalid:fail
38466 .endd
38467
38468 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38469 see the documentation of the &%$dkim_verify_status%& expansion variable above
38470 for more information of what they mean.
38471 .endlist
38472
38473 . ////////////////////////////////////////////////////////////////////////////
38474 . ////////////////////////////////////////////////////////////////////////////
38475
38476 .chapter "Proxies" "CHAPproxies" &&&
38477          "Proxy support"
38478 .cindex "proxy support"
38479 .cindex "proxy" "access via"
38480
38481 A proxy is an intermediate system through which communication is passed.
38482 Proxies may provide a security, availability or load-distribution function.
38483
38484
38485 .section "Inbound proxies" SECTproxyInbound
38486 .cindex proxy inbound
38487 .cindex proxy "server side"
38488 .cindex proxy "Proxy protocol"
38489 .cindex "Proxy protocol" proxy
38490
38491 Exim has support for receiving inbound SMTP connections via a proxy
38492 that uses &"Proxy Protocol"& to speak to it.
38493 To include this support, include &"SUPPORT_PROXY=yes"&
38494 in Local/Makefile.
38495
38496 It was built on specifications from:
38497 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38498 That URL was revised in May 2014 to version 2 spec:
38499 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38500
38501 The purpose of this facility is so that an application load balancer,
38502 such as HAProxy, can sit in front of several Exim servers
38503 to distribute load.
38504 Exim uses the local protocol communication with the proxy to obtain
38505 the remote SMTP system IP address and port information.
38506 There is no logging if a host passes or
38507 fails Proxy Protocol negotiation, but it can easily be determined and
38508 recorded in an ACL (example is below).
38509
38510 Use of a proxy is enabled by setting the &%hosts_proxy%&
38511 main configuration option to a hostlist; connections from these
38512 hosts will use Proxy Protocol.
38513
38514 .new
38515 The following expansion variables are usable
38516 (&"internal"& and &"external"& here refer to the interfaces
38517 of the proxy):
38518 .display
38519 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38520 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38521 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38522 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38523 &'proxy_session        '& boolean: SMTP connection via proxy
38524 .endd
38525 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38526 there was a protocol error.
38527 .wen
38528
38529 Since the real connections are all coming from the proxy, and the
38530 per host connection tracking is done before Proxy Protocol is
38531 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38532 handle all of the parallel volume you expect per inbound proxy.
38533 With the option set so high, you lose the ability
38534 to protect your server from many connections from one IP.
38535 In order to prevent your server from overload, you
38536 need to add a per connection ratelimit to your connect ACL.
38537 A possible solution is:
38538 .display
38539   # Set max number of connections per host
38540   LIMIT   = 5
38541   # Or do some kind of IP lookup in a flat file or database
38542   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38543
38544   defer   message        = Too many connections from this IP right now
38545           ratelimit      = LIMIT / 5s / per_conn / strict
38546 .endd
38547
38548
38549
38550 .section "Outbound proxies" SECTproxySOCKS
38551 .cindex proxy outbound
38552 .cindex proxy "client side"
38553 .cindex proxy SOCKS
38554 .cindex SOCKS proxy
38555 Exim has support for sending outbound SMTP via a proxy
38556 using a protocol called SOCKS5 (defined by RFC1928).
38557 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38558 Local/Makefile.
38559
38560 Use of a proxy is enabled by setting the &%socks_proxy%& option
38561 on an smtp transport.
38562 The option value is expanded and should then be a list
38563 (colon-separated by default) of proxy specifiers.
38564 Each proxy specifier is a list
38565 (space-separated by default) where the initial element
38566 is an IP address and any subsequent elements are options.
38567
38568 Options are a string <name>=<value>.
38569 The list of options is in the following table:
38570 .display
38571 &'auth   '& authentication method
38572 &'name   '& authentication username
38573 &'pass   '& authentication password
38574 &'port   '& tcp port
38575 &'tmo    '& connection timeout
38576 &'pri    '& priority
38577 &'weight '& selection bias
38578 .endd
38579
38580 More details on each of these options follows:
38581
38582 .ilist
38583 .cindex authentication "to proxy"
38584 .cindex proxy authentication
38585 &%auth%&: Either &"none"& (default) or &"name"&.
38586 Using &"name"& selects username/password authentication per RFC 1929
38587 for access to the proxy.
38588 Default is &"none"&.
38589 .next
38590 &%name%&: sets the username for the &"name"& authentication method.
38591 Default is empty.
38592 .next
38593 &%pass%&: sets the password for the &"name"& authentication method.
38594 Default is empty.
38595 .next
38596 &%port%&: the TCP port number to use for the connection to the proxy.
38597 Default is 1080.
38598 .next
38599 &%tmo%&: sets a connection timeout in seconds for this proxy.
38600 Default is 5.
38601 .next
38602 &%pri%&: specifies a priority for the proxy within the list,
38603 higher values being tried first.
38604 The default priority is 1.
38605 .next
38606 &%weight%&: specifies a selection bias.
38607 Within a priority set servers are queried in a random fashion,
38608 weighted by this value.
38609 The default value for selection bias is 1.
38610 .endlist
38611
38612 Proxies from the list are tried according to their priority
38613 and weight settings until one responds.  The timeout for the
38614 overall connection applies to the set of proxied attempts.
38615
38616 .section Logging SECTproxyLog
38617 To log the (local) IP of a proxy in the incoming or delivery logline,
38618 add &"+proxy"& to the &%log_selector%& option.
38619 This will add a component tagged with &"PRX="& to the line.
38620
38621 . ////////////////////////////////////////////////////////////////////////////
38622 . ////////////////////////////////////////////////////////////////////////////
38623
38624 .chapter "Internationalisation" "CHAPi18n" &&&
38625          "Internationalisation""
38626 .cindex internationalisation "email address"
38627 .cindex EAI
38628 .cindex i18n
38629 .cindex UTF-8 "mail name handling"
38630
38631 Exim has support for Internationalised mail names.
38632 To include this it must be built with SUPPORT_I18N and the libidn library.
38633 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38634
38635 .section "MTA operations" SECTi18nMTA
38636 .cindex SMTPUTF8 "ESMTP option"
38637 The main configuration option &%smtputf8_advertise_hosts%& specifies
38638 a host list.  If this matches the sending host and
38639 accept_8bitmime is true (the default) then the ESMTP option
38640 SMTPUTF8 will be advertised.
38641
38642 If the sender specifies the SMTPUTF8 option on a MAIL command
38643 international handling for the message is enabled and
38644 the expansion variable &$message_smtputf8$& will have value TRUE.
38645
38646 The option &%allow_utf8_domains%& is set to true for this
38647 message. All DNS lookups are converted to a-label form
38648 whatever the setting of &%allow_utf8_domains%&
38649 when Exim is built with SUPPORT_I18N.
38650
38651 Both localparts and domain are maintained as the original
38652 UTF-8 form internally; any comparison or regular-expression use will
38653 require appropriate care.  Filenames created, eg. by
38654 the appendfile transport, will have UTF-8 names.
38655
38656 HELO names sent by the smtp transport will have any UTF-8
38657 components expanded to a-label form,
38658 and any certificate name checks will be done using the a-label
38659 form of the name.
38660
38661 .cindex log protocol
38662 .cindex SMTPUTF8 logging
38663 Log lines and Received-by: header lines will acquire a "utf8"
38664 prefix on the protocol element, eg. utf8esmtp.
38665
38666 The following expansion operators can be used:
38667 .code
38668 ${utf8_domain_to_alabel:str}
38669 ${utf8_domain_from_alabel:str}
38670 ${utf8_localpart_to_alabel:str}
38671 ${utf8_localpart_from_alabel:str}
38672 .endd
38673
38674 ACLs may use the following modifier:
38675 .display
38676 control = utf8_downconvert
38677 control = utf8_downconvert/<value>
38678 .endd
38679 This sets a flag requiring that addresses are converted to
38680 a-label form before smtp delivery, for use in a
38681 Message Submission Agent context.
38682 If a value is appended it may be:
38683 .display
38684 &`1  `& (default) mandatory downconversion
38685 &`0  `& no downconversion
38686 &`-1 `& if SMTPUTF8 not supported by destination host
38687 .endd
38688
38689 If mua_wrapper is set, the utf8_downconvert control
38690 is initially set to -1.
38691
38692
38693 There is no explicit support for VRFY and EXPN.
38694 Configurations supporting these should inspect
38695 &$smtp_command_argument$& for an SMTPUTF8 argument.
38696
38697 There is no support for LMTP on Unix sockets.
38698 Using the "lmtp" protocol option on an smtp transport,
38699 for LMTP over TCP, should work as expected.
38700
38701 There is no support for DSN unitext handling,
38702 and no provision for converting logging from or to UTF-8.
38703
38704
38705
38706 .section "MDA operations" SECTi18nMDA
38707 To aid in constructing names suitable for IMAP folders
38708 the following expansion operator can be used:
38709 .code
38710 ${imapfolder {<string>} {<sep>} {<specials>}}
38711 .endd
38712
38713 The string is converted from the charset specified by
38714 the "headers charset" command (in a filter file)
38715 or &%headers_charset%& main configuration option (otherwise),
38716 to the
38717 modified UTF-7 encoding specified by RFC 2060,
38718 with the following exception: All occurences of <sep>
38719 (which has to be a single character)
38720 are replaced with periods ("."), and all periods and slashes that are not
38721 <sep> and are not in the <specials> string are BASE64 encoded.
38722
38723 The third argument can be omitted, defaulting to an empty string.
38724 The second argument can be omitted, defaulting to "/".
38725
38726 This is the encoding used by Courier for Maildir names on disk, and followed
38727 by many other IMAP servers.
38728
38729 Examples:
38730 .display
38731 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38732 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38733 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38734 .endd
38735
38736 Note that the source charset setting is vital, and also that characters
38737 must be representable in UTF-16.
38738
38739
38740 . ////////////////////////////////////////////////////////////////////////////
38741 . ////////////////////////////////////////////////////////////////////////////
38742
38743 .chapter "Events" "CHAPevents" &&&
38744          "Events"
38745 .cindex events
38746
38747 The events mechanism in Exim can be used to intercept processing at a number
38748 of points.  It was originally invented to giave a way to do customised logging
38749 actions (for example, to a database) but can also be used to modify some
38750 processing actions.
38751
38752 Most installations will never need to use Events.
38753 The support can be left out of a build by defining DISABLE_EVENT=yes
38754 in &_Local/Makefile_&.
38755
38756 There are two major classes of events: main and transport.
38757 The main configuration option &%event_action%& controls reception events;
38758 a transport option &%event_action%& controls delivery events.
38759
38760 Both options are a string which is expanded when the event fires.
38761 An example might look like:
38762 .cindex logging custom
38763 .code
38764 event_action = ${if eq {msg:delivery}{$event_name} \
38765 {${lookup pgsql {SELECT * FROM record_Delivery( \
38766     '${quote_pgsql:$sender_address_domain}',\
38767     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38768     '${quote_pgsql:$domain}', \
38769     '${quote_pgsql:${lc:$local_part}}', \
38770     '${quote_pgsql:$host_address}', \
38771     '${quote_pgsql:${lc:$host}}', \
38772     '${quote_pgsql:$message_exim_id}')}} \
38773 } {}}
38774 .endd
38775
38776 Events have names which correspond to the point in process at which they fire.
38777 The name is placed in the variable &$event_name$& and the event action
38778 expansion must check this, as it will be called for every possible event type.
38779
38780 The current list of events is:
38781 .display
38782 &`msg:complete           after    main       `& per message
38783 &`msg:delivery           after    transport  `& per recipient
38784 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38785 &`msg:rcpt:defer         after    transport  `& per recipient
38786 &`msg:host:defer         after    transport  `& per attempt
38787 &`msg:fail:delivery      after    main       `& per recipient
38788 &`msg:fail:internal      after    main       `& per recipient
38789 &`tcp:connect            before   transport  `& per connection
38790 &`tcp:close              after    transport  `& per connection
38791 &`tls:cert               before   both       `& per certificate in verification chain
38792 &`smtp:connect           after    transport  `& per connection
38793 .endd
38794 New event types may be added in future.
38795
38796 The event name is a colon-separated list, defining the type of
38797 event in a tree of possibilities.  It may be used as a list
38798 or just matched on as a whole.  There will be no spaces in the name.
38799
38800 The second column in the table above describes whether the event fires
38801 before or after the action is associates with.  Those which fire before
38802 can be used to affect that action (more on this below).
38803
38804 An additional variable, &$event_data$&, is filled with information varying
38805 with the event type:
38806 .display
38807 &`msg:delivery         `& smtp confirmation mssage
38808 &`msg:rcpt:host:defer  `& error string
38809 &`msg:rcpt:defer       `& error string
38810 &`msg:host:defer       `& error string
38811 &`tls:cert             `& verification chain depth
38812 &`smtp:connect         `& smtp banner
38813 .endd
38814
38815 The :defer events populate one extra variable: &$event_defer_errno$&.
38816
38817 For complex operations an ACL expansion can be used in &%event_action%&
38818 however due to the multiple contextx that Exim operates in during
38819 the course of its processing:
38820 .ilist
38821 variables set in transport events will not be visible outside that
38822 transport call
38823 .next
38824 acl_m variables in a server context are lost on a new connection,
38825 and after smtp helo/ehlo/mail/starttls/rset commands
38826 .endlist
38827 Using an ACL expansion with the logwrite modifier can be
38828 a useful way of writing to the main log.
38829
38830 The expansion of the event_action option should normally
38831 return an empty string.  Should it return anything else the
38832 following will be forced:
38833 .display
38834 &`msg:delivery     `&  (ignored)
38835 &`msg:host:defer   `&  (ignored)
38836 &`msg:fail:delivery`&  (ignored)
38837 &`tcp:connect      `&  do not connect
38838 &`tcp:close        `&  (ignored)
38839 &`tls:cert         `&  refuse verification
38840 &`smtp:connect     `&  close connection
38841 .endd
38842 No other use is made of the result string.
38843
38844 For a tcp:connect event, if the connection is being made to a proxy
38845 then the address and port variables will be that of the proxy and not
38846 the target system.
38847
38848 For tls:cert events, if GnuTLS is in use this will trigger only per
38849 chain element received on the connection.
38850 For OpenSSL it will trigger for every chain element including those
38851 loaded locally.
38852
38853 . ////////////////////////////////////////////////////////////////////////////
38854 . ////////////////////////////////////////////////////////////////////////////
38855
38856 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38857          "Adding drivers or lookups"
38858 .cindex "adding drivers"
38859 .cindex "new drivers, adding"
38860 .cindex "drivers" "adding new"
38861 The following actions have to be taken in order to add a new router, transport,
38862 authenticator, or lookup type to Exim:
38863
38864 .olist
38865 Choose a name for the driver or lookup type that does not conflict with any
38866 existing name; I will use &"newdriver"& in what follows.
38867 .next
38868 Add to &_src/EDITME_& the line:
38869 .display
38870 <&'type'&>&`_NEWDRIVER=yes`&
38871 .endd
38872 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38873 code is not to be included in the binary by default, comment this line out. You
38874 should also add any relevant comments about the driver or lookup type.
38875 .next
38876 Add to &_src/config.h.defaults_& the line:
38877 .code
38878 #define <type>_NEWDRIVER
38879 .endd
38880 .next
38881 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38882 and create a table entry as is done for all the other drivers and lookup types.
38883 .next
38884 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38885 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38886 Add your &`NEWDRIVER`& to that list.
38887 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38888 simple form that most lookups have.
38889 .next
38890 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38891 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38892 driver or lookup type and add it to the definition of OBJ.
38893 .next
38894 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38895 &_src_&.
38896 .next
38897 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38898 as for other drivers and lookups.
38899 .endlist
38900
38901 Then all you need to do is write the code! A good way to start is to make a
38902 proforma by copying an existing module of the same type, globally changing all
38903 occurrences of the name, and cutting out most of the code. Note that any
38904 options you create must be listed in alphabetical order, because the tables are
38905 searched using a binary chop procedure.
38906
38907 There is a &_README_& file in each of the sub-directories of &_src_& describing
38908 the interface that is expected.
38909
38910
38911
38912
38913 . ////////////////////////////////////////////////////////////////////////////
38914 . ////////////////////////////////////////////////////////////////////////////
38915
38916 . /////////////////////////////////////////////////////////////////////////////
38917 . These lines are processing instructions for the Simple DocBook Processor that
38918 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38919 . PDFs than using xmlto and fop. They will be ignored by all other XML
38920 . processors.
38921 . /////////////////////////////////////////////////////////////////////////////
38922
38923 .literal xml
38924 <?sdop
38925   format="newpage"
38926   foot_right_recto="&chaptertitle;"
38927   foot_right_verso="&chaptertitle;"
38928 ?>
38929 .literal off
38930
38931 .makeindex "Options index"   "option"
38932 .makeindex "Variables index" "variable"
38933 .makeindex "Concept index"   "concept"
38934
38935
38936 . /////////////////////////////////////////////////////////////////////////////
38937 . /////////////////////////////////////////////////////////////////////////////