TLS authenticator
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.85"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2014
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. Exim used to
1989 have a compile option for including A6 record support but this has now been
1990 withdrawn.
1991
1992
1993
1994 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1995 .cindex "lookup modules"
1996 .cindex "dynamic modules"
1997 .cindex ".so building"
1998 On some platforms, Exim supports not compiling all lookup types directly into
1999 the main binary, instead putting some into external modules which can be loaded
2000 on demand.
2001 This permits packagers to build Exim with support for lookups with extensive
2002 library dependencies without requiring all users to install all of those
2003 dependencies.
2004 Most, but not all, lookup types can be built this way.
2005
2006 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2007 installed; Exim will only load modules from that directory, as a security
2008 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2009 for your OS; see &_OS/Makefile-Linux_& for an example.
2010 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2011 see &_src/EDITME_& for details.
2012
2013 Then, for each module to be loaded dynamically, define the relevant
2014 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2015 For example, this will build in lsearch but load sqlite and mysql support
2016 on demand:
2017 .code
2018 LOOKUP_LSEARCH=yes
2019 LOOKUP_SQLITE=2
2020 LOOKUP_MYSQL=2
2021 .endd
2022
2023
2024 .section "The building process" "SECID29"
2025 .cindex "build directory"
2026 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2027 created, run &'make'& at the top level. It determines the architecture and
2028 operating system types, and creates a build directory if one does not exist.
2029 For example, on a Sun system running Solaris 8, the directory
2030 &_build-SunOS5-5.8-sparc_& is created.
2031 .cindex "symbolic link" "to source files"
2032 Symbolic links to relevant source files are installed in the build directory.
2033
2034 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2035 building process fails if it is set.
2036
2037 If this is the first time &'make'& has been run, it calls a script that builds
2038 a make file inside the build directory, using the configuration files from the
2039 &_Local_& directory. The new make file is then passed to another instance of
2040 &'make'&. This does the real work, building a number of utility scripts, and
2041 then compiling and linking the binaries for the Exim monitor (if configured), a
2042 number of utility programs, and finally Exim itself. The command &`make
2043 makefile`& can be used to force a rebuild of the make file in the build
2044 directory, should this ever be necessary.
2045
2046 If you have problems building Exim, check for any comments there may be in the
2047 &_README_& file concerning your operating system, and also take a look at the
2048 FAQ, where some common problems are covered.
2049
2050
2051
2052 .section 'Output from &"make"&' "SECID283"
2053 The output produced by the &'make'& process for compile lines is often very
2054 unreadable, because these lines can be very long. For this reason, the normal
2055 output is suppressed by default, and instead output similar to that which
2056 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2057 each module that is being compiled or linked. However, it is still possible to
2058 get the full output, by calling &'make'& like this:
2059 .code
2060 FULLECHO='' make -e
2061 .endd
2062 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2063 command reflection in &'make'&. When you ask for the full output, it is
2064 given in addition to the short output.
2065
2066
2067
2068 .section "Overriding build-time options for Exim" "SECToverride"
2069 .cindex "build-time options, overriding"
2070 The main make file that is created at the beginning of the building process
2071 consists of the concatenation of a number of files which set configuration
2072 values, followed by a fixed set of &'make'& instructions. If a value is set
2073 more than once, the last setting overrides any previous ones. This provides a
2074 convenient way of overriding defaults. The files that are concatenated are, in
2075 order:
2076 .display
2077 &_OS/Makefile-Default_&
2078 &_OS/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile_&
2080 &_Local/Makefile-_&<&'ostype'&>
2081 &_Local/Makefile-_&<&'archtype'&>
2082 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2083 &_OS/Makefile-Base_&
2084 .endd
2085 .cindex "&_Local/Makefile_&"
2086 .cindex "building Exim" "operating system type"
2087 .cindex "building Exim" "architecture type"
2088 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2089 architecture type. &_Local/Makefile_& is required to exist, and the building
2090 process fails if it is absent. The other three &_Local_& files are optional,
2091 and are often not needed.
2092
2093 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2094 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2095 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2096 values are used, thereby providing a means of forcing particular settings.
2097 Otherwise, the scripts try to get values from the &%uname%& command. If this
2098 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2099 of &'ad hoc'& transformations are then applied, to produce the standard names
2100 that Exim expects. You can run these scripts directly from the shell in order
2101 to find out what values are being used on your system.
2102
2103
2104 &_OS/Makefile-Default_& contains comments about the variables that are set
2105 therein. Some (but not all) are mentioned below. If there is something that
2106 needs changing, review the contents of this file and the contents of the make
2107 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2108 default values are.
2109
2110
2111 .cindex "building Exim" "overriding default settings"
2112 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2113 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2114 need to change the original files. Instead, you should make the changes by
2115 putting the new values in an appropriate &_Local_& file. For example,
2116 .cindex "Tru64-Unix build-time settings"
2117 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2118 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2119 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2120 called with the option &%-std1%&, to make it recognize some of the features of
2121 Standard C that Exim uses. (Most other compilers recognize Standard C by
2122 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2123 containing the lines
2124 .code
2125 CC=cc
2126 CFLAGS=-std1
2127 .endd
2128 If you are compiling for just one operating system, it may be easier to put
2129 these lines directly into &_Local/Makefile_&.
2130
2131 Keeping all your local configuration settings separate from the distributed
2132 files makes it easy to transfer them to new versions of Exim simply by copying
2133 the contents of the &_Local_& directory.
2134
2135
2136 .cindex "NIS lookup type" "including support for"
2137 .cindex "NIS+ lookup type" "including support for"
2138 .cindex "LDAP" "including support for"
2139 .cindex "lookup" "inclusion in binary"
2140 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2141 lookup, but not all systems have these components installed, so the default is
2142 not to include the relevant code in the binary. All the different kinds of file
2143 and database lookup that Exim supports are implemented as separate code modules
2144 which are included only if the relevant compile-time options are set. In the
2145 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2146 .code
2147 LOOKUP_LDAP=yes
2148 LOOKUP_NIS=yes
2149 LOOKUP_NISPLUS=yes
2150 .endd
2151 and similar settings apply to the other lookup types. They are all listed in
2152 &_src/EDITME_&. In many cases the relevant include files and interface
2153 libraries need to be installed before compiling Exim.
2154 .cindex "cdb" "including support for"
2155 However, there are some optional lookup types (such as cdb) for which
2156 the code is entirely contained within Exim, and no external include
2157 files or libraries are required. When a lookup type is not included in the
2158 binary, attempts to configure Exim to use it cause run time configuration
2159 errors.
2160
2161 .cindex "pkg-config" "lookups"
2162 .cindex "pkg-config" "authenticators"
2163 Many systems now use a tool called &'pkg-config'& to encapsulate information
2164 about how to compile against a library; Exim has some initial support for
2165 being able to use pkg-config for lookups and authenticators.  For any given
2166 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2167 variable with the &`_PC`& suffix in the name and assign as the value the
2168 name of the package to be queried.  The results of querying via the
2169 &'pkg-config'& command will be added to the appropriate Makefile variables
2170 with &`+=`& directives, so your version of &'make'& will need to support that
2171 syntax.  For instance:
2172 .code
2173 LOOKUP_SQLITE=yes
2174 LOOKUP_SQLITE_PC=sqlite3
2175 AUTH_GSASL=yes
2176 AUTH_GSASL_PC=libgsasl
2177 AUTH_HEIMDAL_GSSAPI=yes
2178 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2179 .endd
2180
2181 .cindex "Perl" "including support for"
2182 Exim can be linked with an embedded Perl interpreter, allowing Perl
2183 subroutines to be called during string expansion. To enable this facility,
2184 .code
2185 EXIM_PERL=perl.o
2186 .endd
2187 must be defined in &_Local/Makefile_&. Details of this facility are given in
2188 chapter &<<CHAPperl>>&.
2189
2190 .cindex "X11 libraries, location of"
2191 The location of the X11 libraries is something that varies a lot between
2192 operating systems, and there may be different versions of X11 to cope
2193 with. Exim itself makes no use of X11, but if you are compiling the Exim
2194 monitor, the X11 libraries must be available.
2195 The following three variables are set in &_OS/Makefile-Default_&:
2196 .code
2197 X11=/usr/X11R6
2198 XINCLUDE=-I$(X11)/include
2199 XLFLAGS=-L$(X11)/lib
2200 .endd
2201 These are overridden in some of the operating-system configuration files. For
2202 example, in &_OS/Makefile-SunOS5_& there is
2203 .code
2204 X11=/usr/openwin
2205 XINCLUDE=-I$(X11)/include
2206 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2207 .endd
2208 If you need to override the default setting for your operating system, place a
2209 definition of all three of these variables into your
2210 &_Local/Makefile-<ostype>_& file.
2211
2212 .cindex "EXTRALIBS"
2213 If you need to add any extra libraries to the link steps, these can be put in a
2214 variable called EXTRALIBS, which appears in all the link commands, but by
2215 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2216 command for linking the main Exim binary, and not for any associated utilities.
2217
2218 .cindex "DBM libraries" "configuration for building"
2219 There is also DBMLIB, which appears in the link commands for binaries that
2220 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2221 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2222 binary, and which can be used, for example, to include additional X11
2223 libraries.
2224
2225 .cindex "configuration file" "editing"
2226 The make file copes with rebuilding Exim correctly if any of the configuration
2227 files are edited. However, if an optional configuration file is deleted, it is
2228 necessary to touch the associated non-optional file (that is,
2229 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2230
2231
2232 .section "OS-specific header files" "SECID30"
2233 .cindex "&_os.h_&"
2234 .cindex "building Exim" "OS-specific C header files"
2235 The &_OS_& directory contains a number of files with names of the form
2236 &_os.h-<ostype>_&. These are system-specific C header files that should not
2237 normally need to be changed. There is a list of macro settings that are
2238 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2239 are porting Exim to a new operating system.
2240
2241
2242
2243 .section "Overriding build-time options for the monitor" "SECID31"
2244 .cindex "building Eximon"
2245 A similar process is used for overriding things when building the Exim monitor,
2246 where the files that are involved are
2247 .display
2248 &_OS/eximon.conf-Default_&
2249 &_OS/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf_&
2251 &_Local/eximon.conf-_&<&'ostype'&>
2252 &_Local/eximon.conf-_&<&'archtype'&>
2253 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2254 .endd
2255 .cindex "&_Local/eximon.conf_&"
2256 As with Exim itself, the final three files need not exist, and in this case the
2257 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2258 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2259 variables of the same name, preceded by EXIMON_. For example, setting
2260 EXIMON_LOG_DEPTH in the environment overrides the value of
2261 LOG_DEPTH at run time.
2262 .ecindex IIDbuex
2263
2264
2265 .section "Installing Exim binaries and scripts" "SECID32"
2266 .cindex "installing Exim"
2267 .cindex "BIN_DIRECTORY"
2268 The command &`make install`& runs the &(exim_install)& script with no
2269 arguments. The script copies binaries and utility scripts into the directory
2270 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2271 .cindex "setuid" "installing Exim with"
2272 The install script copies files only if they are newer than the files they are
2273 going to replace. The Exim binary is required to be owned by root and have the
2274 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2275 install`& as root so that it can set up the Exim binary in this way. However, in
2276 some special situations (for example, if a host is doing no local deliveries)
2277 it may be possible to run Exim without making the binary setuid root (see
2278 chapter &<<CHAPsecurity>>& for details).
2279
2280 .cindex "CONFIGURE_FILE"
2281 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2282 in &_Local/Makefile_&. If this names a single file, and the file does not
2283 exist, the default configuration file &_src/configure.default_& is copied there
2284 by the installation script. If a run time configuration file already exists, it
2285 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2286 alternative files, no default is installed.
2287
2288 .cindex "system aliases file"
2289 .cindex "&_/etc/aliases_&"
2290 One change is made to the default configuration file when it is installed: the
2291 default configuration contains a router that references a system aliases file.
2292 The path to this file is set to the value specified by
2293 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2294 If the system aliases file does not exist, the installation script creates it,
2295 and outputs a comment to the user.
2296
2297 The created file contains no aliases, but it does contain comments about the
2298 aliases a site should normally have. Mail aliases have traditionally been
2299 kept in &_/etc/aliases_&. However, some operating systems are now using
2300 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2301 Exim's configuration if necessary.
2302
2303 The default configuration uses the local host's name as the only local domain,
2304 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2305 running as the local user. System aliases and &_.forward_& files in users' home
2306 directories are supported, but no NIS or NIS+ support is configured. Domains
2307 other than the name of the local host are routed using the DNS, with delivery
2308 over SMTP.
2309
2310 It is possible to install Exim for special purposes (such as building a binary
2311 distribution) in a private part of the file system. You can do this by a
2312 command such as
2313 .code
2314 make DESTDIR=/some/directory/ install
2315 .endd
2316 This has the effect of pre-pending the specified directory to all the file
2317 paths, except the name of the system aliases file that appears in the default
2318 configuration. (If a default alias file is created, its name &'is'& modified.)
2319 For backwards compatibility, ROOT is used if DESTDIR is not set,
2320 but this usage is deprecated.
2321
2322 .cindex "installing Exim" "what is not installed"
2323 Running &'make install'& does not copy the Exim 4 conversion script
2324 &'convert4r4'&. You will probably run this only once if you are
2325 upgrading from Exim 3. None of the documentation files in the &_doc_&
2326 directory are copied, except for the info files when you have set
2327 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2328
2329 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2330 to their names. The Exim binary itself, however, is handled differently. It is
2331 installed under a name that includes the version number and the compile number,
2332 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2333 called &_exim_& to point to the binary. If you are updating a previous version
2334 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2335 from the directory (as seen by other processes).
2336
2337 .cindex "installing Exim" "testing the script"
2338 If you want to see what the &'make install'& will do before running it for
2339 real, you can pass the &%-n%& option to the installation script by this
2340 command:
2341 .code
2342 make INSTALL_ARG=-n install
2343 .endd
2344 The contents of the variable INSTALL_ARG are passed to the installation
2345 script. You do not need to be root to run this test. Alternatively, you can run
2346 the installation script directly, but this must be from within the build
2347 directory. For example, from the top-level Exim directory you could use this
2348 command:
2349 .code
2350 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2351 .endd
2352 .cindex "installing Exim" "install script options"
2353 There are two other options that can be supplied to the installation script.
2354
2355 .ilist
2356 &%-no_chown%& bypasses the call to change the owner of the installed binary
2357 to root, and the call to make it a setuid binary.
2358 .next
2359 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2360 installed binary.
2361 .endlist
2362
2363 INSTALL_ARG can be used to pass these options to the script. For example:
2364 .code
2365 make INSTALL_ARG=-no_symlink install
2366 .endd
2367 The installation script can also be given arguments specifying which files are
2368 to be copied. For example, to install just the Exim binary, and nothing else,
2369 without creating the symbolic link, you could use:
2370 .code
2371 make INSTALL_ARG='-no_symlink exim' install
2372 .endd
2373
2374
2375
2376 .section "Installing info documentation" "SECTinsinfdoc"
2377 .cindex "installing Exim" "&'info'& documentation"
2378 Not all systems use the GNU &'info'& system for documentation, and for this
2379 reason, the Texinfo source of Exim's documentation is not included in the main
2380 distribution. Instead it is available separately from the ftp site (see section
2381 &<<SECTavail>>&).
2382
2383 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2384 source of the documentation is found in the source tree, running &`make
2385 install`& automatically builds the info files and installs them.
2386
2387
2388
2389 .section "Setting up the spool directory" "SECID33"
2390 .cindex "spool directory" "creating"
2391 When it starts up, Exim tries to create its spool directory if it does not
2392 exist. The Exim uid and gid are used for the owner and group of the spool
2393 directory. Sub-directories are automatically created in the spool directory as
2394 necessary.
2395
2396
2397
2398
2399 .section "Testing" "SECID34"
2400 .cindex "testing" "installation"
2401 Having installed Exim, you can check that the run time configuration file is
2402 syntactically valid by running the following command, which assumes that the
2403 Exim binary directory is within your PATH environment variable:
2404 .code
2405 exim -bV
2406 .endd
2407 If there are any errors in the configuration file, Exim outputs error messages.
2408 Otherwise it outputs the version number and build date,
2409 the DBM library that is being used, and information about which drivers and
2410 other optional code modules are included in the binary.
2411 Some simple routing tests can be done by using the address testing option. For
2412 example,
2413 .display
2414 &`exim -bt`& <&'local username'&>
2415 .endd
2416 should verify that it recognizes a local mailbox, and
2417 .display
2418 &`exim -bt`& <&'remote address'&>
2419 .endd
2420 a remote one. Then try getting it to deliver mail, both locally and remotely.
2421 This can be done by passing messages directly to Exim, without going through a
2422 user agent. For example:
2423 .code
2424 exim -v postmaster@your.domain.example
2425 From: user@your.domain.example
2426 To: postmaster@your.domain.example
2427 Subject: Testing Exim
2428
2429 This is a test message.
2430 ^D
2431 .endd
2432 The &%-v%& option causes Exim to output some verification of what it is doing.
2433 In this case you should see copies of three log lines, one for the message's
2434 arrival, one for its delivery, and one containing &"Completed"&.
2435
2436 .cindex "delivery" "problems with"
2437 If you encounter problems, look at Exim's log files (&'mainlog'& and
2438 &'paniclog'&) to see if there is any relevant information there. Another source
2439 of information is running Exim with debugging turned on, by specifying the
2440 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2441 with debugging turned on by a command of the form
2442 .display
2443 &`exim -d -M`& <&'exim-message-id'&>
2444 .endd
2445 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2446 produces rather a lot of output, but you can cut this down to specific areas.
2447 For example, if you use &%-d-all+route%& only the debugging information
2448 relevant to routing is included. (See the &%-d%& option in chapter
2449 &<<CHAPcommandline>>& for more details.)
2450
2451 .cindex '&"sticky"& bit'
2452 .cindex "lock files"
2453 One specific problem that has shown up on some sites is the inability to do
2454 local deliveries into a shared mailbox directory, because it does not have the
2455 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2456 writing to a mailbox file, and if it cannot create the lock file, the delivery
2457 is deferred. You can get round this either by setting the &"sticky bit"& on the
2458 directory, or by setting a specific group for local deliveries and allowing
2459 that group to create files in the directory (see the comments above the
2460 &(local_delivery)& transport in the default configuration file). Another
2461 approach is to configure Exim not to use lock files, but just to rely on
2462 &[fcntl()]& locking instead. However, you should do this only if all user
2463 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2464 see chapter &<<CHAPappendfile>>&.
2465
2466 One thing that cannot be tested on a system that is already running an MTA is
2467 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2468 &%-oX%& option can be used to run an Exim daemon that listens on some other
2469 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2470 &'exim_checkaccess'& utility can be used to check out policy controls on
2471 incoming SMTP mail.
2472
2473 Testing a new version on a system that is already running Exim can most easily
2474 be done by building a binary with a different CONFIGURE_FILE setting. From
2475 within the run time configuration, all other file and directory names
2476 that Exim uses can be altered, in order to keep it entirely clear of the
2477 production version.
2478
2479
2480 .section "Replacing another MTA with Exim" "SECID35"
2481 .cindex "replacing another MTA"
2482 Building and installing Exim for the first time does not of itself put it in
2483 general use. The name by which the system's MTA is called by mail user agents
2484 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2485 operating system), and it is necessary to make this name point to the &'exim'&
2486 binary in order to get the user agents to pass messages to Exim. This is
2487 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2488 or &_/usr/lib/sendmail_&
2489 .cindex "symbolic link" "to &'exim'& binary"
2490 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2491 privilege and executable status from the old MTA. It is then necessary to stop
2492 and restart the mailer daemon, if one is running.
2493
2494 .cindex "FreeBSD, MTA indirection"
2495 .cindex "&_/etc/mail/mailer.conf_&"
2496 Some operating systems have introduced alternative ways of switching MTAs. For
2497 example, if you are running FreeBSD, you need to edit the file
2498 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2499 described. A typical example of the contents of this file for running Exim is
2500 as follows:
2501 .code
2502 sendmail            /usr/exim/bin/exim
2503 send-mail           /usr/exim/bin/exim
2504 mailq               /usr/exim/bin/exim -bp
2505 newaliases          /usr/bin/true
2506 .endd
2507 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2508 your Exim installation is &"live"&. Check it by sending a message from your
2509 favourite user agent.
2510
2511 You should consider what to tell your users about the change of MTA. Exim may
2512 have different capabilities to what was previously running, and there are
2513 various operational differences such as the text of messages produced by
2514 command line options and in bounce messages. If you allow your users to make
2515 use of Exim's filtering capabilities, you should make the document entitled
2516 &'Exim's interface to mail filtering'& available to them.
2517
2518
2519
2520 .section "Upgrading Exim" "SECID36"
2521 .cindex "upgrading Exim"
2522 If you are already running Exim on your host, building and installing a new
2523 version automatically makes it available to MUAs, or any other programs that
2524 call the MTA directly. However, if you are running an Exim daemon, you do need
2525 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2526 new binary. You do not need to stop processing mail in order to install a new
2527 version of Exim. The install script does not modify an existing runtime
2528 configuration file.
2529
2530
2531
2532
2533 .section "Stopping the Exim daemon on Solaris" "SECID37"
2534 .cindex "Solaris" "stopping Exim on"
2535 The standard command for stopping the mailer daemon on Solaris is
2536 .code
2537 /etc/init.d/sendmail stop
2538 .endd
2539 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2540 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2541 for the text &"sendmail"&; this is not present because the actual program name
2542 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2543 solution is to replace the line that finds the process id with something like
2544 .code
2545 pid=`cat /var/spool/exim/exim-daemon.pid`
2546 .endd
2547 to obtain the daemon's pid directly from the file that Exim saves it in.
2548
2549 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2550 still be received from local processes, and if automatic delivery is configured
2551 (the normal case), deliveries will still occur.
2552
2553
2554
2555
2556 . ////////////////////////////////////////////////////////////////////////////
2557 . ////////////////////////////////////////////////////////////////////////////
2558
2559 .chapter "The Exim command line" "CHAPcommandline"
2560 .scindex IIDclo1 "command line" "options"
2561 .scindex IIDclo2 "options" "command line"
2562 Exim's command line takes the standard Unix form of a sequence of options,
2563 each starting with a hyphen character, followed by a number of arguments. The
2564 options are compatible with the main options of Sendmail, and there are also
2565 some additional options, some of which are compatible with Smail 3. Certain
2566 combinations of options do not make sense, and provoke an error if used.
2567 The form of the arguments depends on which options are set.
2568
2569
2570 .section "Setting options by program name" "SECID38"
2571 .cindex "&'mailq'&"
2572 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2573 were present before any other options.
2574 The &%-bp%& option requests a listing of the contents of the mail queue on the
2575 standard output.
2576 This feature is for compatibility with some systems that contain a command of
2577 that name in one of the standard libraries, symbolically linked to
2578 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2579
2580 .cindex "&'rsmtp'&"
2581 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2582 were present before any other options, for compatibility with Smail. The
2583 &%-bS%& option is used for reading in a number of messages in batched SMTP
2584 format.
2585
2586 .cindex "&'rmail'&"
2587 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2588 &%-oee%& options were present before any other options, for compatibility with
2589 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2590
2591 .cindex "&'runq'&"
2592 .cindex "queue runner"
2593 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2594 were present before any other options, for compatibility with Smail. The &%-q%&
2595 option causes a single queue runner process to be started.
2596
2597 .cindex "&'newaliases'&"
2598 .cindex "alias file" "building"
2599 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2600 If Exim is called under the name &'newaliases'& it behaves as if the option
2601 &%-bi%& were present before any other options, for compatibility with Sendmail.
2602 This option is used for rebuilding Sendmail's alias file. Exim does not have
2603 the concept of a single alias file, but can be configured to run a given
2604 command if called with the &%-bi%& option.
2605
2606
2607 .section "Trusted and admin users" "SECTtrustedadmin"
2608 Some Exim options are available only to &'trusted users'& and others are
2609 available only to &'admin users'&. In the description below, the phrases &"Exim
2610 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2611 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2612 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2613
2614 .ilist
2615 .cindex "trusted users" "definition of"
2616 .cindex "user" "trusted definition of"
2617 The trusted users are root, the Exim user, any user listed in the
2618 &%trusted_users%& configuration option, and any user whose current group or any
2619 supplementary group is one of those listed in the &%trusted_groups%&
2620 configuration option. Note that the Exim group is not automatically trusted.
2621
2622 .cindex '&"From"& line'
2623 .cindex "envelope sender"
2624 Trusted users are always permitted to use the &%-f%& option or a leading
2625 &"From&~"& line to specify the envelope sender of a message that is passed to
2626 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2627 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2628 users to set envelope senders.
2629
2630 .cindex "&'From:'& header line"
2631 .cindex "&'Sender:'& header line"
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 &$sender_domain$&) 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,
3055 using the malware scanning framework.  The option of &%av_scanner%& influences
3056 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3057 the expansion should have defaults which apply to this invocation.  ACLs are
3058 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3059 will never be populated and &%-bmalware%& will fail.
3060
3061 Exim will have changed working directory before resolving the filename, so
3062 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3063 user when it tries to open the file, rather than as the invoking user.
3064 This option requires admin privileges.
3065
3066 The &%-bmalware%& option will not be extended to be more generally useful,
3067 there are better tools for file-scanning.  This option exists to help
3068 administrators verify their Exim and AV scanner configuration.
3069
3070 .vitem &%-bnq%&
3071 .oindex "&%-bnq%&"
3072 .cindex "address qualification, suppressing"
3073 By default, Exim automatically qualifies unqualified addresses (those
3074 without domains) that appear in messages that are submitted locally (that
3075 is, not over TCP/IP). This qualification applies both to addresses in
3076 envelopes, and addresses in header lines. Sender addresses are qualified using
3077 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3078 defaults to the value of &%qualify_domain%&).
3079
3080 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3081 being used to re-submit messages that originally came from remote hosts after
3082 content scanning, you probably do not want to qualify unqualified addresses in
3083 header lines. (Such lines will be present only if you have not enabled a header
3084 syntax check in the appropriate ACL.)
3085
3086 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3087 messages that originate on the local host. When this is used, unqualified
3088 addresses in the envelope provoke errors (causing message rejection) and
3089 unqualified addresses in header lines are left alone.
3090
3091
3092 .vitem &%-bP%&
3093 .oindex "&%-bP%&"
3094 .cindex "configuration options" "extracting"
3095 .cindex "options" "configuration &-- extracting"
3096 If this option is given with no arguments, it causes the values of all Exim's
3097 main configuration options to be written to the standard output. The values
3098 of one or more specific options can be requested by giving their names as
3099 arguments, for example:
3100 .code
3101 exim -bP qualify_domain hold_domains
3102 .endd
3103 .cindex "hiding configuration option values"
3104 .cindex "configuration options" "hiding value of"
3105 .cindex "options" "hiding value of"
3106 However, any option setting that is preceded by the word &"hide"& in the
3107 configuration file is not shown in full, except to an admin user. For other
3108 users, the output is as in this example:
3109 .code
3110 mysql_servers = <value not displayable>
3111 .endd
3112 If &%configure_file%& is given as an argument, the name of the run time
3113 configuration file is output.
3114 If a list of configuration files was supplied, the value that is output here
3115 is the name of the file that was actually used.
3116
3117 .cindex "options" "hiding name of"
3118 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3119 name will not be output.
3120
3121 .cindex "daemon" "process id (pid)"
3122 .cindex "pid (process id)" "of daemon"
3123 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3124 directories where log files and daemon pid files are written are output,
3125 respectively. If these values are unset, log files are written in a
3126 sub-directory of the spool directory called &%log%&, and the pid file is
3127 written directly into the spool directory.
3128
3129 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3130 .code
3131 exim -bP +local_domains
3132 .endd
3133 it searches for a matching named list of any type (domain, host, address, or
3134 local part) and outputs what it finds.
3135
3136 .cindex "options" "router &-- extracting"
3137 .cindex "options" "transport &-- extracting"
3138 .cindex "options" "authenticator &-- extracting"
3139 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3140 followed by the name of an appropriate driver instance, the option settings for
3141 that driver are output. For example:
3142 .code
3143 exim -bP transport local_delivery
3144 .endd
3145 The generic driver options are output first, followed by the driver's private
3146 options. A list of the names of drivers of a particular type can be obtained by
3147 using one of the words &%router_list%&, &%transport_list%&, or
3148 &%authenticator_list%&, and a complete list of all drivers with their option
3149 settings can be obtained by using &%routers%&, &%transports%&, or
3150 &%authenticators%&.
3151
3152 .cindex "options" "macro &-- extracting"
3153 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3154 are available, similarly to the drivers.  Because macros are sometimes used
3155 for storing passwords, this option is restricted.
3156 The output format is one item per line.
3157
3158 .vitem &%-bp%&
3159 .oindex "&%-bp%&"
3160 .cindex "queue" "listing messages on"
3161 .cindex "listing" "messages on the queue"
3162 This option requests a listing of the contents of the mail queue on the
3163 standard output. If the &%-bp%& option is followed by a list of message ids,
3164 just those messages are listed. By default, this option can be used only by an
3165 admin user. However, the &%queue_list_requires_admin%& option can be set false
3166 to allow any user to see the queue.
3167
3168 Each message on the queue is displayed as in the following example:
3169 .code
3170 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3171           red.king@looking-glass.fict.example
3172           <other addresses>
3173 .endd
3174 .cindex "message" "size in queue listing"
3175 .cindex "size" "of message"
3176 The first line contains the length of time the message has been on the queue
3177 (in this case 25 minutes), the size of the message (2.9K), the unique local
3178 identifier for the message, and the message sender, as contained in the
3179 envelope. For bounce messages, the sender address is empty, and appears as
3180 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3181 the default sender address, the user's login name is shown in parentheses
3182 before the sender address.
3183
3184 .cindex "frozen messages" "in queue listing"
3185 If the message is frozen (attempts to deliver it are suspended) then the text
3186 &"*** frozen ***"& is displayed at the end of this line.
3187
3188 The recipients of the message (taken from the envelope, not the headers) are
3189 displayed on subsequent lines. Those addresses to which the message has already
3190 been delivered are marked with the letter D. If an original address gets
3191 expanded into several addresses via an alias or forward file, the original is
3192 displayed with a D only when deliveries for all of its child addresses are
3193 complete.
3194
3195
3196 .vitem &%-bpa%&
3197 .oindex "&%-bpa%&"
3198 This option operates like &%-bp%&, but in addition it shows delivered addresses
3199 that were generated from the original top level address(es) in each message by
3200 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3201 of just &"D"&.
3202
3203
3204 .vitem &%-bpc%&
3205 .oindex "&%-bpc%&"
3206 .cindex "queue" "count of messages on"
3207 This option counts the number of messages on the queue, and writes the total
3208 to the standard output. It is restricted to admin users, unless
3209 &%queue_list_requires_admin%& is set false.
3210
3211
3212 .vitem &%-bpr%&
3213 .oindex "&%-bpr%&"
3214 This option operates like &%-bp%&, but the output is not sorted into
3215 chronological order of message arrival. This can speed it up when there are
3216 lots of messages on the queue, and is particularly useful if the output is
3217 going to be post-processed in a way that doesn't need the sorting.
3218
3219 .vitem &%-bpra%&
3220 .oindex "&%-bpra%&"
3221 This option is a combination of &%-bpr%& and &%-bpa%&.
3222
3223 .vitem &%-bpru%&
3224 .oindex "&%-bpru%&"
3225 This option is a combination of &%-bpr%& and &%-bpu%&.
3226
3227
3228 .vitem &%-bpu%&
3229 .oindex "&%-bpu%&"
3230 This option operates like &%-bp%& but shows only undelivered top-level
3231 addresses for each message displayed. Addresses generated by aliasing or
3232 forwarding are not shown, unless the message was deferred after processing by a
3233 router with the &%one_time%& option set.
3234
3235
3236 .vitem &%-brt%&
3237 .oindex "&%-brt%&"
3238 .cindex "testing" "retry configuration"
3239 .cindex "retry" "configuration testing"
3240 This option is for testing retry rules, and it must be followed by up to three
3241 arguments. It causes Exim to look for a retry rule that matches the values
3242 and to write it to the standard output. For example:
3243 .code
3244 exim -brt bach.comp.mus.example
3245 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3246 .endd
3247 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3248 argument, which is required, can be a complete address in the form
3249 &'local_part@domain'&, or it can be just a domain name. If the second argument
3250 contains a dot, it is interpreted as an optional second domain name; if no
3251 retry rule is found for the first argument, the second is tried. This ties in
3252 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3253 rule is found that matches the host, one that matches the mail domain is
3254 sought. Finally, an argument that is the name of a specific delivery error, as
3255 used in setting up retry rules, can be given. For example:
3256 .code
3257 exim -brt haydn.comp.mus.example quota_3d
3258 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3259 .endd
3260
3261 .vitem &%-brw%&
3262 .oindex "&%-brw%&"
3263 .cindex "testing" "rewriting"
3264 .cindex "rewriting" "testing"
3265 This option is for testing address rewriting rules, and it must be followed by
3266 a single argument, consisting of either a local part without a domain, or a
3267 complete address with a fully qualified domain. Exim outputs how this address
3268 would be rewritten for each possible place it might appear. See chapter
3269 &<<CHAPrewrite>>& for further details.
3270
3271 .vitem &%-bS%&
3272 .oindex "&%-bS%&"
3273 .cindex "SMTP" "batched incoming"
3274 .cindex "batched SMTP input"
3275 This option is used for batched SMTP input, which is an alternative interface
3276 for non-interactive local message submission. A number of messages can be
3277 submitted in a single run. However, despite its name, this is not really SMTP
3278 input. Exim reads each message's envelope from SMTP commands on the standard
3279 input, but generates no responses. If the caller is trusted, or
3280 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3281 believed; otherwise the sender is always the caller of Exim.
3282
3283 The message itself is read from the standard input, in SMTP format (leading
3284 dots doubled), terminated by a line containing just a single dot. An error is
3285 provoked if the terminating dot is missing. A further message may then follow.
3286
3287 As for other local message submissions, the contents of incoming batch SMTP
3288 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3289 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3290 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3291
3292 Some other SMTP commands are recognized in the input. HELO and EHLO act
3293 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3294 QUIT quits, ignoring the rest of the standard input.
3295
3296 .cindex "return code" "for &%-bS%&"
3297 If any error is encountered, reports are written to the standard output and
3298 error streams, and Exim gives up immediately. The return code is 0 if no error
3299 was detected; it is 1 if one or more messages were accepted before the error
3300 was detected; otherwise it is 2.
3301
3302 More details of input using batched SMTP are given in section
3303 &<<SECTincomingbatchedSMTP>>&.
3304
3305 .vitem &%-bs%&
3306 .oindex "&%-bs%&"
3307 .cindex "SMTP" "local input"
3308 .cindex "local SMTP input"
3309 This option causes Exim to accept one or more messages by reading SMTP commands
3310 on the standard input, and producing SMTP replies on the standard output. SMTP
3311 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3312 Some user agents use this interface as a way of passing locally-generated
3313 messages to the MTA.
3314
3315 In
3316 .cindex "sender" "source of"
3317 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3318 set, the senders of messages are taken from the SMTP MAIL commands.
3319 Otherwise the content of these commands is ignored and the sender is set up as
3320 the calling user. Unqualified addresses are automatically qualified using
3321 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3322 &%-bnq%& option is used.
3323
3324 .cindex "inetd"
3325 The
3326 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3327 using a listening daemon. Exim can distinguish the two cases by checking
3328 whether the standard input is a TCP/IP socket. When Exim is called from
3329 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3330 above concerning senders and qualification do not apply. In this situation,
3331 Exim behaves in exactly the same way as it does when receiving a message via
3332 the listening daemon.
3333
3334 .vitem &%-bt%&
3335 .oindex "&%-bt%&"
3336 .cindex "testing" "addresses"
3337 .cindex "address" "testing"
3338 This option runs Exim in address testing mode, in which each argument is taken
3339 as a recipient address to be tested for deliverability. The results are
3340 written to the standard output. If a test fails, and the caller is not an admin
3341 user, no details of the failure are output, because these might contain
3342 sensitive information such as usernames and passwords for database lookups.
3343
3344 If no arguments are given, Exim runs in an interactive manner, prompting with a
3345 right angle bracket for addresses to be tested.
3346
3347 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3348 &[readline()]& function, because it is running as &'root'& and there are
3349 security issues.
3350
3351 Each address is handled as if it were the recipient address of a message
3352 (compare the &%-bv%& option). It is passed to the routers and the result is
3353 written to the standard output. However, any router that has
3354 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3355 genuine routing tests if your first router passes everything to a scanner
3356 program.
3357
3358 .cindex "return code" "for &%-bt%&"
3359 The return code is 2 if any address failed outright; it is 1 if no address
3360 failed outright but at least one could not be resolved for some reason. Return
3361 code 0 is given only when all addresses succeed.
3362
3363 .cindex "duplicate addresses"
3364 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3365 addresses after routing is complete, so that only one delivery takes place.
3366 This does not happen when testing with &%-bt%&; the full results of routing are
3367 always shown.
3368
3369 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3370 routers in the configuration makes any tests on the sender address of a
3371 message,
3372 .oindex "&%-f%&" "for address testing"
3373 you can use the &%-f%& option to set an appropriate sender when running
3374 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3375 default qualifying domain. However, if you have set up (for example) routers
3376 whose behaviour depends on the contents of an incoming message, you cannot test
3377 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3378 doing such tests.
3379
3380 .vitem &%-bV%&
3381 .oindex "&%-bV%&"
3382 .cindex "version number of Exim"
3383 This option causes Exim to write the current version number, compilation
3384 number, and compilation date of the &'exim'& binary to the standard output.
3385 It also lists the DBM library that is being used, the optional modules (such as
3386 specific lookup types), the drivers that are included in the binary, and the
3387 name of the run time configuration file that is in use.
3388
3389 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3390 configuration file. However, this is a static check only. It cannot check
3391 values that are to be expanded. For example, although a misspelt ACL verb is
3392 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3393 alone to discover (for example) all the typos in the configuration; some
3394 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3395 dynamic testing facilities.
3396
3397 .vitem &%-bv%&
3398 .oindex "&%-bv%&"
3399 .cindex "verifying address" "using &%-bv%&"
3400 .cindex "address" "verification"
3401 This option runs Exim in address verification mode, in which each argument is
3402 taken as a recipient address to be verified by the routers. (This does
3403 not involve any verification callouts). During normal operation, verification
3404 happens mostly as a consequence processing a &%verify%& condition in an ACL
3405 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3406 including callouts, see the &%-bh%& and &%-bhc%& options.
3407
3408 If verification fails, and the caller is not an admin user, no details of the
3409 failure are output, because these might contain sensitive information such as
3410 usernames and passwords for database lookups.
3411
3412 If no arguments are given, Exim runs in an interactive manner, prompting with a
3413 right angle bracket for addresses to be verified.
3414
3415 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3416 &[readline()]& function, because it is running as &'exim'& and there are
3417 security issues.
3418
3419 Verification differs from address testing (the &%-bt%& option) in that routers
3420 that have &%no_verify%& set are skipped, and if the address is accepted by a
3421 router that has &%fail_verify%& set, verification fails. The address is
3422 verified as a recipient if &%-bv%& is used; to test verification for a sender
3423 address, &%-bvs%& should be used.
3424
3425 If the &%-v%& option is not set, the output consists of a single line for each
3426 address, stating whether it was verified or not, and giving a reason in the
3427 latter case. Without &%-v%&, generating more than one address by redirection
3428 causes verification to end successfully, without considering the generated
3429 addresses. However, if just one address is generated, processing continues,
3430 and the generated address must verify successfully for the overall verification
3431 to succeed.
3432
3433 When &%-v%& is set, more details are given of how the address has been handled,
3434 and in the case of address redirection, all the generated addresses are also
3435 considered. Verification may succeed for some and fail for others.
3436
3437 The
3438 .cindex "return code" "for &%-bv%&"
3439 return code is 2 if any address failed outright; it is 1 if no address
3440 failed outright but at least one could not be resolved for some reason. Return
3441 code 0 is given only when all addresses succeed.
3442
3443 If any of the routers in the configuration makes any tests on the sender
3444 address of a message, you should use the &%-f%& option to set an appropriate
3445 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3446 calling user at the default qualifying domain.
3447
3448 .vitem &%-bvs%&
3449 .oindex "&%-bvs%&"
3450 This option acts like &%-bv%&, but verifies the address as a sender rather
3451 than a recipient address. This affects any rewriting and qualification that
3452 might happen.
3453
3454 .vitem &%-bw%&
3455 .oindex "&%-bw%&"
3456 .cindex "daemon"
3457 .cindex "inetd"
3458 .cindex "inetd" "wait mode"
3459 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3460 similarly to the &%-bd%& option.  All port specifications on the command-line
3461 and in the configuration file are ignored.  Queue-running may not be specified.
3462
3463 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3464 listening for connections.  This permits the system to start up and have
3465 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3466 each port only when the first connection is received.
3467
3468 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3469 which the daemon will exit, which should cause inetd to listen once more.
3470
3471 .vitem &%-C%&&~<&'filelist'&>
3472 .oindex "&%-C%&"
3473 .cindex "configuration file" "alternate"
3474 .cindex "CONFIGURE_FILE"
3475 .cindex "alternate configuration file"
3476 This option causes Exim to find the run time configuration file from the given
3477 list instead of from the list specified by the CONFIGURE_FILE
3478 compile-time setting. Usually, the list will consist of just a single file
3479 name, but it can be a colon-separated list of names. In this case, the first
3480 file that exists is used. Failure to open an existing file stops Exim from
3481 proceeding any further along the list, and an error is generated.
3482
3483 When this option is used by a caller other than root, and the list is different
3484 from the compiled-in list, Exim gives up its root privilege immediately, and
3485 runs with the real and effective uid and gid set to those of the caller.
3486 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3487 file contains a list of full pathnames, one per line, for configuration files
3488 which are trusted. Root privilege is retained for any configuration file so
3489 listed, as long as the caller is the Exim user (or the user specified in the
3490 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3491 not writeable by inappropriate users or groups.
3492
3493 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3494 configuration using &%-C%& right through message reception and delivery,
3495 even if the caller is root. The reception works, but by that time, Exim is
3496 running as the Exim user, so when it re-executes to regain privilege for the
3497 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3498 test reception and delivery using two separate commands (one to put a message
3499 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3500
3501 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3502 prefix string with which any file named in a &%-C%& command line option
3503 must start. In addition, the file name must not contain the sequence &`/../`&.
3504 However, if the value of the &%-C%& option is identical to the value of
3505 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3506 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3507 unset, any file name can be used with &%-C%&.
3508
3509 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3510 to a directory to which only root has access. This prevents someone who has
3511 broken into the Exim account from running a privileged Exim with an arbitrary
3512 configuration file.
3513
3514 The &%-C%& facility is useful for ensuring that configuration files are
3515 syntactically correct, but cannot be used for test deliveries, unless the
3516 caller is privileged, or unless it is an exotic configuration that does not
3517 require privilege. No check is made on the owner or group of the files
3518 specified by this option.
3519
3520
3521 .vitem &%-D%&<&'macro'&>=<&'value'&>
3522 .oindex "&%-D%&"
3523 .cindex "macro" "setting on command line"
3524 This option can be used to override macro definitions in the configuration file
3525 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3526 unprivileged caller, it causes Exim to give up its root privilege.
3527 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3528 completely disabled, and its use causes an immediate error exit.
3529
3530 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3531 colon-separated list of macros which are considered safe and, if &%-D%& only
3532 supplies macros from this list, and the values are acceptable, then Exim will
3533 not give up root privilege if the caller is root, the Exim run-time user, or
3534 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3535 to be removed in the future.  Acceptable values for the macros satisfy the
3536 regexp: &`^[A-Za-z0-9_/.-]*$`&
3537
3538 The entire option (including equals sign if present) must all be within one
3539 command line item. &%-D%& can be used to set the value of a macro to the empty
3540 string, in which case the equals sign is optional. These two commands are
3541 synonymous:
3542 .code
3543 exim -DABC  ...
3544 exim -DABC= ...
3545 .endd
3546 To include spaces in a macro definition item, quotes must be used. If you use
3547 quotes, spaces are permitted around the macro name and the equals sign. For
3548 example:
3549 .code
3550 exim '-D ABC = something' ...
3551 .endd
3552 &%-D%& may be repeated up to 10 times on a command line.
3553
3554
3555 .vitem &%-d%&<&'debug&~options'&>
3556 .oindex "&%-d%&"
3557 .cindex "debugging" "list of selectors"
3558 .cindex "debugging" "&%-d%& option"
3559 This option causes debugging information to be written to the standard
3560 error stream. It is restricted to admin users because debugging output may show
3561 database queries that contain password information. Also, the details of users'
3562 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3563 writes an error message to the standard error stream and exits with a non-zero
3564 return code.
3565
3566 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3567 standard debugging data is output. This can be reduced, or increased to include
3568 some more rarely needed information, by directly following &%-d%& with a string
3569 made up of names preceded by plus or minus characters. These add or remove sets
3570 of debugging data, respectively. For example, &%-d+filter%& adds filter
3571 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3572 no spaces are allowed in the debug setting. The available debugging categories
3573 are:
3574 .display
3575 &`acl            `& ACL interpretation
3576 &`auth           `& authenticators
3577 &`deliver        `& general delivery logic
3578 &`dns            `& DNS lookups (see also resolver)
3579 &`dnsbl          `& DNS black list (aka RBL) code
3580 &`exec           `& arguments for &[execv()]& calls
3581 &`expand         `& detailed debugging for string expansions
3582 &`filter         `& filter handling
3583 &`hints_lookup   `& hints data lookups
3584 &`host_lookup    `& all types of name-to-IP address handling
3585 &`ident          `& ident lookup
3586 &`interface      `& lists of local interfaces
3587 &`lists          `& matching things in lists
3588 &`load           `& system load checks
3589 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3590                     &<<CHAPlocalscan>>&)
3591 &`lookup         `& general lookup code and all lookups
3592 &`memory         `& memory handling
3593 &`pid            `& add pid to debug output lines
3594 &`process_info   `& setting info for the process log
3595 &`queue_run      `& queue runs
3596 &`receive        `& general message reception logic
3597 &`resolver       `& turn on the DNS resolver's debugging output
3598 &`retry          `& retry handling
3599 &`rewrite        `& address rewriting
3600 &`route          `& address routing
3601 &`timestamp      `& add timestamp to debug output lines
3602 &`tls            `& TLS logic
3603 &`transport      `& transports
3604 &`uid            `& changes of uid/gid and looking up uid/gid
3605 &`verify         `& address verification logic
3606 &`all            `& almost all of the above (see below), and also &%-v%&
3607 .endd
3608 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3609 for &`-all`&. The reason for this is that &`+all`& is something that people
3610 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3611 is included, an awful lot of output that is very rarely of interest is
3612 generated, so it now has to be explicitly requested. However, &`-all`& does
3613 turn everything off.
3614
3615 .cindex "resolver, debugging output"
3616 .cindex "DNS resolver, debugging output"
3617 The &`resolver`& option produces output only if the DNS resolver was compiled
3618 with DEBUG enabled. This is not the case in some operating systems. Also,
3619 unfortunately, debugging output from the DNS resolver is written to stdout
3620 rather than stderr.
3621
3622 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3623 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3624 However, the &`pid`& selector is forced when debugging is turned on for a
3625 daemon, which then passes it on to any re-executed Exims. Exim also
3626 automatically adds the pid to debug lines when several remote deliveries are
3627 run in parallel.
3628
3629 The &`timestamp`& selector causes the current time to be inserted at the start
3630 of all debug output lines. This can be useful when trying to track down delays
3631 in processing.
3632
3633 If the &%debug_print%& option is set in any driver, it produces output whenever
3634 any debugging is selected, or if &%-v%& is used.
3635
3636 .vitem &%-dd%&<&'debug&~options'&>
3637 .oindex "&%-dd%&"
3638 This option behaves exactly like &%-d%& except when used on a command that
3639 starts a daemon process. In that case, debugging is turned off for the
3640 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3641 behaviour of the daemon without creating as much output as full debugging does.
3642
3643 .vitem &%-dropcr%&
3644 .oindex "&%-dropcr%&"
3645 This is an obsolete option that is now a no-op. It used to affect the way Exim
3646 handled CR and LF characters in incoming messages. What happens now is
3647 described in section &<<SECTlineendings>>&.
3648
3649 .vitem &%-E%&
3650 .oindex "&%-E%&"
3651 .cindex "bounce message" "generating"
3652 This option specifies that an incoming message is a locally-generated delivery
3653 failure report. It is used internally by Exim when handling delivery failures
3654 and is not intended for external use. Its only effect is to stop Exim
3655 generating certain messages to the postmaster, as otherwise message cascades
3656 could occur in some situations. As part of the same option, a message id may
3657 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3658 new message contains the id, following &"R="&, as a cross-reference.
3659
3660 .vitem &%-e%&&'x'&
3661 .oindex "&%-e%&&'x'&"
3662 There are a number of Sendmail options starting with &%-oe%& which seem to be
3663 called by various programs without the leading &%o%& in the option. For
3664 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3665 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3666
3667 .vitem &%-F%&&~<&'string'&>
3668 .oindex "&%-F%&"
3669 .cindex "sender" "name"
3670 .cindex "name" "of sender"
3671 This option sets the sender's full name for use when a locally-generated
3672 message is being accepted. In the absence of this option, the user's &'gecos'&
3673 entry from the password data is used. As users are generally permitted to alter
3674 their &'gecos'& entries, no security considerations are involved. White space
3675 between &%-F%& and the <&'string'&> is optional.
3676
3677 .vitem &%-f%&&~<&'address'&>
3678 .oindex "&%-f%&"
3679 .cindex "sender" "address"
3680 .cindex "address" "sender"
3681 .cindex "trusted users"
3682 .cindex "envelope sender"
3683 .cindex "user" "trusted"
3684 This option sets the address of the envelope sender of a locally-generated
3685 message (also known as the return path). The option can normally be used only
3686 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3687 users to use it.
3688
3689 Processes running as root or the Exim user are always trusted. Other
3690 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3691 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3692 of a local message is set to the caller's login name at the default qualify
3693 domain.
3694
3695 There is one exception to the restriction on the use of &%-f%&: an empty sender
3696 can be specified by any user, trusted or not, to create a message that can
3697 never provoke a bounce. An empty sender can be specified either as an empty
3698 string, or as a pair of angle brackets with nothing between them, as in these
3699 examples of shell commands:
3700 .code
3701 exim -f '<>' user@domain
3702 exim -f "" user@domain
3703 .endd
3704 In addition, the use of &%-f%& is not restricted when testing a filter file
3705 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3706 &%-bv%& options.
3707
3708 Allowing untrusted users to change the sender address does not of itself make
3709 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3710 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3711 though this can be overridden by setting &%no_local_from_check%&.
3712
3713 White
3714 .cindex "&""From""& line"
3715 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3716 given as two arguments or one combined argument). The sender of a
3717 locally-generated message can also be set (when permitted) by an initial
3718 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3719 if &%-f%& is also present, it overrides &"From&~"&.
3720
3721 .vitem &%-G%&
3722 .oindex "&%-G%&"
3723 .cindex "submission fixups, suppressing (command-line)"
3724 This option is equivalent to an ACL applying:
3725 .code
3726 control = suppress_local_fixups
3727 .endd
3728 for every message received.  Note that Sendmail will complain about such
3729 bad formatting, where Exim silently just does not fix it up.  This may change
3730 in future.
3731
3732 As this affects audit information, the caller must be a trusted user to use
3733 this option.
3734
3735 .vitem &%-h%&&~<&'number'&>
3736 .oindex "&%-h%&"
3737 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3738 This option is accepted for compatibility with Sendmail, but has no effect. (In
3739 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3740 headers.)
3741
3742 .vitem &%-i%&
3743 .oindex "&%-i%&"
3744 .cindex "Solaris" "&'mail'& command"
3745 .cindex "dot" "in incoming non-SMTP message"
3746 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3747 line by itself should not terminate an incoming, non-SMTP message. I can find
3748 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3749 command in Solaris 2.4 uses it. See also &%-ti%&.
3750
3751 .vitem &%-L%&&~<&'tag'&>
3752 .oindex "&%-L%&"
3753 .cindex "syslog" "process name; set with flag"
3754 This option is equivalent to setting &%syslog_processname%& in the config
3755 file and setting &%log_file_path%& to &`syslog`&.
3756 Its use is restricted to administrators.  The configuration file has to be
3757 read and parsed, to determine access rights, before this is set and takes
3758 effect, so early configuration file errors will not honour this flag.
3759
3760 The tag should not be longer than 32 characters.
3761
3762 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3763 .oindex "&%-M%&"
3764 .cindex "forcing delivery"
3765 .cindex "delivery" "forcing attempt"
3766 .cindex "frozen messages" "forcing delivery"
3767 This option requests Exim to run a delivery attempt on each message in turn. If
3768 any of the messages are frozen, they are automatically thawed before the
3769 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3770 and &%hold_domains%& are ignored.
3771
3772 Retry
3773 .cindex "hints database" "overriding retry hints"
3774 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3775 the normal retry time has not yet been reached. This option requires the caller
3776 to be an admin user. However, there is an option called &%prod_requires_admin%&
3777 which can be set false to relax this restriction (and also the same requirement
3778 for the &%-q%&, &%-R%&, and &%-S%& options).
3779
3780 The deliveries happen synchronously, that is, the original Exim process does
3781 not terminate until all the delivery attempts have finished. No output is
3782 produced unless there is a serious error. If you want to see what is happening,
3783 use the &%-v%& option as well, or inspect Exim's main log.
3784
3785 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3786 .oindex "&%-Mar%&"
3787 .cindex "message" "adding recipients"
3788 .cindex "recipient" "adding"
3789 This option requests Exim to add the addresses to the list of recipients of the
3790 message (&"ar"& for &"add recipients"&). The first argument must be a message
3791 id, and the remaining ones must be email addresses. However, if the message is
3792 active (in the middle of a delivery attempt), it is not altered. This option
3793 can be used only by an admin user.
3794
3795 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3796         &~<&'message&~id'&>"
3797 .oindex "&%-MC%&"
3798 .cindex "SMTP" "passed connection"
3799 .cindex "SMTP" "multiple deliveries"
3800 .cindex "multiple SMTP deliveries"
3801 This option is not intended for use by external callers. It is used internally
3802 by Exim to invoke another instance of itself to deliver a waiting message using
3803 an existing SMTP connection, which is passed as the standard input. Details are
3804 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3805 must be root or the Exim user in order to use it.
3806
3807 .vitem &%-MCA%&
3808 .oindex "&%-MCA%&"
3809 This option is not intended for use by external callers. It is used internally
3810 by Exim in conjunction with the &%-MC%& option. It signifies that the
3811 connection to the remote host has been authenticated.
3812
3813 .new
3814 .vitem &%-MCD%&
3815 .oindex "&%-MCD%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the
3818 remote host supports the ESMTP &_DSN_& extension.
3819 .wen
3820
3821 .vitem &%-MCP%&
3822 .oindex "&%-MCP%&"
3823 This option is not intended for use by external callers. It is used internally
3824 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3825 which Exim is connected supports pipelining.
3826
3827 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3828 .oindex "&%-MCQ%&"
3829 This option is not intended for use by external callers. It is used internally
3830 by Exim in conjunction with the &%-MC%& option when the original delivery was
3831 started by a queue runner. It passes on the process id of the queue runner,
3832 together with the file descriptor number of an open pipe. Closure of the pipe
3833 signals the final completion of the sequence of processes that are passing
3834 messages through the same SMTP connection.
3835
3836 .vitem &%-MCS%&
3837 .oindex "&%-MCS%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 SMTP SIZE option should be used on messages delivered down the existing
3841 connection.
3842
3843 .vitem &%-MCT%&
3844 .oindex "&%-MCT%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3847 host to which Exim is connected supports TLS encryption.
3848
3849 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3850 .oindex "&%-Mc%&"
3851 .cindex "hints database" "not overridden by &%-Mc%&"
3852 .cindex "delivery" "manually started &-- not forced"
3853 This option requests Exim to run a delivery attempt on each message in turn,
3854 but unlike the &%-M%& option, it does check for retry hints, and respects any
3855 that are found. This option is not very useful to external callers. It is
3856 provided mainly for internal use by Exim when it needs to re-invoke itself in
3857 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3858 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3859 respects retry times and other options such as &%hold_domains%& that are
3860 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3861 If you want to run a specific delivery as if in a queue run, you should use
3862 &%-q%& with a message id argument. A distinction between queue run deliveries
3863 and other deliveries is made in one or two places.
3864
3865 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3866 .oindex "&%-Mes%&"
3867 .cindex "message" "changing sender"
3868 .cindex "sender" "changing"
3869 This option requests Exim to change the sender address in the message to the
3870 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3871 &"edit sender"&). There must be exactly two arguments. The first argument must
3872 be a message id, and the second one an email address. However, if the message
3873 is active (in the middle of a delivery attempt), its status is not altered.
3874 This option can be used only by an admin user.
3875
3876 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3877 .oindex "&%-Mf%&"
3878 .cindex "freezing messages"
3879 .cindex "message" "manually freezing"
3880 This option requests Exim to mark each listed message as &"frozen"&. This
3881 prevents any delivery attempts taking place until the message is &"thawed"&,
3882 either manually or as a result of the &%auto_thaw%& configuration option.
3883 However, if any of the messages are active (in the middle of a delivery
3884 attempt), their status is not altered. This option can be used only by an admin
3885 user.
3886
3887 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3888 .oindex "&%-Mg%&"
3889 .cindex "giving up on messages"
3890 .cindex "message" "abandoning delivery attempts"
3891 .cindex "delivery" "abandoning further attempts"
3892 This option requests Exim to give up trying to deliver the listed messages,
3893 including any that are frozen. However, if any of the messages are active,
3894 their status is not altered. For non-bounce messages, a delivery error message
3895 is sent to the sender, containing the text &"cancelled by administrator"&.
3896 Bounce messages are just discarded. This option can be used only by an admin
3897 user.
3898
3899 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3900 .oindex "&%-Mmad%&"
3901 .cindex "delivery" "cancelling all"
3902 This option requests Exim to mark all the recipient addresses in the messages
3903 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3904 message is active (in the middle of a delivery attempt), its status is not
3905 altered. This option can be used only by an admin user.
3906
3907 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3908 .oindex "&%-Mmd%&"
3909 .cindex "delivery" "cancelling by address"
3910 .cindex "recipient" "removing"
3911 .cindex "removing recipients"
3912 This option requests Exim to mark the given addresses as already delivered
3913 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3914 the remaining ones must be email addresses. These are matched to recipient
3915 addresses in the message in a case-sensitive manner. If the message is active
3916 (in the middle of a delivery attempt), its status is not altered. This option
3917 can be used only by an admin user.
3918
3919 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3920 .oindex "&%-Mrm%&"
3921 .cindex "removing messages"
3922 .cindex "abandoning mail"
3923 .cindex "message" "manually discarding"
3924 This option requests Exim to remove the given messages from the queue. No
3925 bounce messages are sent; each message is simply forgotten. However, if any of
3926 the messages are active, their status is not altered. This option can be used
3927 only by an admin user or by the user who originally caused the message to be
3928 placed on the queue.
3929
3930 .vitem &%-Mset%&&~<&'message&~id'&>
3931 .oindex "&%-Mset%&
3932 .cindex "testing" "string expansion"
3933 .cindex "expansion" "testing"
3934 This option is useful only in conjunction with &%-be%& (that is, when testing
3935 string expansions). Exim loads the given message from its spool before doing
3936 the test expansions, thus setting message-specific variables such as
3937 &$message_size$& and the header variables. The &$recipients$& variable is made
3938 available. This feature is provided to make it easier to test expansions that
3939 make use of these variables. However, this option can be used only by an admin
3940 user. See also &%-bem%&.
3941
3942 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3943 .oindex "&%-Mt%&"
3944 .cindex "thawing messages"
3945 .cindex "unfreezing messages"
3946 .cindex "frozen messages" "thawing"
3947 .cindex "message" "thawing frozen"
3948 This option requests Exim to &"thaw"& any of the listed messages that are
3949 &"frozen"&, so that delivery attempts can resume. However, if any of the
3950 messages are active, their status is not altered. This option can be used only
3951 by an admin user.
3952
3953 .vitem &%-Mvb%&&~<&'message&~id'&>
3954 .oindex "&%-Mvb%&"
3955 .cindex "listing" "message body"
3956 .cindex "message" "listing body of"
3957 This option causes the contents of the message body (-D) spool file to be
3958 written to the standard output. This option can be used only by an admin user.
3959
3960 .vitem &%-Mvc%&&~<&'message&~id'&>
3961 .oindex "&%-Mvc%&"
3962 .cindex "message" "listing in RFC 2822 format"
3963 .cindex "listing" "message in RFC 2822 format"
3964 This option causes a copy of the complete message (header lines plus body) to
3965 be written to the standard output in RFC 2822 format. This option can be used
3966 only by an admin user.
3967
3968 .vitem &%-Mvh%&&~<&'message&~id'&>
3969 .oindex "&%-Mvh%&"
3970 .cindex "listing" "message headers"
3971 .cindex "header lines" "listing"
3972 .cindex "message" "listing header lines"
3973 This option causes the contents of the message headers (-H) spool file to be
3974 written to the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-Mvl%&&~<&'message&~id'&>
3977 .oindex "&%-Mvl%&"
3978 .cindex "listing" "message log"
3979 .cindex "message" "listing message log"
3980 This option causes the contents of the message log spool file to be written to
3981 the standard output. This option can be used only by an admin user.
3982
3983 .vitem &%-m%&
3984 .oindex "&%-m%&"
3985 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3986 treats it that way too.
3987
3988 .vitem &%-N%&
3989 .oindex "&%-N%&"
3990 .cindex "debugging" "&%-N%& option"
3991 .cindex "debugging" "suppressing delivery"
3992 This is a debugging option that inhibits delivery of a message at the transport
3993 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3994 it just doesn't actually transport the message, but instead behaves as if it
3995 had successfully done so. However, it does not make any updates to the retry
3996 database, and the log entries for deliveries are flagged with &"*>"& rather
3997 than &"=>"&.
3998
3999 Because &%-N%& discards any message to which it applies, only root or the Exim
4000 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4001 words, an ordinary user can use it only when supplying an incoming message to
4002 which it will apply. Although transportation never fails when &%-N%& is set, an
4003 address may be deferred because of a configuration problem on a transport, or a
4004 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4005 the message, and applies to any subsequent delivery attempts that may happen
4006 for that message.
4007
4008 .vitem &%-n%&
4009 .oindex "&%-n%&"
4010 This option is interpreted by Sendmail to mean &"no aliasing"&.
4011 For normal modes of operation, it is ignored by Exim.
4012 When combined with &%-bP%& it suppresses the name of an option from being output.
4013
4014 .vitem &%-O%&&~<&'data'&>
4015 .oindex "&%-O%&"
4016 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4017 Exim.
4018
4019 .vitem &%-oA%&&~<&'file&~name'&>
4020 .oindex "&%-oA%&"
4021 .cindex "Sendmail compatibility" "&%-oA%& option"
4022 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4023 alternative alias file name. Exim handles &%-bi%& differently; see the
4024 description above.
4025
4026 .vitem &%-oB%&&~<&'n'&>
4027 .oindex "&%-oB%&"
4028 .cindex "SMTP" "passed connection"
4029 .cindex "SMTP" "multiple deliveries"
4030 .cindex "multiple SMTP deliveries"
4031 This is a debugging option which limits the maximum number of messages that can
4032 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4033 transport. If <&'n'&> is omitted, the limit is set to 1.
4034
4035 .vitem &%-odb%&
4036 .oindex "&%-odb%&"
4037 .cindex "background delivery"
4038 .cindex "delivery" "in the background"
4039 This option applies to all modes in which Exim accepts incoming messages,
4040 including the listening daemon. It requests &"background"& delivery of such
4041 messages, which means that the accepting process automatically starts a
4042 delivery process for each message received, but does not wait for the delivery
4043 processes to finish.
4044
4045 When all the messages have been received, the reception process exits,
4046 leaving the delivery processes to finish in their own time. The standard output
4047 and error streams are closed at the start of each delivery process.
4048 This is the default action if none of the &%-od%& options are present.
4049
4050 If one of the queueing options in the configuration file
4051 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4052 overrides it if &%queue_only_override%& is set true, which is the default
4053 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4054
4055 .vitem &%-odf%&
4056 .oindex "&%-odf%&"
4057 .cindex "foreground delivery"
4058 .cindex "delivery" "in the foreground"
4059 This option requests &"foreground"& (synchronous) delivery when Exim has
4060 accepted a locally-generated message. (For the daemon it is exactly the same as
4061 &%-odb%&.) A delivery process is automatically started to deliver the message,
4062 and Exim waits for it to complete before proceeding.
4063
4064 The original Exim reception process does not finish until the delivery
4065 process for the final message has ended. The standard error stream is left open
4066 during deliveries.
4067
4068 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4069 false and one of the queueing options in the configuration file is in effect.
4070
4071 If there is a temporary delivery error during foreground delivery, the
4072 message is left on the queue for later delivery, and the original reception
4073 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4074 restricted configuration that never queues messages.
4075
4076
4077 .vitem &%-odi%&
4078 .oindex "&%-odi%&"
4079 This option is synonymous with &%-odf%&. It is provided for compatibility with
4080 Sendmail.
4081
4082 .vitem &%-odq%&
4083 .oindex "&%-odq%&"
4084 .cindex "non-immediate delivery"
4085 .cindex "delivery" "suppressing immediate"
4086 .cindex "queueing incoming messages"
4087 This option applies to all modes in which Exim accepts incoming messages,
4088 including the listening daemon. It specifies that the accepting process should
4089 not automatically start a delivery process for each message received. Messages
4090 are placed on the queue, and remain there until a subsequent queue runner
4091 process encounters them. There are several configuration options (such as
4092 &%queue_only%&) that can be used to queue incoming messages under certain
4093 conditions. This option overrides all of them and also &%-odqs%&. It always
4094 forces queueing.
4095
4096 .vitem &%-odqs%&
4097 .oindex "&%-odqs%&"
4098 .cindex "SMTP" "delaying delivery"
4099 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4100 However, like &%-odb%& and &%-odi%&, this option has no effect if
4101 &%queue_only_override%& is false and one of the queueing options in the
4102 configuration file is in effect.
4103
4104 When &%-odqs%& does operate, a delivery process is started for each incoming
4105 message, in the background by default, but in the foreground if &%-odi%& is
4106 also present. The recipient addresses are routed, and local deliveries are done
4107 in the normal way. However, if any SMTP deliveries are required, they are not
4108 done at this time, so the message remains on the queue until a subsequent queue
4109 runner process encounters it. Because routing was done, Exim knows which
4110 messages are waiting for which hosts, and so a number of messages for the same
4111 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4112 configuration option has the same effect for specific domains. See also the
4113 &%-qq%& option.
4114
4115 .vitem &%-oee%&
4116 .oindex "&%-oee%&"
4117 .cindex "error" "reporting"
4118 If an error is detected while a non-SMTP message is being received (for
4119 example, a malformed address), the error is reported to the sender in a mail
4120 message.
4121
4122 .cindex "return code" "for &%-oee%&"
4123 Provided
4124 this error message is successfully sent, the Exim receiving process
4125 exits with a return code of zero. If not, the return code is 2 if the problem
4126 is that the original message has no recipients, or 1 for any other error.
4127 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4128
4129 .vitem &%-oem%&
4130 .oindex "&%-oem%&"
4131 .cindex "error" "reporting"
4132 .cindex "return code" "for &%-oem%&"
4133 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4134 return code, whether or not the error message was successfully sent.
4135 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4136
4137 .vitem &%-oep%&
4138 .oindex "&%-oep%&"
4139 .cindex "error" "reporting"
4140 If an error is detected while a non-SMTP message is being received, the
4141 error is reported by writing a message to the standard error file (stderr).
4142 .cindex "return code" "for &%-oep%&"
4143 The return code is 1 for all errors.
4144
4145 .vitem &%-oeq%&
4146 .oindex "&%-oeq%&"
4147 .cindex "error" "reporting"
4148 This option is supported for compatibility with Sendmail, but has the same
4149 effect as &%-oep%&.
4150
4151 .vitem &%-oew%&
4152 .oindex "&%-oew%&"
4153 .cindex "error" "reporting"
4154 This option is supported for compatibility with Sendmail, but has the same
4155 effect as &%-oem%&.
4156
4157 .vitem &%-oi%&
4158 .oindex "&%-oi%&"
4159 .cindex "dot" "in incoming non-SMTP message"
4160 This option, which has the same effect as &%-i%&, specifies that a dot on a
4161 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4162 single dot does terminate, though Exim does no special processing for other
4163 lines that start with a dot. This option is set by default if Exim is called as
4164 &'rmail'&. See also &%-ti%&.
4165
4166 .vitem &%-oitrue%&
4167 .oindex "&%-oitrue%&"
4168 This option is treated as synonymous with &%-oi%&.
4169
4170 .vitem &%-oMa%&&~<&'host&~address'&>
4171 .oindex "&%-oMa%&"
4172 .cindex "sender" "host address, specifying for local message"
4173 A number of options starting with &%-oM%& can be used to set values associated
4174 with remote hosts on locally-submitted messages (that is, messages not received
4175 over TCP/IP). These options can be used by any caller in conjunction with the
4176 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4177 other circumstances, they are ignored unless the caller is trusted.
4178
4179 The &%-oMa%& option sets the sender host address. This may include a port
4180 number at the end, after a full stop (period). For example:
4181 .code
4182 exim -bs -oMa 10.9.8.7.1234
4183 .endd
4184 An alternative syntax is to enclose the IP address in square brackets,
4185 followed by a colon and the port number:
4186 .code
4187 exim -bs -oMa [10.9.8.7]:1234
4188 .endd
4189 The IP address is placed in the &$sender_host_address$& variable, and the
4190 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4191 are present on the command line, the sender host IP address is taken from
4192 whichever one is last.
4193
4194 .vitem &%-oMaa%&&~<&'name'&>
4195 .oindex "&%-oMaa%&"
4196 .cindex "authentication" "name, specifying for local message"
4197 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4198 option sets the value of &$sender_host_authenticated$& (the authenticator
4199 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4200 This option can be used with &%-bh%& and &%-bs%& to set up an
4201 authenticated SMTP session without actually using the SMTP AUTH command.
4202
4203 .vitem &%-oMai%&&~<&'string'&>
4204 .oindex "&%-oMai%&"
4205 .cindex "authentication" "id, specifying for local message"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4207 option sets the value of &$authenticated_id$& (the id that was authenticated).
4208 This overrides the default value (the caller's login id, except with &%-bh%&,
4209 where there is no default) for messages from local sources. See chapter
4210 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4211
4212 .vitem &%-oMas%&&~<&'address'&>
4213 .oindex "&%-oMas%&"
4214 .cindex "authentication" "sender, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4216 option sets the authenticated sender value in &$authenticated_sender$&. It
4217 overrides the sender address that is created from the caller's login id for
4218 messages from local sources, except when &%-bh%& is used, when there is no
4219 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4220 specified on a MAIL command overrides this value. See chapter
4221 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4222
4223 .vitem &%-oMi%&&~<&'interface&~address'&>
4224 .oindex "&%-oMi%&"
4225 .cindex "interface" "address, specifying for local message"
4226 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4227 option sets the IP interface address value. A port number may be included,
4228 using the same syntax as for &%-oMa%&. The interface address is placed in
4229 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4230
4231 .vitem &%-oMm%&&~<&'message&~reference'&>
4232 .oindex "&%-oMm%&"
4233 .cindex "message reference" "message reference, specifying for local message"
4234 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4235 option sets the message reference, e.g. message-id, and is logged during
4236 delivery. This is useful when some kind of audit trail is required to tie
4237 messages together. The format of the message reference is checked and will
4238 abort if the format is invalid. The option will only be accepted if exim is
4239 running in trusted mode, not as any regular user.
4240
4241 The best example of a message reference is when Exim sends a bounce message.
4242 The message reference is the message-id of the original message for which Exim
4243 is sending the bounce.
4244
4245 .vitem &%-oMr%&&~<&'protocol&~name'&>
4246 .oindex "&%-oMr%&"
4247 .cindex "protocol, specifying for local message"
4248 .vindex "&$received_protocol$&"
4249 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4250 option sets the received protocol value that is stored in
4251 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4252 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4253 SMTP protocol names (see the description of &$received_protocol$& in section
4254 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4255 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4256 be set by &%-oMr%&.
4257
4258 .vitem &%-oMs%&&~<&'host&~name'&>
4259 .oindex "&%-oMs%&"
4260 .cindex "sender" "host name, specifying for local message"
4261 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4262 option sets the sender host name in &$sender_host_name$&. When this option is
4263 present, Exim does not attempt to look up a host name from an IP address; it
4264 uses the name it is given.
4265
4266 .vitem &%-oMt%&&~<&'ident&~string'&>
4267 .oindex "&%-oMt%&"
4268 .cindex "sender" "ident string, specifying for local message"
4269 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4270 option sets the sender ident value in &$sender_ident$&. The default setting for
4271 local callers is the login id of the calling process, except when &%-bh%& is
4272 used, when there is no default.
4273
4274 .vitem &%-om%&
4275 .oindex "&%-om%&"
4276 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4277 In Sendmail, this option means &"me too"&, indicating that the sender of a
4278 message should receive a copy of the message if the sender appears in an alias
4279 expansion. Exim always does this, so the option does nothing.
4280
4281 .vitem &%-oo%&
4282 .oindex "&%-oo%&"
4283 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4284 This option is ignored. In Sendmail it specifies &"old style headers"&,
4285 whatever that means.
4286
4287 .vitem &%-oP%&&~<&'path'&>
4288 .oindex "&%-oP%&"
4289 .cindex "pid (process id)" "of daemon"
4290 .cindex "daemon" "process id (pid)"
4291 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4292 value. The option specifies the file to which the process id of the daemon is
4293 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4294 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4295 because in those cases, the normal pid file is not used.
4296
4297 .vitem &%-or%&&~<&'time'&>
4298 .oindex "&%-or%&"
4299 .cindex "timeout" "for non-SMTP input"
4300 This option sets a timeout value for incoming non-SMTP messages. If it is not
4301 set, Exim will wait forever for the standard input. The value can also be set
4302 by the &%receive_timeout%& option. The format used for specifying times is
4303 described in section &<<SECTtimeformat>>&.
4304
4305 .vitem &%-os%&&~<&'time'&>
4306 .oindex "&%-os%&"
4307 .cindex "timeout" "for SMTP input"
4308 .cindex "SMTP" "input timeout"
4309 This option sets a timeout value for incoming SMTP messages. The timeout
4310 applies to each SMTP command and block of data. The value can also be set by
4311 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4312 for specifying times is described in section &<<SECTtimeformat>>&.
4313
4314 .vitem &%-ov%&
4315 .oindex "&%-ov%&"
4316 This option has exactly the same effect as &%-v%&.
4317
4318 .vitem &%-oX%&&~<&'number&~or&~string'&>
4319 .oindex "&%-oX%&"
4320 .cindex "TCP/IP" "setting listening ports"
4321 .cindex "TCP/IP" "setting listening interfaces"
4322 .cindex "port" "receiving TCP/IP"
4323 This option is relevant only when the &%-bd%& (start listening daemon) option
4324 is also given. It controls which ports and interfaces the daemon uses. Details
4325 of the syntax, and how it interacts with configuration file options, are given
4326 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4327 file is written unless &%-oP%& is also present to specify a pid file name.
4328
4329 .vitem &%-pd%&
4330 .oindex "&%-pd%&"
4331 .cindex "Perl" "starting the interpreter"
4332 This option applies when an embedded Perl interpreter is linked with Exim (see
4333 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4334 option, forcing the starting of the interpreter to be delayed until it is
4335 needed.
4336
4337 .vitem &%-ps%&
4338 .oindex "&%-ps%&"
4339 .cindex "Perl" "starting the interpreter"
4340 This option applies when an embedded Perl interpreter is linked with Exim (see
4341 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4342 option, forcing the starting of the interpreter to occur as soon as Exim is
4343 started.
4344
4345 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4346 .oindex "&%-p%&"
4347 For compatibility with Sendmail, this option is equivalent to
4348 .display
4349 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4350 .endd
4351 It sets the incoming protocol and host name (for trusted callers). The
4352 host name and its colon can be omitted when only the protocol is to be set.
4353 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4354 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4355 or &`s`& using this option (but that does not seem a real limitation).
4356
4357 .vitem &%-q%&
4358 .oindex "&%-q%&"
4359 .cindex "queue runner" "starting manually"
4360 This option is normally restricted to admin users. However, there is a
4361 configuration option called &%prod_requires_admin%& which can be set false to
4362 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4363 and &%-S%& options).
4364
4365 .cindex "queue runner" "description of operation"
4366 The &%-q%& option starts one queue runner process. This scans the queue of
4367 waiting messages, and runs a delivery process for each one in turn. It waits
4368 for each delivery process to finish before starting the next one. A delivery
4369 process may not actually do any deliveries if the retry times for the addresses
4370 have not been reached. Use &%-qf%& (see below) if you want to override this.
4371
4372 If
4373 .cindex "SMTP" "passed connection"
4374 .cindex "SMTP" "multiple deliveries"
4375 .cindex "multiple SMTP deliveries"
4376 the delivery process spawns other processes to deliver other messages down
4377 passed SMTP connections, the queue runner waits for these to finish before
4378 proceeding.
4379
4380 When all the queued messages have been considered, the original queue runner
4381 process terminates. In other words, a single pass is made over the waiting
4382 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4383 this to be repeated periodically.
4384
4385 Exim processes the waiting messages in an unpredictable order. It isn't very
4386 random, but it is likely to be different each time, which is all that matters.
4387 If one particular message screws up a remote MTA, other messages to the same
4388 MTA have a chance of getting through if they get tried first.
4389
4390 It is possible to cause the messages to be processed in lexical message id
4391 order, which is essentially the order in which they arrived, by setting the
4392 &%queue_run_in_order%& option, but this is not recommended for normal use.
4393
4394 .vitem &%-q%&<&'qflags'&>
4395 The &%-q%& option may be followed by one or more flag letters that change its
4396 behaviour. They are all optional, but if more than one is present, they must
4397 appear in the correct order. Each flag is described in a separate item below.
4398
4399 .vitem &%-qq...%&
4400 .oindex "&%-qq%&"
4401 .cindex "queue" "double scanning"
4402 .cindex "queue" "routing"
4403 .cindex "routing" "whole queue before delivery"
4404 An option starting with &%-qq%& requests a two-stage queue run. In the first
4405 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4406 every domain. Addresses are routed, local deliveries happen, but no remote
4407 transports are run.
4408
4409 .cindex "hints database" "remembering routing"
4410 The hints database that remembers which messages are waiting for specific hosts
4411 is updated, as if delivery to those hosts had been deferred. After this is
4412 complete, a second, normal queue scan happens, with routing and delivery taking
4413 place as normal. Messages that are routed to the same host should mostly be
4414 delivered down a single SMTP
4415 .cindex "SMTP" "passed connection"
4416 .cindex "SMTP" "multiple deliveries"
4417 .cindex "multiple SMTP deliveries"
4418 connection because of the hints that were set up during the first queue scan.
4419 This option may be useful for hosts that are connected to the Internet
4420 intermittently.
4421
4422 .vitem &%-q[q]i...%&
4423 .oindex "&%-qi%&"
4424 .cindex "queue" "initial delivery"
4425 If the &'i'& flag is present, the queue runner runs delivery processes only for
4426 those messages that haven't previously been tried. (&'i'& stands for &"initial
4427 delivery"&.) This can be helpful if you are putting messages on the queue using
4428 &%-odq%& and want a queue runner just to process the new messages.
4429
4430 .vitem &%-q[q][i]f...%&
4431 .oindex "&%-qf%&"
4432 .cindex "queue" "forcing delivery"
4433 .cindex "delivery" "forcing in queue run"
4434 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4435 message, whereas without &'f'& only those non-frozen addresses that have passed
4436 their retry times are tried.
4437
4438 .vitem &%-q[q][i]ff...%&
4439 .oindex "&%-qff%&"
4440 .cindex "frozen messages" "forcing delivery"
4441 If &'ff'& is present, a delivery attempt is forced for every message, whether
4442 frozen or not.
4443
4444 .vitem &%-q[q][i][f[f]]l%&
4445 .oindex "&%-ql%&"
4446 .cindex "queue" "local deliveries only"
4447 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4448 be done. If a message requires any remote deliveries, it remains on the queue
4449 for later delivery.
4450
4451 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4452 .cindex "queue" "delivering specific messages"
4453 When scanning the queue, Exim can be made to skip over messages whose ids are
4454 lexically less than a given value by following the &%-q%& option with a
4455 starting message id. For example:
4456 .code
4457 exim -q 0t5C6f-0000c8-00
4458 .endd
4459 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4460 second message id is given, messages whose ids are lexically greater than it
4461 are also skipped. If the same id is given twice, for example,
4462 .code
4463 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4464 .endd
4465 just one delivery process is started, for that message. This differs from
4466 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4467 that it counts as a delivery from a queue run. Note that the selection
4468 mechanism does not affect the order in which the messages are scanned. There
4469 are also other ways of selecting specific sets of messages for delivery in a
4470 queue run &-- see &%-R%& and &%-S%&.
4471
4472 .vitem &%-q%&<&'qflags'&><&'time'&>
4473 .cindex "queue runner" "starting periodically"
4474 .cindex "periodic queue running"
4475 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4476 starting a queue runner process at intervals specified by the given time value
4477 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4478 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4479 single daemon process handles both functions. A common way of starting up a
4480 combined daemon at system boot time is to use a command such as
4481 .code
4482 /usr/exim/bin/exim -bd -q30m
4483 .endd
4484 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4485 process every 30 minutes.
4486
4487 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4488 pid file is written unless one is explicitly requested by the &%-oP%& option.
4489
4490 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4491 .oindex "&%-qR%&"
4492 This option is synonymous with &%-R%&. It is provided for Sendmail
4493 compatibility.
4494
4495 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4496 .oindex "&%-qS%&"
4497 This option is synonymous with &%-S%&.
4498
4499 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4500 .oindex "&%-R%&"
4501 .cindex "queue runner" "for specific recipients"
4502 .cindex "delivery" "to given domain"
4503 .cindex "domain" "delivery to"
4504 The <&'rsflags'&> may be empty, in which case the white space before the string
4505 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4506 which are the possible values for <&'rsflags'&>. White space is required if
4507 <&'rsflags'&> is not empty.
4508
4509 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4510 perform a single queue run, except that, when scanning the messages on the
4511 queue, Exim processes only those that have at least one undelivered recipient
4512 address containing the given string, which is checked in a case-independent
4513 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4514 regular expression; otherwise it is a literal string.
4515
4516 If you want to do periodic queue runs for messages with specific recipients,
4517 you can combine &%-R%& with &%-q%& and a time value. For example:
4518 .code
4519 exim -q25m -R @special.domain.example
4520 .endd
4521 This example does a queue run for messages with recipients in the given domain
4522 every 25 minutes. Any additional flags that are specified with &%-q%& are
4523 applied to each queue run.
4524
4525 Once a message is selected for delivery by this mechanism, all its addresses
4526 are processed. For the first selected message, Exim overrides any retry
4527 information and forces a delivery attempt for each undelivered address. This
4528 means that if delivery of any address in the first message is successful, any
4529 existing retry information is deleted, and so delivery attempts for that
4530 address in subsequently selected messages (which are processed without forcing)
4531 will run. However, if delivery of any address does not succeed, the retry
4532 information is updated, and in subsequently selected messages, the failing
4533 address will be skipped.
4534
4535 .cindex "frozen messages" "forcing delivery"
4536 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4537 all selected messages, not just the first; frozen messages are included when
4538 &'ff'& is present.
4539
4540 The &%-R%& option makes it straightforward to initiate delivery of all messages
4541 to a given domain after a host has been down for some time. When the SMTP
4542 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4543 effect is to run Exim with the &%-R%& option, but it can be configured to run
4544 an arbitrary command instead.
4545
4546 .vitem &%-r%&
4547 .oindex "&%-r%&"
4548 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4549
4550 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4551 .oindex "&%-S%&"
4552 .cindex "delivery" "from given sender"
4553 .cindex "queue runner" "for specific senders"
4554 This option acts like &%-R%& except that it checks the string against each
4555 message's sender instead of against the recipients. If &%-R%& is also set, both
4556 conditions must be met for a message to be selected. If either of the options
4557 has &'f'& or &'ff'& in its flags, the associated action is taken.
4558
4559 .vitem &%-Tqt%&&~<&'times'&>
4560 .oindex "&%-Tqt%&"
4561 This is an option that is exclusively for use by the Exim testing suite. It is not
4562 recognized when Exim is run normally. It allows for the setting up of explicit
4563 &"queue times"& so that various warning/retry features can be tested.
4564
4565 .vitem &%-t%&
4566 .oindex "&%-t%&"
4567 .cindex "recipient" "extracting from header lines"
4568 .cindex "&'Bcc:'& header line"
4569 .cindex "&'Cc:'& header line"
4570 .cindex "&'To:'& header line"
4571 When Exim is receiving a locally-generated, non-SMTP message on its standard
4572 input, the &%-t%& option causes the recipients of the message to be obtained
4573 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4574 from the command arguments. The addresses are extracted before any rewriting
4575 takes place and the &'Bcc:'& header line, if present, is then removed.
4576
4577 .cindex "Sendmail compatibility" "&%-t%& option"
4578 If the command has any arguments, they specify addresses to which the message
4579 is &'not'& to be delivered. That is, the argument addresses are removed from
4580 the recipients list obtained from the headers. This is compatible with Smail 3
4581 and in accordance with the documented behaviour of several versions of
4582 Sendmail, as described in man pages on a number of operating systems (e.g.
4583 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4584 argument addresses to those obtained from the headers, and the O'Reilly
4585 Sendmail book documents it that way. Exim can be made to add argument addresses
4586 instead of subtracting them by setting the option
4587 &%extract_addresses_remove_arguments%& false.
4588
4589 .cindex "&%Resent-%& header lines" "with &%-t%&"
4590 If there are any &%Resent-%& header lines in the message, Exim extracts
4591 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4592 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4593 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4594 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4595
4596 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4597 message is resent several times). The RFC also specifies that they should be
4598 added at the front of the message, and separated by &'Received:'& lines. It is
4599 not at all clear how &%-t%& should operate in the present of multiple sets,
4600 nor indeed exactly what constitutes a &"set"&.
4601 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4602 are often added at the end of the header, and if a message is resent more than
4603 once, it is common for the original set of &%Resent-%& headers to be renamed as
4604 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4605
4606 .vitem &%-ti%&
4607 .oindex "&%-ti%&"
4608 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4609 compatibility with Sendmail.
4610
4611 .vitem &%-tls-on-connect%&
4612 .oindex "&%-tls-on-connect%&"
4613 .cindex "TLS" "use without STARTTLS"
4614 .cindex "TLS" "automatic start"
4615 This option is available when Exim is compiled with TLS support. It forces all
4616 incoming SMTP connections to behave as if the incoming port is listed in the
4617 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4618 &<<CHAPTLS>>& for further details.
4619
4620
4621 .vitem &%-U%&
4622 .oindex "&%-U%&"
4623 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4624 Sendmail uses this option for &"initial message submission"&, and its
4625 documentation states that in future releases, it may complain about
4626 syntactically invalid messages rather than fixing them when this flag is not
4627 set. Exim ignores this option.
4628
4629 .vitem &%-v%&
4630 .oindex "&%-v%&"
4631 This option causes Exim to write information to the standard error stream,
4632 describing what it is doing. In particular, it shows the log lines for
4633 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4634 dialogue is shown. Some of the log lines shown may not actually be written to
4635 the log if the setting of &%log_selector%& discards them. Any relevant
4636 selectors are shown with each log line. If none are shown, the logging is
4637 unconditional.
4638
4639 .vitem &%-x%&
4640 .oindex "&%-x%&"
4641 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4642 National Language Support extended characters in the body of the mail item"&).
4643 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4644 this option.
4645
4646 .vitem &%-X%&&~<&'logfile'&>
4647 .oindex "&%-X%&"
4648 This option is interpreted by Sendmail to cause debug information to be sent
4649 to the named file.  It is ignored by Exim.
4650
4651 .vitem &%-z%&&~<&'log-line'&>
4652 .oindex "&%-z%&"
4653 This option writes its argument to Exim's logfile.
4654 Use is restricted to administrators; the intent is for operational notes.
4655 Quotes should be used to maintain a multi-word item as a single argument,
4656 under most shells.
4657 .endlist
4658
4659 .ecindex IIDclo1
4660 .ecindex IIDclo2
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . Insert a stylized DocBook comment here, to identify the end of the command
4665 . line options. This is for the benefit of the Perl script that automatically
4666 . creates a man page for the options.
4667 . ////////////////////////////////////////////////////////////////////////////
4668
4669 .literal xml
4670 <!-- === End of command line options === -->
4671 .literal off
4672
4673
4674
4675
4676
4677 . ////////////////////////////////////////////////////////////////////////////
4678 . ////////////////////////////////////////////////////////////////////////////
4679
4680
4681 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4682          "The runtime configuration file"
4683
4684 .cindex "run time configuration"
4685 .cindex "configuration file" "general description"
4686 .cindex "CONFIGURE_FILE"
4687 .cindex "configuration file" "errors in"
4688 .cindex "error" "in configuration file"
4689 .cindex "return code" "for bad configuration"
4690 Exim uses a single run time configuration file that is read whenever an Exim
4691 binary is executed. Note that in normal operation, this happens frequently,
4692 because Exim is designed to operate in a distributed manner, without central
4693 control.
4694
4695 If a syntax error is detected while reading the configuration file, Exim
4696 writes a message on the standard error, and exits with a non-zero return code.
4697 The message is also written to the panic log. &*Note*&: Only simple syntax
4698 errors can be detected at this time. The values of any expanded options are
4699 not checked until the expansion happens, even when the expansion does not
4700 actually alter the string.
4701
4702 The name of the configuration file is compiled into the binary for security
4703 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4704 most configurations, this specifies a single file. However, it is permitted to
4705 give a colon-separated list of file names, in which case Exim uses the first
4706 existing file in the list.
4707
4708 .cindex "EXIM_USER"
4709 .cindex "EXIM_GROUP"
4710 .cindex "CONFIGURE_OWNER"
4711 .cindex "CONFIGURE_GROUP"
4712 .cindex "configuration file" "ownership"
4713 .cindex "ownership" "configuration file"
4714 The run time configuration file must be owned by root or by the user that is
4715 specified at compile time by the CONFIGURE_OWNER option (if set). The
4716 configuration file must not be world-writeable, or group-writeable unless its
4717 group is the root group or the one specified at compile time by the
4718 CONFIGURE_GROUP option.
4719
4720 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4721 to root, anybody who is able to edit the run time configuration file has an
4722 easy way to run commands as root. If you specify a user or group in the
4723 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4724 who are members of that group will trivially be able to obtain root privileges.
4725
4726 Up to Exim version 4.72, the run time configuration file was also permitted to
4727 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4728 since it offered a simple privilege escalation for any attacker who managed to
4729 compromise the Exim user account.
4730
4731 A default configuration file, which will work correctly in simple situations,
4732 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4733 defines just one file name, the installation process copies the default
4734 configuration to a new file of that name if it did not previously exist. If
4735 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4736 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4737 configuration.
4738
4739
4740
4741 .section "Using a different configuration file" "SECID40"
4742 .cindex "configuration file" "alternate"
4743 A one-off alternate configuration can be specified by the &%-C%& command line
4744 option, which may specify a single file or a list of files. However, when
4745 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4746 unless the argument for &%-C%& is identical to the built-in value from
4747 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4748 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4749 is useful mainly for checking the syntax of configuration files before
4750 installing them. No owner or group checks are done on a configuration file
4751 specified by &%-C%&, if root privilege has been dropped.
4752
4753 Even the Exim user is not trusted to specify an arbitrary configuration file
4754 with the &%-C%& option to be used with root privileges, unless that file is
4755 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4756 testing a configuration using &%-C%& right through message reception and
4757 delivery, even if the caller is root. The reception works, but by that time,
4758 Exim is running as the Exim user, so when it re-execs to regain privilege for
4759 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4760 can test reception and delivery using two separate commands (one to put a
4761 message on the queue, using &%-odq%&, and another to do the delivery, using
4762 &%-M%&).
4763
4764 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4765 prefix string with which any file named in a &%-C%& command line option must
4766 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4767 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4768 name can be used with &%-C%&.
4769
4770 One-off changes to a configuration can be specified by the &%-D%& command line
4771 option, which defines and overrides values for macros used inside the
4772 configuration file. However, like &%-C%&, the use of this option by a
4773 non-privileged user causes Exim to discard its root privilege.
4774 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4775 completely disabled, and its use causes an immediate error exit.
4776
4777 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4778 to declare certain macro names trusted, such that root privilege will not
4779 necessarily be discarded.
4780 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4781 considered safe and, if &%-D%& only supplies macros from this list, and the
4782 values are acceptable, then Exim will not give up root privilege if the caller
4783 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4784 transition mechanism and is expected to be removed in the future.  Acceptable
4785 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4786
4787 Some sites may wish to use the same Exim binary on different machines that
4788 share a file system, but to use different configuration files on each machine.
4789 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4790 looks for a file whose name is the configuration file name followed by a dot
4791 and the machine's node name, as obtained from the &[uname()]& function. If this
4792 file does not exist, the standard name is tried. This processing occurs for
4793 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4794
4795 In some esoteric situations different versions of Exim may be run under
4796 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4797 help with this. See the comments in &_src/EDITME_& for details.
4798
4799
4800
4801 .section "Configuration file format" "SECTconffilfor"
4802 .cindex "configuration file" "format of"
4803 .cindex "format" "configuration file"
4804 Exim's configuration file is divided into a number of different parts. General
4805 option settings must always appear at the start of the file. The other parts
4806 are all optional, and may appear in any order. Each part other than the first
4807 is introduced by the word &"begin"& followed by the name of the part. The
4808 optional parts are:
4809
4810 .ilist
4811 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4812 &<<CHAPACL>>&).
4813 .next
4814 .cindex "AUTH" "configuration"
4815 &'authenticators'&: Configuration settings for the authenticator drivers. These
4816 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4817 .next
4818 &'routers'&: Configuration settings for the router drivers. Routers process
4819 addresses and determine how the message is to be delivered (see chapters
4820 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4821 .next
4822 &'transports'&: Configuration settings for the transport drivers. Transports
4823 define mechanisms for copying messages to destinations (see chapters
4824 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4825 .next
4826 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4827 If there is no retry section, or if it is empty (that is, no retry rules are
4828 defined), Exim will not retry deliveries. In this situation, temporary errors
4829 are treated the same as permanent errors. Retry rules are discussed in chapter
4830 &<<CHAPretry>>&.
4831 .next
4832 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4833 when new addresses are generated during delivery. Rewriting is discussed in
4834 chapter &<<CHAPrewrite>>&.
4835 .next
4836 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4837 want to use this feature, you must set
4838 .code
4839 LOCAL_SCAN_HAS_OPTIONS=yes
4840 .endd
4841 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4842 facility are given in chapter &<<CHAPlocalscan>>&.
4843 .endlist
4844
4845 .cindex "configuration file" "leading white space in"
4846 .cindex "configuration file" "trailing white space in"
4847 .cindex "white space" "in configuration file"
4848 Leading and trailing white space in configuration lines is always ignored.
4849
4850 Blank lines in the file, and lines starting with a # character (ignoring
4851 leading white space) are treated as comments and are ignored. &*Note*&: A
4852 # character other than at the beginning of a line is not treated specially,
4853 and does not introduce a comment.
4854
4855 Any non-comment line can be continued by ending it with a backslash. Note that
4856 the general rule for white space means that trailing white space after the
4857 backslash and leading white space at the start of continuation
4858 lines is ignored. Comment lines beginning with # (but not empty lines) may
4859 appear in the middle of a sequence of continuation lines.
4860
4861 A convenient way to create a configuration file is to start from the
4862 default, which is supplied in &_src/configure.default_&, and add, delete, or
4863 change settings as required.
4864
4865 The ACLs, retry rules, and rewriting rules have their own syntax which is
4866 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4867 respectively. The other parts of the configuration file have some syntactic
4868 items in common, and these are described below, from section &<<SECTcos>>&
4869 onwards. Before that, the inclusion, macro, and conditional facilities are
4870 described.
4871
4872
4873
4874 .section "File inclusions in the configuration file" "SECID41"
4875 .cindex "inclusions in configuration file"
4876 .cindex "configuration file" "including other files"
4877 .cindex "&`.include`& in configuration file"
4878 .cindex "&`.include_if_exists`& in configuration file"
4879 You can include other files inside Exim's run time configuration file by
4880 using this syntax:
4881 .display
4882 &`.include`& <&'file name'&>
4883 &`.include_if_exists`& <&'file name'&>
4884 .endd
4885 on a line by itself. Double quotes round the file name are optional. If you use
4886 the first form, a configuration error occurs if the file does not exist; the
4887 second form does nothing for non-existent files. In all cases, an absolute file
4888 name is required.
4889
4890 Includes may be nested to any depth, but remember that Exim reads its
4891 configuration file often, so it is a good idea to keep them to a minimum.
4892 If you change the contents of an included file, you must HUP the daemon,
4893 because an included file is read only when the configuration itself is read.
4894
4895 The processing of inclusions happens early, at a physical line level, so, like
4896 comment lines, an inclusion can be used in the middle of an option setting,
4897 for example:
4898 .code
4899 hosts_lookup = a.b.c \
4900                .include /some/file
4901 .endd
4902 Include processing happens after macro processing (see below). Its effect is to
4903 process the lines of the included file as if they occurred inline where the
4904 inclusion appears.
4905
4906
4907
4908 .section "Macros in the configuration file" "SECTmacrodefs"
4909 .cindex "macro" "description of"
4910 .cindex "configuration file" "macros"
4911 If a line in the main part of the configuration (that is, before the first
4912 &"begin"& line) begins with an upper case letter, it is taken as a macro
4913 definition, and must be of the form
4914 .display
4915 <&'name'&> = <&'rest of line'&>
4916 .endd
4917 The name must consist of letters, digits, and underscores, and need not all be
4918 in upper case, though that is recommended. The rest of the line, including any
4919 continuations, is the replacement text, and has leading and trailing white
4920 space removed. Quotes are not removed. The replacement text can never end with
4921 a backslash character, but this doesn't seem to be a serious limitation.
4922
4923 Macros may also be defined between router, transport, authenticator, or ACL
4924 definitions. They may not, however, be defined within an individual driver or
4925 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4926
4927 .section "Macro substitution" "SECID42"
4928 Once a macro is defined, all subsequent lines in the file (and any included
4929 files) are scanned for the macro name; if there are several macros, the line is
4930 scanned for each in turn, in the order in which the macros are defined. The
4931 replacement text is not re-scanned for the current macro, though it is scanned
4932 for subsequently defined macros. For this reason, a macro name may not contain
4933 the name of a previously defined macro as a substring. You could, for example,
4934 define
4935 .display
4936 &`ABCD_XYZ = `&<&'something'&>
4937 &`ABCD = `&<&'something else'&>
4938 .endd
4939 but putting the definitions in the opposite order would provoke a configuration
4940 error. Macro expansion is applied to individual physical lines from the file,
4941 before checking for line continuation or file inclusion (see above). If a line
4942 consists solely of a macro name, and the expansion of the macro is empty, the
4943 line is ignored. A macro at the start of a line may turn the line into a
4944 comment line or a &`.include`& line.
4945
4946
4947 .section "Redefining macros" "SECID43"
4948 Once defined, the value of a macro can be redefined later in the configuration
4949 (or in an included file). Redefinition is specified by using &'=='& instead of
4950 &'='&. For example:
4951 .code
4952 MAC =  initial value
4953 ...
4954 MAC == updated value
4955 .endd
4956 Redefinition does not alter the order in which the macros are applied to the
4957 subsequent lines of the configuration file. It is still the same order in which
4958 the macros were originally defined. All that changes is the macro's value.
4959 Redefinition makes it possible to accumulate values. For example:
4960 .code
4961 MAC =  initial value
4962 ...
4963 MAC == MAC and something added
4964 .endd
4965 This can be helpful in situations where the configuration file is built
4966 from a number of other files.
4967
4968 .section "Overriding macro values" "SECID44"
4969 The values set for macros in the configuration file can be overridden by the
4970 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4971 used, unless called by root or the Exim user. A definition on the command line
4972 using the &%-D%& option causes all definitions and redefinitions within the
4973 file to be ignored.
4974
4975
4976
4977 .section "Example of macro usage" "SECID45"
4978 As an example of macro usage, consider a configuration where aliases are looked
4979 up in a MySQL database. It helps to keep the file less cluttered if long
4980 strings such as SQL statements are defined separately as macros, for example:
4981 .code
4982 ALIAS_QUERY = select mailbox from user where \
4983               login='${quote_mysql:$local_part}';
4984 .endd
4985 This can then be used in a &(redirect)& router setting like this:
4986 .code
4987 data = ${lookup mysql{ALIAS_QUERY}}
4988 .endd
4989 In earlier versions of Exim macros were sometimes used for domain, host, or
4990 address lists. In Exim 4 these are handled better by named lists &-- see
4991 section &<<SECTnamedlists>>&.
4992
4993
4994 .section "Conditional skips in the configuration file" "SECID46"
4995 .cindex "configuration file" "conditional skips"
4996 .cindex "&`.ifdef`&"
4997 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4998 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4999 portions of the configuration file. The processing happens whenever the file is
5000 read (that is, when an Exim binary starts to run).
5001
5002 The implementation is very simple. Instances of the first four directives must
5003 be followed by text that includes the names of one or macros. The condition
5004 that is tested is whether or not any macro substitution has taken place in the
5005 line. Thus:
5006 .code
5007 .ifdef AAA
5008 message_size_limit = 50M
5009 .else
5010 message_size_limit = 100M
5011 .endif
5012 .endd
5013 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5014 otherwise. If there is more than one macro named on the line, the condition
5015 is true if any of them are defined. That is, it is an &"or"& condition. To
5016 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5017
5018 Although you can use a macro expansion to generate one of these directives,
5019 it is not very useful, because the condition &"there was a macro substitution
5020 in this line"& will always be true.
5021
5022 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5023 to clarify complicated nestings.
5024
5025
5026
5027 .section "Common option syntax" "SECTcos"
5028 .cindex "common option syntax"
5029 .cindex "syntax of common options"
5030 .cindex "configuration file" "common option syntax"
5031 For the main set of options, driver options, and &[local_scan()]& options,
5032 each setting is on a line by itself, and starts with a name consisting of
5033 lower-case letters and underscores. Many options require a data value, and in
5034 these cases the name must be followed by an equals sign (with optional white
5035 space) and then the value. For example:
5036 .code
5037 qualify_domain = mydomain.example.com
5038 .endd
5039 .cindex "hiding configuration option values"
5040 .cindex "configuration options" "hiding value of"
5041 .cindex "options" "hiding value of"
5042 Some option settings may contain sensitive data, for example, passwords for
5043 accessing databases. To stop non-admin users from using the &%-bP%& command
5044 line option to read these values, you can precede the option settings with the
5045 word &"hide"&. For example:
5046 .code
5047 hide mysql_servers = localhost/users/admin/secret-password
5048 .endd
5049 For non-admin users, such options are displayed like this:
5050 .code
5051 mysql_servers = <value not displayable>
5052 .endd
5053 If &"hide"& is used on a driver option, it hides the value of that option on
5054 all instances of the same driver.
5055
5056 The following sections describe the syntax used for the different data types
5057 that are found in option settings.
5058
5059
5060 .section "Boolean options" "SECID47"
5061 .cindex "format" "boolean"
5062 .cindex "boolean configuration values"
5063 .oindex "&%no_%&&'xxx'&"
5064 .oindex "&%not_%&&'xxx'&"
5065 Options whose type is given as boolean are on/off switches. There are two
5066 different ways of specifying such options: with and without a data value. If
5067 the option name is specified on its own without data, the switch is turned on;
5068 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5069 boolean options may be followed by an equals sign and one of the words
5070 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5071 the following two settings have exactly the same effect:
5072 .code
5073 queue_only
5074 queue_only = true
5075 .endd
5076 The following two lines also have the same (opposite) effect:
5077 .code
5078 no_queue_only
5079 queue_only = false
5080 .endd
5081 You can use whichever syntax you prefer.
5082
5083
5084
5085
5086 .section "Integer values" "SECID48"
5087 .cindex "integer configuration values"
5088 .cindex "format" "integer"
5089 If an option's type is given as &"integer"&, the value can be given in decimal,
5090 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5091 number is assumed. Otherwise, it is treated as an octal number unless it starts
5092 with the characters &"0x"&, in which case the remainder is interpreted as a
5093 hexadecimal number.
5094
5095 If an integer value is followed by the letter K, it is multiplied by 1024; if
5096 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5097 of integer option settings are output, values which are an exact multiple of
5098 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5099 and M. The printing style is independent of the actual input format that was
5100 used.
5101
5102
5103 .section "Octal integer values" "SECID49"
5104 .cindex "integer format"
5105 .cindex "format" "octal integer"
5106 If an option's type is given as &"octal integer"&, its value is always
5107 interpreted as an octal number, whether or not it starts with the digit zero.
5108 Such options are always output in octal.
5109
5110
5111 .section "Fixed point numbers" "SECID50"
5112 .cindex "fixed point configuration values"
5113 .cindex "format" "fixed point"
5114 If an option's type is given as &"fixed-point"&, its value must be a decimal
5115 integer, optionally followed by a decimal point and up to three further digits.
5116
5117
5118
5119 .section "Time intervals" "SECTtimeformat"
5120 .cindex "time interval" "specifying in configuration"
5121 .cindex "format" "time interval"
5122 A time interval is specified as a sequence of numbers, each followed by one of
5123 the following letters, with no intervening white space:
5124
5125 .table2 30pt
5126 .irow &%s%& seconds
5127 .irow &%m%& minutes
5128 .irow &%h%& hours
5129 .irow &%d%& days
5130 .irow &%w%& weeks
5131 .endtable
5132
5133 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5134 intervals are output in the same format. Exim does not restrict the values; it
5135 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5136
5137
5138
5139 .section "String values" "SECTstrings"
5140 .cindex "string" "format of configuration values"
5141 .cindex "format" "string"
5142 If an option's type is specified as &"string"&, the value can be specified with
5143 or without double-quotes. If it does not start with a double-quote, the value
5144 consists of the remainder of the line plus any continuation lines, starting at
5145 the first character after any leading white space, with trailing white space
5146 removed, and with no interpretation of the characters in the string. Because
5147 Exim removes comment lines (those beginning with #) at an early stage, they can
5148 appear in the middle of a multi-line string. The following two settings are
5149 therefore equivalent:
5150 .code
5151 trusted_users = uucp:mail
5152 trusted_users = uucp:\
5153                 # This comment line is ignored
5154                 mail
5155 .endd
5156 .cindex "string" "quoted"
5157 .cindex "escape characters in quoted strings"
5158 If a string does start with a double-quote, it must end with a closing
5159 double-quote, and any backslash characters other than those used for line
5160 continuation are interpreted as escape characters, as follows:
5161
5162 .table2 100pt
5163 .irow &`\\`&                     "single backslash"
5164 .irow &`\n`&                     "newline"
5165 .irow &`\r`&                     "carriage return"
5166 .irow &`\t`&                     "tab"
5167 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5168 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5169                                    character"
5170 .endtable
5171
5172 If a backslash is followed by some other character, including a double-quote
5173 character, that character replaces the pair.
5174
5175 Quoting is necessary only if you want to make use of the backslash escapes to
5176 insert special characters, or if you need to specify a value with leading or
5177 trailing spaces. These cases are rare, so quoting is almost never needed in
5178 current versions of Exim. In versions of Exim before 3.14, quoting was required
5179 in order to continue lines, so you may come across older configuration files
5180 and examples that apparently quote unnecessarily.
5181
5182
5183 .section "Expanded strings" "SECID51"
5184 .cindex "expansion" "definition of"
5185 Some strings in the configuration file are subjected to &'string expansion'&,
5186 by which means various parts of the string may be changed according to the
5187 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5188 is as just described; in particular, the handling of backslashes in quoted
5189 strings is done as part of the input process, before expansion takes place.
5190 However, backslash is also an escape character for the expander, so any
5191 backslashes that are required for that reason must be doubled if they are
5192 within a quoted configuration string.
5193
5194
5195 .section "User and group names" "SECID52"
5196 .cindex "user name" "format of"
5197 .cindex "format" "user name"
5198 .cindex "groups" "name format"
5199 .cindex "format" "group name"
5200 User and group names are specified as strings, using the syntax described
5201 above, but the strings are interpreted specially. A user or group name must
5202 either consist entirely of digits, or be a name that can be looked up using the
5203 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5204
5205
5206 .section "List construction" "SECTlistconstruct"
5207 .cindex "list" "syntax of in configuration"
5208 .cindex "format" "list item in configuration"
5209 .cindex "string" "list, definition of"
5210 The data for some configuration options is a list of items, with colon as the
5211 default separator. Many of these options are shown with type &"string list"& in
5212 the descriptions later in this document. Others are listed as &"domain list"&,
5213 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5214 are all the same; however, those other than &"string list"& are subject to
5215 particular kinds of interpretation, as described in chapter
5216 &<<CHAPdomhosaddlists>>&.
5217
5218 In all these cases, the entire list is treated as a single string as far as the
5219 input syntax is concerned. The &%trusted_users%& setting in section
5220 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5221 in a list, it must be entered as two colons. Leading and trailing white space
5222 on each item in a list is ignored. This makes it possible to include items that
5223 start with a colon, and in particular, certain forms of IPv6 address. For
5224 example, the list
5225 .code
5226 local_interfaces = 127.0.0.1 : ::::1
5227 .endd
5228 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5229
5230 &*Note*&: Although leading and trailing white space is ignored in individual
5231 list items, it is not ignored when parsing the list. The space after the first
5232 colon in the example above is necessary. If it were not there, the list would
5233 be interpreted as the two items 127.0.0.1:: and 1.
5234
5235 .section "Changing list separators" "SECID53"
5236 .cindex "list separator" "changing"
5237 .cindex "IPv6" "addresses in lists"
5238 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5239 introduced to allow the separator character to be changed. If a list begins
5240 with a left angle bracket, followed by any punctuation character, that
5241 character is used instead of colon as the list separator. For example, the list
5242 above can be rewritten to use a semicolon separator like this:
5243 .code
5244 local_interfaces = <; 127.0.0.1 ; ::1
5245 .endd
5246 This facility applies to all lists, with the exception of the list in
5247 &%log_file_path%&. It is recommended that the use of non-colon separators be
5248 confined to circumstances where they really are needed.
5249
5250 .cindex "list separator" "newline as"
5251 .cindex "newline" "as list separator"
5252 It is also possible to use newline and other control characters (those with
5253 code values less than 32, plus DEL) as separators in lists. Such separators
5254 must be provided literally at the time the list is processed. For options that
5255 are string-expanded, you can write the separator using a normal escape
5256 sequence. This will be processed by the expander before the string is
5257 interpreted as a list. For example, if a newline-separated list of domains is
5258 generated by a lookup, you can process it directly by a line such as this:
5259 .code
5260 domains = <\n ${lookup mysql{.....}}
5261 .endd
5262 This avoids having to change the list separator in such data. You are unlikely
5263 to want to use a control character as a separator in an option that is not
5264 expanded, because the value is literal text. However, it can be done by giving
5265 the value in quotes. For example:
5266 .code
5267 local_interfaces = "<\n 127.0.0.1 \n ::1"
5268 .endd
5269 Unlike printing character separators, which can be included in list items by
5270 doubling, it is not possible to include a control character as data when it is
5271 set as the separator. Two such characters in succession are interpreted as
5272 enclosing an empty list item.
5273
5274
5275
5276 .section "Empty items in lists" "SECTempitelis"
5277 .cindex "list" "empty item in"
5278 An empty item at the end of a list is always ignored. In other words, trailing
5279 separator characters are ignored. Thus, the list in
5280 .code
5281 senders = user@domain :
5282 .endd
5283 contains only a single item. If you want to include an empty string as one item
5284 in a list, it must not be the last item. For example, this list contains three
5285 items, the second of which is empty:
5286 .code
5287 senders = user1@domain : : user2@domain
5288 .endd
5289 &*Note*&: There must be white space between the two colons, as otherwise they
5290 are interpreted as representing a single colon data character (and the list
5291 would then contain just one item). If you want to specify a list that contains
5292 just one, empty item, you can do it as in this example:
5293 .code
5294 senders = :
5295 .endd
5296 In this case, the first item is empty, and the second is discarded because it
5297 is at the end of the list.
5298
5299
5300
5301
5302 .section "Format of driver configurations" "SECTfordricon"
5303 .cindex "drivers" "configuration format"
5304 There are separate parts in the configuration for defining routers, transports,
5305 and authenticators. In each part, you are defining a number of driver
5306 instances, each with its own set of options. Each driver instance is defined by
5307 a sequence of lines like this:
5308 .display
5309 <&'instance name'&>:
5310   <&'option'&>
5311   ...
5312   <&'option'&>
5313 .endd
5314 In the following example, the instance name is &(localuser)&, and it is
5315 followed by three options settings:
5316 .code
5317 localuser:
5318   driver = accept
5319   check_local_user
5320   transport = local_delivery
5321 .endd
5322 For each driver instance, you specify which Exim code module it uses &-- by the
5323 setting of the &%driver%& option &-- and (optionally) some configuration
5324 settings. For example, in the case of transports, if you want a transport to
5325 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5326 a local file you would use the &(appendfile)& driver. Each of the drivers is
5327 described in detail in its own separate chapter later in this manual.
5328
5329 You can have several routers, transports, or authenticators that are based on
5330 the same underlying driver (each must have a different instance name).
5331
5332 The order in which routers are defined is important, because addresses are
5333 passed to individual routers one by one, in order. The order in which
5334 transports are defined does not matter at all. The order in which
5335 authenticators are defined is used only when Exim, as a client, is searching
5336 them to find one that matches an authentication mechanism offered by the
5337 server.
5338
5339 .cindex "generic options"
5340 .cindex "options" "generic &-- definition of"
5341 Within a driver instance definition, there are two kinds of option: &'generic'&
5342 and &'private'&. The generic options are those that apply to all drivers of the
5343 same type (that is, all routers, all transports or all authenticators). The
5344 &%driver%& option is a generic option that must appear in every definition.
5345 .cindex "private options"
5346 The private options are special for each driver, and none need appear, because
5347 they all have default values.
5348
5349 The options may appear in any order, except that the &%driver%& option must
5350 precede any private options, since these depend on the particular driver. For
5351 this reason, it is recommended that &%driver%& always be the first option.
5352
5353 Driver instance names, which are used for reference in log entries and
5354 elsewhere, can be any sequence of letters, digits, and underscores (starting
5355 with a letter) and must be unique among drivers of the same type. A router and
5356 a transport (for example) can each have the same name, but no two router
5357 instances can have the same name. The name of a driver instance should not be
5358 confused with the name of the underlying driver module. For example, the
5359 configuration lines:
5360 .code
5361 remote_smtp:
5362   driver = smtp
5363 .endd
5364 create an instance of the &(smtp)& transport driver whose name is
5365 &(remote_smtp)&. The same driver code can be used more than once, with
5366 different instance names and different option settings each time. A second
5367 instance of the &(smtp)& transport, with different options, might be defined
5368 thus:
5369 .code
5370 special_smtp:
5371   driver = smtp
5372   port = 1234
5373   command_timeout = 10s
5374 .endd
5375 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5376 these transport instances from routers, and these names would appear in log
5377 lines.
5378
5379 Comment lines may be present in the middle of driver specifications. The full
5380 list of option settings for any particular driver instance, including all the
5381 defaulted values, can be extracted by making use of the &%-bP%& command line
5382 option.
5383
5384
5385
5386
5387
5388
5389 . ////////////////////////////////////////////////////////////////////////////
5390 . ////////////////////////////////////////////////////////////////////////////
5391
5392 .chapter "The default configuration file" "CHAPdefconfil"
5393 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5394 .cindex "default" "configuration file &""walk through""&"
5395 The default configuration file supplied with Exim as &_src/configure.default_&
5396 is sufficient for a host with simple mail requirements. As an introduction to
5397 the way Exim is configured, this chapter &"walks through"& the default
5398 configuration, giving brief explanations of the settings. Detailed descriptions
5399 of the options are given in subsequent chapters. The default configuration file
5400 itself contains extensive comments about ways you might want to modify the
5401 initial settings. However, note that there are many options that are not
5402 mentioned at all in the default configuration.
5403
5404
5405
5406 .section "Main configuration settings" "SECTdefconfmain"
5407 The main (global) configuration option settings must always come first in the
5408 file. The first thing you'll see in the file, after some initial comments, is
5409 the line
5410 .code
5411 # primary_hostname =
5412 .endd
5413 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5414 to know the official, fully qualified name of your host, and this is where you
5415 can specify it. However, in most cases you do not need to set this option. When
5416 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5417
5418 The first three non-comment configuration lines are as follows:
5419 .code
5420 domainlist local_domains    = @
5421 domainlist relay_to_domains =
5422 hostlist   relay_from_hosts = 127.0.0.1
5423 .endd
5424 These are not, in fact, option settings. They are definitions of two named
5425 domain lists and one named host list. Exim allows you to give names to lists of
5426 domains, hosts, and email addresses, in order to make it easier to manage the
5427 configuration file (see section &<<SECTnamedlists>>&).
5428
5429 The first line defines a domain list called &'local_domains'&; this is used
5430 later in the configuration to identify domains that are to be delivered
5431 on the local host.
5432
5433 .cindex "@ in a domain list"
5434 There is just one item in this list, the string &"@"&. This is a special form
5435 of entry which means &"the name of the local host"&. Thus, if the local host is
5436 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5437 be delivered locally. Because the local host's name is referenced indirectly,
5438 the same configuration file can be used on different hosts.
5439
5440 The second line defines a domain list called &'relay_to_domains'&, but the
5441 list itself is empty. Later in the configuration we will come to the part that
5442 controls mail relaying through the local host; it allows relaying to any
5443 domains in this list. By default, therefore, no relaying on the basis of a mail
5444 domain is permitted.
5445
5446 The third line defines a host list called &'relay_from_hosts'&. This list is
5447 used later in the configuration to permit relaying from any host or IP address
5448 that matches the list. The default contains just the IP address of the IPv4
5449 loopback interface, which means that processes on the local host are able to
5450 submit mail for relaying by sending it over TCP/IP to that interface. No other
5451 hosts are permitted to submit messages for relaying.
5452
5453 Just to be sure there's no misunderstanding: at this point in the configuration
5454 we aren't actually setting up any controls. We are just defining some domains
5455 and hosts that will be used in the controls that are specified later.
5456
5457 The next two configuration lines are genuine option settings:
5458 .code
5459 acl_smtp_rcpt = acl_check_rcpt
5460 acl_smtp_data = acl_check_data
5461 .endd
5462 These options specify &'Access Control Lists'& (ACLs) that are to be used
5463 during an incoming SMTP session for every recipient of a message (every RCPT
5464 command), and after the contents of the message have been received,
5465 respectively. The names of the lists are &'acl_check_rcpt'& and
5466 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5467 section of the configuration. The RCPT ACL controls which recipients are
5468 accepted for an incoming message &-- if a configuration does not provide an ACL
5469 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5470 contents of a message to be checked.
5471
5472 Two commented-out option settings are next:
5473 .code
5474 # av_scanner = clamd:/tmp/clamd
5475 # spamd_address = 127.0.0.1 783
5476 .endd
5477 These are example settings that can be used when Exim is compiled with the
5478 content-scanning extension. The first specifies the interface to the virus
5479 scanner, and the second specifies the interface to SpamAssassin. Further
5480 details are given in chapter &<<CHAPexiscan>>&.
5481
5482 Three more commented-out option settings follow:
5483 .code
5484 # tls_advertise_hosts = *
5485 # tls_certificate = /etc/ssl/exim.crt
5486 # tls_privatekey = /etc/ssl/exim.pem
5487 .endd
5488 These are example settings that can be used when Exim is compiled with
5489 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5490 first one specifies the list of clients that are allowed to use TLS when
5491 connecting to this server; in this case the wildcard means all clients. The
5492 other options specify where Exim should find its TLS certificate and private
5493 key, which together prove the server's identity to any clients that connect.
5494 More details are given in chapter &<<CHAPTLS>>&.
5495
5496 Another two commented-out option settings follow:
5497 .code
5498 # daemon_smtp_ports = 25 : 465 : 587
5499 # tls_on_connect_ports = 465
5500 .endd
5501 .cindex "port" "465 and 587"
5502 .cindex "port" "for message submission"
5503 .cindex "message" "submission, ports for"
5504 .cindex "ssmtp protocol"
5505 .cindex "smtps protocol"
5506 .cindex "SMTP" "ssmtp protocol"
5507 .cindex "SMTP" "smtps protocol"
5508 These options provide better support for roaming users who wish to use this
5509 server for message submission. They are not much use unless you have turned on
5510 TLS (as described in the previous paragraph) and authentication (about which
5511 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5512 on end-user networks, so RFC 4409 specifies that message submission should use
5513 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5514 configured to use port 587 correctly, so these settings also enable the
5515 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5516 &<<SECTsupobssmt>>&).
5517
5518 Two more commented-out options settings follow:
5519 .code
5520 # qualify_domain =
5521 # qualify_recipient =
5522 .endd
5523 The first of these specifies a domain that Exim uses when it constructs a
5524 complete email address from a local login name. This is often needed when Exim
5525 receives a message from a local process. If you do not set &%qualify_domain%&,
5526 the value of &%primary_hostname%& is used. If you set both of these options,
5527 you can have different qualification domains for sender and recipient
5528 addresses. If you set only the first one, its value is used in both cases.
5529
5530 .cindex "domain literal" "recognizing format"
5531 The following line must be uncommented if you want Exim to recognize
5532 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5533 (an IP address within square brackets) instead of a named domain.
5534 .code
5535 # allow_domain_literals
5536 .endd
5537 The RFCs still require this form, but many people think that in the modern
5538 Internet it makes little sense to permit mail to be sent to specific hosts by
5539 quoting their IP addresses. This ancient format has been used by people who
5540 try to abuse hosts by using them for unwanted relaying. However, some
5541 people believe there are circumstances (for example, messages addressed to
5542 &'postmaster'&) where domain literals are still useful.
5543
5544 The next configuration line is a kind of trigger guard:
5545 .code
5546 never_users = root
5547 .endd
5548 It specifies that no delivery must ever be run as the root user. The normal
5549 convention is to set up &'root'& as an alias for the system administrator. This
5550 setting is a guard against slips in the configuration.
5551 The list of users specified by &%never_users%& is not, however, the complete
5552 list; the build-time configuration in &_Local/Makefile_& has an option called
5553 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5554 contents of &%never_users%& are added to this list. By default
5555 FIXED_NEVER_USERS also specifies root.
5556
5557 When a remote host connects to Exim in order to send mail, the only information
5558 Exim has about the host's identity is its IP address. The next configuration
5559 line,
5560 .code
5561 host_lookup = *
5562 .endd
5563 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5564 in order to get a host name. This improves the quality of the logging
5565 information, but if you feel it is too expensive, you can remove it entirely,
5566 or restrict the lookup to hosts on &"nearby"& networks.
5567 Note that it is not always possible to find a host name from an IP address,
5568 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5569 unreachable.
5570
5571 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5572 1413 (hence their names):
5573 .code
5574 rfc1413_hosts = *
5575 rfc1413_query_timeout = 0s
5576 .endd
5577 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5578 Few hosts offer RFC1413 service these days; calls have to be
5579 terminated by a timeout and this needlessly delays the startup
5580 of an incoming SMTP connection.
5581 If you have hosts for which you trust RFC1413 and need this
5582 information, you can change this.
5583
5584 This line enables an efficiency SMTP option.  It is negotiated by clients
5585 and not expected to cause problems but can be disabled if needed.
5586 .code
5587 prdr_enable = true
5588 .endd
5589
5590 When Exim receives messages over SMTP connections, it expects all addresses to
5591 be fully qualified with a domain, as required by the SMTP definition. However,
5592 if you are running a server to which simple clients submit messages, you may
5593 find that they send unqualified addresses. The two commented-out options:
5594 .code
5595 # sender_unqualified_hosts =
5596 # recipient_unqualified_hosts =
5597 .endd
5598 show how you can specify hosts that are permitted to send unqualified sender
5599 and recipient addresses, respectively.
5600
5601 The &%percent_hack_domains%& option is also commented out:
5602 .code
5603 # percent_hack_domains =
5604 .endd
5605 It provides a list of domains for which the &"percent hack"& is to operate.
5606 This is an almost obsolete form of explicit email routing. If you do not know
5607 anything about it, you can safely ignore this topic.
5608
5609 The last two settings in the main part of the default configuration are
5610 concerned with messages that have been &"frozen"& on Exim's queue. When a
5611 message is frozen, Exim no longer continues to try to deliver it. Freezing
5612 occurs when a bounce message encounters a permanent failure because the sender
5613 address of the original message that caused the bounce is invalid, so the
5614 bounce cannot be delivered. This is probably the most common case, but there
5615 are also other conditions that cause freezing, and frozen messages are not
5616 always bounce messages.
5617 .code
5618 ignore_bounce_errors_after = 2d
5619 timeout_frozen_after = 7d
5620 .endd
5621 The first of these options specifies that failing bounce messages are to be
5622 discarded after 2 days on the queue. The second specifies that any frozen
5623 message (whether a bounce message or not) is to be timed out (and discarded)
5624 after a week. In this configuration, the first setting ensures that no failing
5625 bounce message ever lasts a week.
5626
5627
5628
5629 .section "ACL configuration" "SECID54"
5630 .cindex "default" "ACLs"
5631 .cindex "&ACL;" "default configuration"
5632 In the default configuration, the ACL section follows the main configuration.
5633 It starts with the line
5634 .code
5635 begin acl
5636 .endd
5637 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5638 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5639 and &%acl_smtp_data%& above.
5640
5641 .cindex "RCPT" "ACL for"
5642 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5643 RCPT command specifies one of the message's recipients. The ACL statements
5644 are considered in order, until the recipient address is either accepted or
5645 rejected. The RCPT command is then accepted or rejected, according to the
5646 result of the ACL processing.
5647 .code
5648 acl_check_rcpt:
5649 .endd
5650 This line, consisting of a name terminated by a colon, marks the start of the
5651 ACL, and names it.
5652 .code
5653 accept  hosts = :
5654 .endd
5655 This ACL statement accepts the recipient if the sending host matches the list.
5656 But what does that strange list mean? It doesn't actually contain any host
5657 names or IP addresses. The presence of the colon puts an empty item in the
5658 list; Exim matches this only if the incoming message did not come from a remote
5659 host, because in that case, the remote hostname is empty. The colon is
5660 important. Without it, the list itself is empty, and can never match anything.
5661
5662 What this statement is doing is to accept unconditionally all recipients in
5663 messages that are submitted by SMTP from local processes using the standard
5664 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5665 manner.
5666 .code
5667 deny    message       = Restricted characters in address
5668         domains       = +local_domains
5669         local_parts   = ^[.] : ^.*[@%!/|]
5670
5671 deny    message       = Restricted characters in address
5672         domains       = !+local_domains
5673         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5674 .endd
5675 These statements are concerned with local parts that contain any of the
5676 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5677 Although these characters are entirely legal in local parts (in the case of
5678 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5679 in Internet mail addresses.
5680
5681 The first three have in the past been associated with explicitly routed
5682 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5683 option). Addresses containing these characters are regularly tried by spammers
5684 in an attempt to bypass relaying restrictions, and also by open relay testing
5685 programs. Unless you really need them it is safest to reject these characters
5686 at this early stage. This configuration is heavy-handed in rejecting these
5687 characters for all messages it accepts from remote hosts. This is a deliberate
5688 policy of being as safe as possible.
5689
5690 The first rule above is stricter, and is applied to messages that are addressed
5691 to one of the local domains handled by this host. This is implemented by the
5692 first condition, which restricts it to domains that are listed in the
5693 &'local_domains'& domain list. The &"+"& character is used to indicate a
5694 reference to a named list. In this configuration, there is just one domain in
5695 &'local_domains'&, but in general there may be many.
5696
5697 The second condition on the first statement uses two regular expressions to
5698 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5699 or &"|"&. If you have local accounts that include these characters, you will
5700 have to modify this rule.
5701
5702 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5703 allows them because they have been encountered in practice. (Consider the
5704 common convention of local parts constructed as
5705 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5706 the author of Exim, who has no second initial.) However, a local part starting
5707 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5708 file name (for example, for a mailing list). This is also true for local parts
5709 that contain slashes. A pipe symbol can also be troublesome if the local part
5710 is incorporated unthinkingly into a shell command line.
5711
5712 The second rule above applies to all other domains, and is less strict. This
5713 allows your own users to send outgoing messages to sites that use slashes
5714 and vertical bars in their local parts. It blocks local parts that begin
5715 with a dot, slash, or vertical bar, but allows these characters within the
5716 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5717 and &"!"& is blocked, as before. The motivation here is to prevent your users
5718 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5719 .code
5720 accept  local_parts   = postmaster
5721         domains       = +local_domains
5722 .endd
5723 This statement, which has two conditions, accepts an incoming address if the
5724 local part is &'postmaster'& and the domain is one of those listed in the
5725 &'local_domains'& domain list. The &"+"& character is used to indicate a
5726 reference to a named list. In this configuration, there is just one domain in
5727 &'local_domains'&, but in general there may be many.
5728
5729 The presence of this statement means that mail to postmaster is never blocked
5730 by any of the subsequent tests. This can be helpful while sorting out problems
5731 in cases where the subsequent tests are incorrectly denying access.
5732 .code
5733 require verify        = sender
5734 .endd
5735 This statement requires the sender address to be verified before any subsequent
5736 ACL statement can be used. If verification fails, the incoming recipient
5737 address is refused. Verification consists of trying to route the address, to
5738 see if a bounce message could be delivered to it. In the case of remote
5739 addresses, basic verification checks only the domain, but &'callouts'& can be
5740 used for more verification if required. Section &<<SECTaddressverification>>&
5741 discusses the details of address verification.
5742 .code
5743 accept  hosts         = +relay_from_hosts
5744         control       = submission
5745 .endd
5746 This statement accepts the address if the message is coming from one of the
5747 hosts that are defined as being allowed to relay through this host. Recipient
5748 verification is omitted here, because in many cases the clients are dumb MUAs
5749 that do not cope well with SMTP error responses. For the same reason, the
5750 second line specifies &"submission mode"& for messages that are accepted. This
5751 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5752 messages that are deficient in some way, for example, because they lack a
5753 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5754 probably add recipient verification here, and disable submission mode.
5755 .code
5756 accept  authenticated = *
5757         control       = submission
5758 .endd
5759 This statement accepts the address if the client host has authenticated itself.
5760 Submission mode is again specified, on the grounds that such messages are most
5761 likely to come from MUAs. The default configuration does not define any
5762 authenticators, though it does include some nearly complete commented-out
5763 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5764 fact authenticate until you complete the authenticator definitions.
5765 .code
5766 require message = relay not permitted
5767         domains = +local_domains : +relay_to_domains
5768 .endd
5769 This statement rejects the address if its domain is neither a local domain nor
5770 one of the domains for which this host is a relay.
5771 .code
5772 require verify = recipient
5773 .endd
5774 This statement requires the recipient address to be verified; if verification
5775 fails, the address is rejected.
5776 .code
5777 # deny    message     = rejected because $sender_host_address \
5778 #                       is in a black list at $dnslist_domain\n\
5779 #                       $dnslist_text
5780 #         dnslists    = black.list.example
5781 #
5782 # warn    dnslists    = black.list.example
5783 #         add_header  = X-Warning: $sender_host_address is in \
5784 #                       a black list at $dnslist_domain
5785 #         log_message = found in $dnslist_domain
5786 .endd
5787 These commented-out lines are examples of how you could configure Exim to check
5788 sending hosts against a DNS black list. The first statement rejects messages
5789 from blacklisted hosts, whereas the second just inserts a warning header
5790 line.
5791 .code
5792 # require verify = csa
5793 .endd
5794 This commented-out line is an example of how you could turn on client SMTP
5795 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5796 records.
5797 .code
5798 accept
5799 .endd
5800 The final statement in the first ACL unconditionally accepts any recipient
5801 address that has successfully passed all the previous tests.
5802 .code
5803 acl_check_data:
5804 .endd
5805 This line marks the start of the second ACL, and names it. Most of the contents
5806 of this ACL are commented out:
5807 .code
5808 # deny    malware   = *
5809 #         message   = This message contains a virus \
5810 #                     ($malware_name).
5811 .endd
5812 These lines are examples of how to arrange for messages to be scanned for
5813 viruses when Exim has been compiled with the content-scanning extension, and a
5814 suitable virus scanner is installed. If the message is found to contain a
5815 virus, it is rejected with the given custom error message.
5816 .code
5817 # warn    spam      = nobody
5818 #         message   = X-Spam_score: $spam_score\n\
5819 #                     X-Spam_score_int: $spam_score_int\n\
5820 #                     X-Spam_bar: $spam_bar\n\
5821 #                     X-Spam_report: $spam_report
5822 .endd
5823 These lines are an example of how to arrange for messages to be scanned by
5824 SpamAssassin when Exim has been compiled with the content-scanning extension,
5825 and SpamAssassin has been installed. The SpamAssassin check is run with
5826 &`nobody`& as its user parameter, and the results are added to the message as a
5827 series of extra header line. In this case, the message is not rejected,
5828 whatever the spam score.
5829 .code
5830 accept
5831 .endd
5832 This final line in the DATA ACL accepts the message unconditionally.
5833
5834
5835 .section "Router configuration" "SECID55"
5836 .cindex "default" "routers"
5837 .cindex "routers" "default"
5838 The router configuration comes next in the default configuration, introduced
5839 by the line
5840 .code
5841 begin routers
5842 .endd
5843 Routers are the modules in Exim that make decisions about where to send
5844 messages. An address is passed to each router in turn, until it is either
5845 accepted, or failed. This means that the order in which you define the routers
5846 matters. Each router is fully described in its own chapter later in this
5847 manual. Here we give only brief overviews.
5848 .code
5849 # domain_literal:
5850 #   driver = ipliteral
5851 #   domains = !+local_domains
5852 #   transport = remote_smtp
5853 .endd
5854 .cindex "domain literal" "default router"
5855 This router is commented out because the majority of sites do not want to
5856 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5857 you uncomment this router, you also need to uncomment the setting of
5858 &%allow_domain_literals%& in the main part of the configuration.
5859 .code
5860 dnslookup:
5861   driver = dnslookup
5862   domains = ! +local_domains
5863   transport = remote_smtp
5864   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5865   no_more
5866 .endd
5867 The first uncommented router handles addresses that do not involve any local
5868 domains. This is specified by the line
5869 .code
5870 domains = ! +local_domains
5871 .endd
5872 The &%domains%& option lists the domains to which this router applies, but the
5873 exclamation mark is a negation sign, so the router is used only for domains
5874 that are not in the domain list called &'local_domains'& (which was defined at
5875 the start of the configuration). The plus sign before &'local_domains'&
5876 indicates that it is referring to a named list. Addresses in other domains are
5877 passed on to the following routers.
5878
5879 The name of the router driver is &(dnslookup)&,
5880 and is specified by the &%driver%& option. Do not be confused by the fact that
5881 the name of this router instance is the same as the name of the driver. The
5882 instance name is arbitrary, but the name set in the &%driver%& option must be
5883 one of the driver modules that is in the Exim binary.
5884
5885 The &(dnslookup)& router routes addresses by looking up their domains in the
5886 DNS in order to obtain a list of hosts to which the address is routed. If the
5887 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5888 specified by the &%transport%& option. If the router does not find the domain
5889 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5890 the address fails and is bounced.
5891
5892 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5893 be entirely ignored. This option is present because a number of cases have been
5894 encountered where MX records in the DNS point to host names
5895 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5896 Completely ignoring these IP addresses causes Exim to fail to route the
5897 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5898 continue to try to deliver the message periodically until the address timed
5899 out.
5900 .code
5901 system_aliases:
5902   driver = redirect
5903   allow_fail
5904   allow_defer
5905   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5906 # user = exim
5907   file_transport = address_file
5908   pipe_transport = address_pipe
5909 .endd
5910 Control reaches this and subsequent routers only for addresses in the local
5911 domains. This router checks to see whether the local part is defined as an
5912 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5913 data that it looks up from that file. If no data is found for the local part,
5914 the value of the &%data%& option is empty, causing the address to be passed to
5915 the next router.
5916
5917 &_/etc/aliases_& is a conventional name for the system aliases file that is
5918 often used. That is why it is referenced by from the default configuration
5919 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5920 &_Local/Makefile_& before building Exim.
5921 .code
5922 userforward:
5923   driver = redirect
5924   check_local_user
5925 # local_part_suffix = +* : -*
5926 # local_part_suffix_optional
5927   file = $home/.forward
5928 # allow_filter
5929   no_verify
5930   no_expn
5931   check_ancestor
5932   file_transport = address_file
5933   pipe_transport = address_pipe
5934   reply_transport = address_reply
5935 .endd
5936 This is the most complicated router in the default configuration. It is another
5937 redirection router, but this time it is looking for forwarding data set up by
5938 individual users. The &%check_local_user%& setting specifies a check that the
5939 local part of the address is the login name of a local user. If it is not, the
5940 router is skipped. The two commented options that follow &%check_local_user%&,
5941 namely:
5942 .code
5943 # local_part_suffix = +* : -*
5944 # local_part_suffix_optional
5945 .endd
5946 .vindex "&$local_part_suffix$&"
5947 show how you can specify the recognition of local part suffixes. If the first
5948 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5949 by any sequence of characters, is removed from the local part and placed in the
5950 variable &$local_part_suffix$&. The second suffix option specifies that the
5951 presence of a suffix in the local part is optional. When a suffix is present,
5952 the check for a local login uses the local part with the suffix removed.
5953
5954 When a local user account is found, the file called &_.forward_& in the user's
5955 home directory is consulted. If it does not exist, or is empty, the router
5956 declines. Otherwise, the contents of &_.forward_& are interpreted as
5957 redirection data (see chapter &<<CHAPredirect>>& for more details).
5958
5959 .cindex "Sieve filter" "enabling in default router"
5960 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5961 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5962 is commented out by default), the contents of the file are interpreted as a set
5963 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5964 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5965 separate document entitled &'Exim's interfaces to mail filtering'&.
5966
5967 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5968 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5969 There are two reasons for doing this:
5970
5971 .olist
5972 Whether or not a local user has a &_.forward_& file is not really relevant when
5973 checking an address for validity; it makes sense not to waste resources doing
5974 unnecessary work.
5975 .next
5976 More importantly, when Exim is verifying addresses or handling an EXPN
5977 command during an SMTP session, it is running as the Exim user, not as root.
5978 The group is the Exim group, and no additional groups are set up.
5979 It may therefore not be possible for Exim to read users' &_.forward_& files at
5980 this time.
5981 .endlist
5982
5983 The setting of &%check_ancestor%& prevents the router from generating a new
5984 address that is the same as any previous address that was redirected. (This
5985 works round a problem concerning a bad interaction between aliasing and
5986 forwarding &-- see section &<<SECTredlocmai>>&).
5987
5988 The final three option settings specify the transports that are to be used when
5989 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5990 auto-reply, respectively. For example, if a &_.forward_& file contains
5991 .code
5992 a.nother@elsewhere.example, /home/spqr/archive
5993 .endd
5994 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5995 transport.
5996 .code
5997 localuser:
5998   driver = accept
5999   check_local_user
6000 # local_part_suffix = +* : -*
6001 # local_part_suffix_optional
6002   transport = local_delivery
6003 .endd
6004 The final router sets up delivery into local mailboxes, provided that the local
6005 part is the name of a local login, by accepting the address and assigning it to
6006 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6007 routers, so the address is bounced. The commented suffix settings fulfil the
6008 same purpose as they do for the &(userforward)& router.
6009
6010
6011 .section "Transport configuration" "SECID56"
6012 .cindex "default" "transports"
6013 .cindex "transports" "default"
6014 Transports define mechanisms for actually delivering messages. They operate
6015 only when referenced from routers, so the order in which they are defined does
6016 not matter. The transports section of the configuration starts with
6017 .code
6018 begin transports
6019 .endd
6020 One remote transport and four local transports are defined.
6021 .code
6022 remote_smtp:
6023   driver = smtp
6024   hosts_try_prdr = *
6025 .endd
6026 This transport is used for delivering messages over SMTP connections.
6027 The list of remote hosts comes from the router.
6028 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6029 It is negotiated between client and server
6030 and not expected to cause problems but can be disabled if needed.
6031 All other options are defaulted.
6032 .code
6033 local_delivery:
6034   driver = appendfile
6035   file = /var/mail/$local_part
6036   delivery_date_add
6037   envelope_to_add
6038   return_path_add
6039 # group = mail
6040 # mode = 0660
6041 .endd
6042 This &(appendfile)& transport is used for local delivery to user mailboxes in
6043 traditional BSD mailbox format. By default it runs under the uid and gid of the
6044 local user, which requires the sticky bit to be set on the &_/var/mail_&
6045 directory. Some systems use the alternative approach of running mail deliveries
6046 under a particular group instead of using the sticky bit. The commented options
6047 show how this can be done.
6048
6049 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6050 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6051 similarly-named options above.
6052 .code
6053 address_pipe:
6054   driver = pipe
6055   return_output
6056 .endd
6057 This transport is used for handling deliveries to pipes that are generated by
6058 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6059 option specifies that any output generated by the pipe is to be returned to the
6060 sender.
6061 .code
6062 address_file:
6063   driver = appendfile
6064   delivery_date_add
6065   envelope_to_add
6066   return_path_add
6067 .endd
6068 This transport is used for handling deliveries to files that are generated by
6069 redirection. The name of the file is not specified in this instance of
6070 &(appendfile)&, because it comes from the &(redirect)& router.
6071 .code
6072 address_reply:
6073   driver = autoreply
6074 .endd
6075 This transport is used for handling automatic replies generated by users'
6076 filter files.
6077
6078
6079
6080 .section "Default retry rule" "SECID57"
6081 .cindex "retry" "default rule"
6082 .cindex "default" "retry rule"
6083 The retry section of the configuration file contains rules which affect the way
6084 Exim retries deliveries that cannot be completed at the first attempt. It is
6085 introduced by the line
6086 .code
6087 begin retry
6088 .endd
6089 In the default configuration, there is just one rule, which applies to all
6090 errors:
6091 .code
6092 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6093 .endd
6094 This causes any temporarily failing address to be retried every 15 minutes for
6095 2 hours, then at intervals starting at one hour and increasing by a factor of
6096 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6097 is not delivered after 4 days of temporary failure, it is bounced.
6098
6099 If the retry section is removed from the configuration, or is empty (that is,
6100 if no retry rules are defined), Exim will not retry deliveries. This turns
6101 temporary errors into permanent errors.
6102
6103
6104 .section "Rewriting configuration" "SECID58"
6105 The rewriting section of the configuration, introduced by
6106 .code
6107 begin rewrite
6108 .endd
6109 contains rules for rewriting addresses in messages as they arrive. There are no
6110 rewriting rules in the default configuration file.
6111
6112
6113
6114 .section "Authenticators configuration" "SECTdefconfauth"
6115 .cindex "AUTH" "configuration"
6116 The authenticators section of the configuration, introduced by
6117 .code
6118 begin authenticators
6119 .endd
6120 defines mechanisms for the use of the SMTP AUTH command. The default
6121 configuration file contains two commented-out example authenticators
6122 which support plaintext username/password authentication using the
6123 standard PLAIN mechanism and the traditional but non-standard LOGIN
6124 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6125 to support most MUA software.
6126
6127 The example PLAIN authenticator looks like this:
6128 .code
6129 #PLAIN:
6130 #  driver                  = plaintext
6131 #  server_set_id           = $auth2
6132 #  server_prompts          = :
6133 #  server_condition        = Authentication is not yet configured
6134 #  server_advertise_condition = ${if def:tls_in_cipher }
6135 .endd
6136 And the example LOGIN authenticator looks like this:
6137 .code
6138 #LOGIN:
6139 #  driver                  = plaintext
6140 #  server_set_id           = $auth1
6141 #  server_prompts          = <| Username: | Password:
6142 #  server_condition        = Authentication is not yet configured
6143 #  server_advertise_condition = ${if def:tls_in_cipher }
6144 .endd
6145
6146 The &%server_set_id%& option makes Exim remember the authenticated username
6147 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6148 &%server_prompts%& option configures the &(plaintext)& authenticator so
6149 that it implements the details of the specific authentication mechanism,
6150 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6151 when Exim offers authentication to clients; in the examples, this is only
6152 when TLS or SSL has been started, so to enable the authenticators you also
6153 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6154
6155 The &%server_condition%& setting defines how to verify that the username and
6156 password are correct. In the examples it just produces an error message.
6157 To make the authenticators work, you can use a string expansion
6158 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6159
6160 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6161 usercode and password are in different positions.
6162 Chapter &<<CHAPplaintext>>& covers both.
6163
6164 .ecindex IIDconfiwal
6165
6166
6167
6168 . ////////////////////////////////////////////////////////////////////////////
6169 . ////////////////////////////////////////////////////////////////////////////
6170
6171 .chapter "Regular expressions" "CHAPregexp"
6172
6173 .cindex "regular expressions" "library"
6174 .cindex "PCRE"
6175 Exim supports the use of regular expressions in many of its options. It
6176 uses the PCRE regular expression library; this provides regular expression
6177 matching that is compatible with Perl 5. The syntax and semantics of
6178 regular expressions is discussed in many Perl reference books, and also in
6179 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6180 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6181
6182 The documentation for the syntax and semantics of the regular expressions that
6183 are supported by PCRE is included in the PCRE distribution, and no further
6184 description is included here. The PCRE functions are called from Exim using
6185 the default option settings (that is, with no PCRE options set), except that
6186 the PCRE_CASELESS option is set when the matching is required to be
6187 case-insensitive.
6188
6189 In most cases, when a regular expression is required in an Exim configuration,
6190 it has to start with a circumflex, in order to distinguish it from plain text
6191 or an &"ends with"& wildcard. In this example of a configuration setting, the
6192 second item in the colon-separated list is a regular expression.
6193 .code
6194 domains = a.b.c : ^\\d{3} : *.y.z : ...
6195 .endd
6196 The doubling of the backslash is required because of string expansion that
6197 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6198 of this issue, and a way of avoiding the need for doubling backslashes. The
6199 regular expression that is eventually used in this example contains just one
6200 backslash. The circumflex is included in the regular expression, and has the
6201 normal effect of &"anchoring"& it to the start of the string that is being
6202 matched.
6203
6204 There are, however, two cases where a circumflex is not required for the
6205 recognition of a regular expression: these are the &%match%& condition in a
6206 string expansion, and the &%matches%& condition in an Exim filter file. In
6207 these cases, the relevant string is always treated as a regular expression; if
6208 it does not start with a circumflex, the expression is not anchored, and can
6209 match anywhere in the subject string.
6210
6211 In all cases, if you want a regular expression to match at the end of a string,
6212 you must code the $ metacharacter to indicate this. For example:
6213 .code
6214 domains = ^\\d{3}\\.example
6215 .endd
6216 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6217 You need to use:
6218 .code
6219 domains = ^\\d{3}\\.example\$
6220 .endd
6221 if you want &'example'& to be the top-level domain. The backslash before the
6222 $ is needed because string expansion also interprets dollar characters.
6223
6224
6225
6226 . ////////////////////////////////////////////////////////////////////////////
6227 . ////////////////////////////////////////////////////////////////////////////
6228
6229 .chapter "File and database lookups" "CHAPfdlookup"
6230 .scindex IIDfidalo1 "file" "lookups"
6231 .scindex IIDfidalo2 "database" "lookups"
6232 .cindex "lookup" "description of"
6233 Exim can be configured to look up data in files or databases as it processes
6234 messages. Two different kinds of syntax are used:
6235
6236 .olist
6237 A string that is to be expanded may contain explicit lookup requests. These
6238 cause parts of the string to be replaced by data that is obtained from the
6239 lookup. Lookups of this type are conditional expansion items. Different results
6240 can be defined for the cases of lookup success and failure. See chapter
6241 &<<CHAPexpand>>&, where string expansions are described in detail.
6242 .next
6243 Lists of domains, hosts, and email addresses can contain lookup requests as a
6244 way of avoiding excessively long linear lists. In this case, the data that is
6245 returned by the lookup is often (but not always) discarded; whether the lookup
6246 succeeds or fails is what really counts. These kinds of list are described in
6247 chapter &<<CHAPdomhosaddlists>>&.
6248 .endlist
6249
6250 String expansions, lists, and lookups interact with each other in such a way
6251 that there is no order in which to describe any one of them that does not
6252 involve references to the others. Each of these three chapters makes more sense
6253 if you have read the other two first. If you are reading this for the first
6254 time, be aware that some of it will make a lot more sense after you have read
6255 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6256
6257 .section "Examples of different lookup syntax" "SECID60"
6258 It is easy to confuse the two different kinds of lookup, especially as the
6259 lists that may contain the second kind are always expanded before being
6260 processed as lists. Therefore, they may also contain lookups of the first kind.
6261 Be careful to distinguish between the following two examples:
6262 .code
6263 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6264 domains = lsearch;/some/file
6265 .endd
6266 The first uses a string expansion, the result of which must be a domain list.
6267 No strings have been specified for a successful or a failing lookup; the
6268 defaults in this case are the looked-up data and an empty string, respectively.
6269 The expansion takes place before the string is processed as a list, and the
6270 file that is searched could contain lines like this:
6271 .code
6272 192.168.3.4: domain1:domain2:...
6273 192.168.1.9: domain3:domain4:...
6274 .endd
6275 When the lookup succeeds, the result of the expansion is a list of domains (and
6276 possibly other types of item that are allowed in domain lists).
6277
6278 In the second example, the lookup is a single item in a domain list. It causes
6279 Exim to use a lookup to see if the domain that is being processed can be found
6280 in the file. The file could contains lines like this:
6281 .code
6282 domain1:
6283 domain2:
6284 .endd
6285 Any data that follows the keys is not relevant when checking that the domain
6286 matches the list item.
6287
6288 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6289 Consider a file containing lines like this:
6290 .code
6291 192.168.5.6: lsearch;/another/file
6292 .endd
6293 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6294 first &%domains%& setting above generates the second setting, which therefore
6295 causes a second lookup to occur.
6296
6297 The rest of this chapter describes the different lookup types that are
6298 available. Any of them can be used in any part of the configuration where a
6299 lookup is permitted.
6300
6301
6302 .section "Lookup types" "SECID61"
6303 .cindex "lookup" "types of"
6304 .cindex "single-key lookup" "definition of"
6305 Two different types of data lookup are implemented:
6306
6307 .ilist
6308 The &'single-key'& type requires the specification of a file in which to look,
6309 and a single key to search for. The key must be a non-empty string for the
6310 lookup to succeed. The lookup type determines how the file is searched.
6311 .next
6312 .cindex "query-style lookup" "definition of"
6313 The &'query-style'& type accepts a generalized database query. No particular
6314 key value is assumed by Exim for query-style lookups. You can use whichever
6315 Exim variables you need to construct the database query.
6316 .endlist
6317
6318 The code for each lookup type is in a separate source file that is included in
6319 the binary of Exim only if the corresponding compile-time option is set. The
6320 default settings in &_src/EDITME_& are:
6321 .code
6322 LOOKUP_DBM=yes
6323 LOOKUP_LSEARCH=yes
6324 .endd
6325 which means that only linear searching and DBM lookups are included by default.
6326 For some types of lookup (e.g. SQL databases), you need to install appropriate
6327 libraries and header files before building Exim.
6328
6329
6330
6331
6332 .section "Single-key lookup types" "SECTsinglekeylookups"
6333 .cindex "lookup" "single-key types"
6334 .cindex "single-key lookup" "list of types"
6335 The following single-key lookup types are implemented:
6336
6337 .ilist
6338 .cindex "cdb" "description of"
6339 .cindex "lookup" "cdb"
6340 .cindex "binary zero" "in lookup key"
6341 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6342 string without a terminating binary zero. The cdb format is designed for
6343 indexed files that are read frequently and never updated, except by total
6344 re-creation. As such, it is particularly suitable for large files containing
6345 aliases or other indexed data referenced by an MTA. Information about cdb can
6346 be found in several places:
6347 .display
6348 &url(http://www.pobox.com/~djb/cdb.html)
6349 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6350 &url(http://packages.debian.org/stable/utils/freecdb.html)
6351 .endd
6352 A cdb distribution is not needed in order to build Exim with cdb support,
6353 because the code for reading cdb files is included directly in Exim itself.
6354 However, no means of building or testing cdb files is provided with Exim, so
6355 you need to obtain a cdb distribution in order to do this.
6356 .next
6357 .cindex "DBM" "lookup type"
6358 .cindex "lookup" "dbm"
6359 .cindex "binary zero" "in lookup key"
6360 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6361 DBM file by looking up the record with the given key. A terminating binary
6362 zero is included in the key that is passed to the DBM library. See section
6363 &<<SECTdb>>& for a discussion of DBM libraries.
6364
6365 .cindex "Berkeley DB library" "file format"
6366 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6367 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6368 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6369 the DB_UNKNOWN option. This enables it to handle any of the types of database
6370 that the library supports, and can be useful for accessing DBM files created by
6371 other applications. (For earlier DB versions, DB_HASH is always used.)
6372 .next
6373 .cindex "lookup" "dbmjz"
6374 .cindex "lookup" "dbm &-- embedded NULs"
6375 .cindex "sasldb2"
6376 .cindex "dbmjz lookup type"
6377 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6378 interpreted as an Exim list; the elements of the list are joined together with
6379 ASCII NUL characters to form the lookup key.  An example usage would be to
6380 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6381 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6382 &(cram_md5)& authenticator.
6383 .next
6384 .cindex "lookup" "dbmnz"
6385 .cindex "lookup" "dbm &-- terminating zero"
6386 .cindex "binary zero" "in lookup key"
6387 .cindex "Courier"
6388 .cindex "&_/etc/userdbshadow.dat_&"
6389 .cindex "dbmnz lookup type"
6390 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6391 is not included in the key that is passed to the DBM library. You may need this
6392 if you want to look up data in files that are created by or shared with some
6393 other application that does not use terminating zeros. For example, you need to
6394 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6395 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6396 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6397 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6398 .next
6399 .cindex "lookup" "dsearch"
6400 .cindex "dsearch lookup type"
6401 &(dsearch)&: The given file must be a directory; this is searched for an entry
6402 whose name is the key by calling the &[lstat()]& function. The key may not
6403 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6404 the lookup is the name of the entry, which may be a file, directory,
6405 symbolic link, or any other kind of directory entry. An example of how this
6406 lookup can be used to support virtual domains is given in section
6407 &<<SECTvirtualdomains>>&.
6408 .next
6409 .cindex "lookup" "iplsearch"
6410 .cindex "iplsearch lookup type"
6411 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6412 terminated by a colon or white space or the end of the line. The keys in the
6413 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6414 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6415 being interpreted as a key terminator. For example:
6416 .code
6417 1.2.3.4:           data for 1.2.3.4
6418 192.168.0.0/16:    data for 192.168.0.0/16
6419 "abcd::cdab":      data for abcd::cdab
6420 "abcd:abcd::/32"   data for abcd:abcd::/32
6421 .endd
6422 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6423 file is searched linearly, using the CIDR masks where present, until a matching
6424 key is found. The first key that matches is used; there is no attempt to find a
6425 &"best"& match. Apart from the way the keys are matched, the processing for
6426 &(iplsearch)& is the same as for &(lsearch)&.
6427
6428 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6429 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6430 lookup types support only literal keys.
6431
6432 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6433 the implicit key is the host's IP address rather than its name (see section
6434 &<<SECThoslispatsikey>>&).
6435 .next
6436 .cindex "linear search"
6437 .cindex "lookup" "lsearch"
6438 .cindex "lsearch lookup type"
6439 .cindex "case sensitivity" "in lsearch lookup"
6440 &(lsearch)&: The given file is a text file that is searched linearly for a
6441 line beginning with the search key, terminated by a colon or white space or the
6442 end of the line. The search is case-insensitive; that is, upper and lower case
6443 letters are treated as the same. The first occurrence of the key that is found
6444 in the file is used.
6445
6446 White space between the key and the colon is permitted. The remainder of the
6447 line, with leading and trailing white space removed, is the data. This can be
6448 continued onto subsequent lines by starting them with any amount of white
6449 space, but only a single space character is included in the data at such a
6450 junction. If the data begins with a colon, the key must be terminated by a
6451 colon, for example:
6452 .code
6453 baduser:  :fail:
6454 .endd
6455 Empty lines and lines beginning with # are ignored, even if they occur in the
6456 middle of an item. This is the traditional textual format of alias files. Note
6457 that the keys in an &(lsearch)& file are literal strings. There is no
6458 wildcarding of any kind.
6459
6460 .cindex "lookup" "lsearch &-- colons in keys"
6461 .cindex "white space" "in lsearch key"
6462 In most &(lsearch)& files, keys are not required to contain colons or #
6463 characters, or white space. However, if you need this feature, it is available.
6464 If a key begins with a doublequote character, it is terminated only by a
6465 matching quote (or end of line), and the normal escaping rules apply to its
6466 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6467 quoted keys (exactly as for unquoted keys). There is no special handling of
6468 quotes for the data part of an &(lsearch)& line.
6469
6470 .next
6471 .cindex "NIS lookup type"
6472 .cindex "lookup" "NIS"
6473 .cindex "binary zero" "in lookup key"
6474 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6475 the given key, without a terminating binary zero. There is a variant called
6476 &(nis0)& which does include the terminating binary zero in the key. This is
6477 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6478 aliases; the full map names must be used.
6479
6480 .next
6481 .cindex "wildlsearch lookup type"
6482 .cindex "lookup" "wildlsearch"
6483 .cindex "nwildlsearch lookup type"
6484 .cindex "lookup" "nwildlsearch"
6485 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6486 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6487 the file may be wildcarded. The difference between these two lookup types is
6488 that for &(wildlsearch)&, each key in the file is string-expanded before being
6489 used, whereas for &(nwildlsearch)&, no expansion takes place.
6490
6491 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6492 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6493 file that are regular expressions can be made case-sensitive by the use of
6494 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6495
6496 . ==== As this is a nested list, any displays it contains must be indented
6497 . ==== as otherwise they are too far to the left.
6498
6499 .olist
6500 The string may begin with an asterisk to mean &"ends with"&. For example:
6501 .code
6502     *.a.b.c       data for anything.a.b.c
6503     *fish         data for anythingfish
6504 .endd
6505 .next
6506 The string may begin with a circumflex to indicate a regular expression. For
6507 example, for &(wildlsearch)&:
6508 .code
6509     ^\N\d+\.a\.b\N    data for <digits>.a.b
6510 .endd
6511 Note the use of &`\N`& to disable expansion of the contents of the regular
6512 expression. If you are using &(nwildlsearch)&, where the keys are not
6513 string-expanded, the equivalent entry is:
6514 .code
6515     ^\d+\.a\.b        data for <digits>.a.b
6516 .endd
6517 The case-insensitive flag is set at the start of compiling the regular
6518 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6519 For example, to make the entire pattern case-sensitive:
6520 .code
6521     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6522 .endd
6523
6524 If the regular expression contains white space or colon characters, you must
6525 either quote it (see &(lsearch)& above), or represent these characters in other
6526 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6527 colon. This may be easier than quoting, because if you quote, you have to
6528 escape all the backslashes inside the quotes.
6529
6530 &*Note*&: It is not possible to capture substrings in a regular expression
6531 match for later use, because the results of all lookups are cached. If a lookup
6532 is repeated, the result is taken from the cache, and no actual pattern matching
6533 takes place. The values of all the numeric variables are unset after a
6534 &((n)wildlsearch)& match.
6535
6536 .next
6537 Although I cannot see it being of much use, the general matching function that
6538 is used to implement &((n)wildlsearch)& means that the string may begin with a
6539 lookup name terminated by a semicolon, and followed by lookup data. For
6540 example:
6541 .code
6542     cdb;/some/file  data for keys that match the file
6543 .endd
6544 The data that is obtained from the nested lookup is discarded.
6545 .endlist olist
6546
6547 Keys that do not match any of these patterns are interpreted literally. The
6548 continuation rules for the data are the same as for &(lsearch)&, and keys may
6549 be followed by optional colons.
6550
6551 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6552 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6553 lookup types support only literal keys.
6554 .endlist ilist
6555
6556
6557 .section "Query-style lookup types" "SECID62"
6558 .cindex "lookup" "query-style types"
6559 .cindex "query-style lookup" "list of types"
6560 The supported query-style lookup types are listed below. Further details about
6561 many of them are given in later sections.
6562
6563 .ilist
6564 .cindex "DNS" "as a lookup type"
6565 .cindex "lookup" "DNS"
6566 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6567 are given in the supplied query. The resulting data is the contents of the
6568 records. See section &<<SECTdnsdb>>&.
6569 .next
6570 .cindex "InterBase lookup type"
6571 .cindex "lookup" "InterBase"
6572 &(ibase)&: This does a lookup in an InterBase database.
6573 .next
6574 .cindex "LDAP" "lookup type"
6575 .cindex "lookup" "LDAP"
6576 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6577 returns attributes from a single entry. There is a variant called &(ldapm)&
6578 that permits values from multiple entries to be returned. A third variant
6579 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6580 any attribute values. See section &<<SECTldap>>&.
6581 .next
6582 .cindex "MySQL" "lookup type"
6583 .cindex "lookup" "MySQL"
6584 &(mysql)&: The format of the query is an SQL statement that is passed to a
6585 MySQL database. See section &<<SECTsql>>&.
6586 .next
6587 .cindex "NIS+ lookup type"
6588 .cindex "lookup" "NIS+"
6589 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6590 the field to be returned. See section &<<SECTnisplus>>&.
6591 .next
6592 .cindex "Oracle" "lookup type"
6593 .cindex "lookup" "Oracle"
6594 &(oracle)&: The format of the query is an SQL statement that is passed to an
6595 Oracle database. See section &<<SECTsql>>&.
6596 .next
6597 .cindex "lookup" "passwd"
6598 .cindex "passwd lookup type"
6599 .cindex "&_/etc/passwd_&"
6600 &(passwd)& is a query-style lookup with queries that are just user names. The
6601 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6602 success, the result string is the same as you would get from an &(lsearch)&
6603 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6604 password value. For example:
6605 .code
6606 *:42:42:King Rat:/home/kr:/bin/bash
6607 .endd
6608 .next
6609 .cindex "PostgreSQL lookup type"
6610 .cindex "lookup" "PostgreSQL"
6611 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6612 PostgreSQL database. See section &<<SECTsql>>&.
6613
6614 .next
6615 .cindex "sqlite lookup type"
6616 .cindex "lookup" "sqlite"
6617 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6618 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6619
6620 .next
6621 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6622 not likely to be useful in normal operation.
6623 .next
6624 .cindex "whoson lookup type"
6625 .cindex "lookup" "whoson"
6626 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6627 allows a server to check whether a particular (dynamically allocated) IP
6628 address is currently allocated to a known (trusted) user and, optionally, to
6629 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6630 at one time for &"POP before SMTP"& authentication, but that approach has been
6631 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6632 &"POP before SMTP"& checking using ACL statements such as
6633 .code
6634 require condition = \
6635   ${lookup whoson {$sender_host_address}{yes}{no}}
6636 .endd
6637 The query consists of a single IP address. The value returned is the name of
6638 the authenticated user, which is stored in the variable &$value$&. However, in
6639 this example, the data in &$value$& is not used; the result of the lookup is
6640 one of the fixed strings &"yes"& or &"no"&.
6641 .endlist
6642
6643
6644
6645 .section "Temporary errors in lookups" "SECID63"
6646 .cindex "lookup" "temporary error in"
6647 Lookup functions can return temporary error codes if the lookup cannot be
6648 completed. For example, an SQL or LDAP database might be unavailable. For this
6649 reason, it is not advisable to use a lookup that might do this for critical
6650 options such as a list of local domains.
6651
6652 When a lookup cannot be completed in a router or transport, delivery
6653 of the message (to the relevant address) is deferred, as for any other
6654 temporary error. In other circumstances Exim may assume the lookup has failed,
6655 or may give up altogether.
6656
6657
6658
6659 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6660 .cindex "wildcard lookups"
6661 .cindex "lookup" "default values"
6662 .cindex "lookup" "wildcard"
6663 .cindex "lookup" "* added to type"
6664 .cindex "default" "in single-key lookups"
6665 In this context, a &"default value"& is a value specified by the administrator
6666 that is to be used if a lookup fails.
6667
6668 &*Note:*& This section applies only to single-key lookups. For query-style
6669 lookups, the facilities of the query language must be used. An attempt to
6670 specify a default for a query-style lookup provokes an error.
6671
6672 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6673 and the initial lookup fails, the key &"*"& is looked up in the file to
6674 provide a default value. See also the section on partial matching below.
6675
6676 .cindex "*@ with single-key lookup"
6677 .cindex "lookup" "*@ added to type"
6678 .cindex "alias file" "per-domain default"
6679 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6680 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6681 character, a second lookup is done with everything before the last @ replaced
6682 by *. This makes it possible to provide per-domain defaults in alias files
6683 that include the domains in the keys. If the second lookup fails (or doesn't
6684 take place because there is no @ in the key), &"*"& is looked up.
6685 For example, a &(redirect)& router might contain:
6686 .code
6687 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6688 .endd
6689 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6690 looks up these keys, in this order:
6691 .code
6692 jane@eyre.example
6693 *@eyre.example
6694 *
6695 .endd
6696 The data is taken from whichever key it finds first. &*Note*&: In an
6697 &(lsearch)& file, this does not mean the first of these keys in the file. A
6698 complete scan is done for each key, and only if it is not found at all does
6699 Exim move on to try the next key.
6700
6701
6702
6703 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6704 .cindex "partial matching"
6705 .cindex "wildcard lookups"
6706 .cindex "lookup" "partial matching"
6707 .cindex "lookup" "wildcard"
6708 .cindex "asterisk" "in search type"
6709 The normal operation of a single-key lookup is to search the file for an exact
6710 match with the given key. However, in a number of situations where domains are
6711 being looked up, it is useful to be able to do partial matching. In this case,
6712 information in the file that has a key starting with &"*."& is matched by any
6713 domain that ends with the components that follow the full stop. For example, if
6714 a key in a DBM file is
6715 .code
6716 *.dates.fict.example
6717 .endd
6718 then when partial matching is enabled this is matched by (amongst others)
6719 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6720 by &'dates.fict.example'&, if that does not appear as a separate key in the
6721 file.
6722
6723 &*Note*&: Partial matching is not available for query-style lookups. It is
6724 also not available for any lookup items in address lists (see section
6725 &<<SECTaddresslist>>&).
6726
6727 Partial matching is implemented by doing a series of separate lookups using
6728 keys constructed by modifying the original subject key. This means that it can
6729 be used with any of the single-key lookup types, provided that
6730 partial matching keys
6731 beginning with a special prefix (default &"*."&) are included in the data file.
6732 Keys in the file that do not begin with the prefix are matched only by
6733 unmodified subject keys when partial matching is in use.
6734
6735 Partial matching is requested by adding the string &"partial-"& to the front of
6736 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6737 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6738 is added at the start of the subject key, and it is looked up again. If that
6739 fails, further lookups are tried with dot-separated components removed from the
6740 start of the subject key, one-by-one, and &"*."& added on the front of what
6741 remains.
6742
6743 A minimum number of two non-* components are required. This can be adjusted
6744 by including a number before the hyphen in the search type. For example,
6745 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6746 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6747 subject key is &'2250.dates.fict.example'& then the following keys are looked
6748 up when the minimum number of non-* components is two:
6749 .code
6750 2250.dates.fict.example
6751 *.2250.dates.fict.example
6752 *.dates.fict.example
6753 *.fict.example
6754 .endd
6755 As soon as one key in the sequence is successfully looked up, the lookup
6756 finishes.
6757
6758 .cindex "lookup" "partial matching &-- changing prefix"
6759 .cindex "prefix" "for partial matching"
6760 The use of &"*."& as the partial matching prefix is a default that can be
6761 changed. The motivation for this feature is to allow Exim to operate with file
6762 formats that are used by other MTAs. A different prefix can be supplied in
6763 parentheses instead of the hyphen after &"partial"&. For example:
6764 .code
6765 domains = partial(.)lsearch;/some/file
6766 .endd
6767 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6768 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6769 components is unchanged). The prefix may consist of any punctuation characters
6770 other than a closing parenthesis. It may be empty, for example:
6771 .code
6772 domains = partial1()cdb;/some/file
6773 .endd
6774 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6775 &`a.b.c`&, &`b.c`&, and &`c`&.
6776
6777 If &"partial0"& is specified, what happens at the end (when the lookup with
6778 just one non-wild component has failed, and the original key is shortened right
6779 down to the null string) depends on the prefix:
6780
6781 .ilist
6782 If the prefix has zero length, the whole lookup fails.
6783 .next
6784 If the prefix has length 1, a lookup for just the prefix is done. For
6785 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6786 .next
6787 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6788 remainder is looked up. With the default prefix, therefore, the final lookup is
6789 for &"*"& on its own.
6790 .next
6791 Otherwise, the whole prefix is looked up.
6792 .endlist
6793
6794
6795 If the search type ends in &"*"& or &"*@"& (see section
6796 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6797 this implies happens after all partial lookups have failed. If &"partial0"& is
6798 specified, adding &"*"& to the search type has no effect with the default
6799 prefix, because the &"*"& key is already included in the sequence of partial
6800 lookups. However, there might be a use for lookup types such as
6801 &"partial0(.)lsearch*"&.
6802
6803 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6804 in domain lists and the like. Partial matching works only in terms of
6805 dot-separated components; a key such as &`*fict.example`&
6806 in a database file is useless, because the asterisk in a partial matching
6807 subject key is always followed by a dot.
6808
6809
6810
6811
6812 .section "Lookup caching" "SECID64"
6813 .cindex "lookup" "caching"
6814 .cindex "caching" "lookup data"
6815 Exim caches all lookup results in order to avoid needless repetition of
6816 lookups. However, because (apart from the daemon) Exim operates as a collection
6817 of independent, short-lived processes, this caching applies only within a
6818 single Exim process. There is no inter-process lookup caching facility.
6819
6820 For single-key lookups, Exim keeps the relevant files open in case there is
6821 another lookup that needs them. In some types of configuration this can lead to
6822 many files being kept open for messages with many recipients. To avoid hitting
6823 the operating system limit on the number of simultaneously open files, Exim
6824 closes the least recently used file when it needs to open more files than its
6825 own internal limit, which can be changed via the &%lookup_open_max%& option.
6826
6827 The single-key lookup files are closed and the lookup caches are flushed at
6828 strategic points during delivery &-- for example, after all routing is
6829 complete.
6830
6831
6832
6833
6834 .section "Quoting lookup data" "SECID65"
6835 .cindex "lookup" "quoting"
6836 .cindex "quoting" "in lookups"
6837 When data from an incoming message is included in a query-style lookup, there
6838 is the possibility of special characters in the data messing up the syntax of
6839 the query. For example, a NIS+ query that contains
6840 .code
6841 [name=$local_part]
6842 .endd
6843 will be broken if the local part happens to contain a closing square bracket.
6844 For NIS+, data can be enclosed in double quotes like this:
6845 .code
6846 [name="$local_part"]
6847 .endd
6848 but this still leaves the problem of a double quote in the data. The rule for
6849 NIS+ is that double quotes must be doubled. Other lookup types have different
6850 rules, and to cope with the differing requirements, an expansion operator
6851 of the following form is provided:
6852 .code
6853 ${quote_<lookup-type>:<string>}
6854 .endd
6855 For example, the safest way to write the NIS+ query is
6856 .code
6857 [name="${quote_nisplus:$local_part}"]
6858 .endd
6859 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6860 operator can be used for all lookup types, but has no effect for single-key
6861 lookups, since no quoting is ever needed in their key strings.
6862
6863
6864
6865
6866 .section "More about dnsdb" "SECTdnsdb"
6867 .cindex "dnsdb lookup"
6868 .cindex "lookup" "dnsdb"
6869 .cindex "DNS" "as a lookup type"
6870 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6871 of a record type and a domain name, separated by an equals sign. For example,
6872 an expansion string could contain:
6873 .code
6874 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6875 .endd
6876 If the lookup succeeds, the result is placed in &$value$&, which in this case
6877 is used on its own as the result. If the lookup does not succeed, the
6878 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6879 &<<SECTforexpfai>>& for an explanation of what this means.
6880
6881 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6882 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6883 If no type is given, TXT is assumed.
6884
6885 For any record type, if multiple records are found, the data is returned as a
6886 concatenation, with newline as the default separator. The order, of course,
6887 depends on the DNS resolver. You can specify a different separator character
6888 between multiple records by putting a right angle-bracket followed immediately
6889 by the new separator at the start of the query. For example:
6890 .code
6891 ${lookup dnsdb{>: a=host1.example}}
6892 .endd
6893 It is permitted to specify a space as the separator character. Further
6894 white space is ignored.
6895 For lookup types that return multiple fields per record,
6896 an alternate field separator can be specified using a comma after the main
6897 separator character, followed immediately by the field separator.
6898
6899 .cindex "PTR record" "in &(dnsdb)& lookup"
6900 When the type is PTR,
6901 the data can be an IP address, written as normal; inversion and the addition of
6902 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6903 .code
6904 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6905 .endd
6906 If the data for a PTR record is not a syntactically valid IP address, it is not
6907 altered and nothing is added.
6908
6909 .cindex "MX record" "in &(dnsdb)& lookup"
6910 .cindex "SRV record" "in &(dnsdb)& lookup"
6911 For an MX lookup, both the preference value and the host name are returned for
6912 each record, separated by a space. For an SRV lookup, the priority, weight,
6913 port, and host name are returned for each record, separated by spaces.
6914 The field separator can be modified as above.
6915
6916 .cindex "TXT record" "in &(dnsdb)& lookup"
6917 .cindex "SPF record" "in &(dnsdb)& lookup"
6918 For TXT records with multiple items of data, only the first item is returned,
6919 unless a field separator is specified.
6920 To concatenate items without a separator, use a semicolon instead.
6921 For SPF records the
6922 default behaviour is to concatenate multiple items without using a separator.
6923 .code
6924 ${lookup dnsdb{>\n,: txt=a.b.example}}
6925 ${lookup dnsdb{>\n; txt=a.b.example}}
6926 ${lookup dnsdb{spf=example.org}}
6927 .endd
6928 It is permitted to specify a space as the separator character. Further
6929 white space is ignored.
6930
6931 .cindex "SOA record" "in &(dnsdb)& lookup"
6932 For an SOA lookup, while no result is obtained the lookup is redone with
6933 successively more leading components dropped from the given domain.
6934 Only the primary-nameserver field is returned unless a field separator is
6935 specified.
6936 .code
6937 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6938 .endd
6939
6940 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6941 .cindex "dnsdb modifiers"
6942 .cindex "modifiers" "dnsdb"
6943 .cindex "options" "dnsdb"
6944 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6945 each followed by a comma,
6946 that may appear before the record type.
6947
6948 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6949 temporary DNS error for any of them, the behaviour is controlled by
6950 a defer-option modifier.
6951 The possible keywords are
6952 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6953 With &"strict"& behaviour, any temporary DNS error causes the
6954 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6955 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6956 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6957 error causes the whole lookup to defer only if none of the other lookups
6958 succeed. The default is &"lax"&, so the following lookups are equivalent:
6959 .code
6960 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6961 ${lookup dnsdb{a=one.host.com:two.host.com}}
6962 .endd
6963 Thus, in the default case, as long as at least one of the DNS lookups
6964 yields some data, the lookup succeeds.
6965
6966 .cindex "DNSSEC" "dns lookup"
6967 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6968 The possible keywords are
6969 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6970 With &"strict"& or &"lax"& DNSSEC information is requested
6971 with the lookup.
6972 With &"strict"& a response from the DNS resolver that
6973 is not labelled as authenticated data
6974 is treated as equivalent to a temporary DNS error.
6975 The default is &"never"&.
6976
6977 See also the &$lookup_dnssec_authenticated$& variable.
6978
6979 .cindex timeout "dns lookup"
6980 .cindex "DNS" timeout
6981 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
6982 The form is &"retrans_VAL"& where VAL is an Exim time specification
6983 (eg &"5s"&).
6984 The default value is set by the main configuration option &%dns_retrans%&.
6985
6986 Retries for the dnsdb lookup can be controlled by a retry modifier.
6987 The form if &"retry_VAL"& where VAL is an integer.
6988 The default count is set by the main configuration option &%dns_retry%&.
6989
6990
6991 .section "Pseudo dnsdb record types" "SECID66"
6992 .cindex "MX record" "in &(dnsdb)& lookup"
6993 By default, both the preference value and the host name are returned for
6994 each MX record, separated by a space. If you want only host names, you can use
6995 the pseudo-type MXH:
6996 .code
6997 ${lookup dnsdb{mxh=a.b.example}}
6998 .endd
6999 In this case, the preference values are omitted, and just the host names are
7000 returned.
7001
7002 .cindex "name server for enclosing domain"
7003 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7004 records on the given domain, but if none are found, it removes the first
7005 component of the domain name, and tries again. This process continues until NS
7006 records are found or there are no more components left (or there is a DNS
7007 error). In other words, it may return the name servers for a top-level domain,
7008 but it never returns the root name servers. If there are no NS records for the
7009 top-level domain, the lookup fails. Consider these examples:
7010 .code
7011 ${lookup dnsdb{zns=xxx.quercite.com}}
7012 ${lookup dnsdb{zns=xxx.edu}}
7013 .endd
7014 Assuming that in each case there are no NS records for the full domain name,
7015 the first returns the name servers for &%quercite.com%&, and the second returns
7016 the name servers for &%edu%&.
7017
7018 You should be careful about how you use this lookup because, unless the
7019 top-level domain does not exist, the lookup always returns some host names. The
7020 sort of use to which this might be put is for seeing if the name servers for a
7021 given domain are on a blacklist. You can probably assume that the name servers
7022 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7023 such a list.
7024
7025 .cindex "CSA" "in &(dnsdb)& lookup"
7026 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7027 records according to the CSA rules, which are described in section
7028 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7029 not sufficient because of the extra parent domain search behaviour of CSA. The
7030 result of a successful lookup such as:
7031 .code
7032 ${lookup dnsdb {csa=$sender_helo_name}}
7033 .endd
7034 has two space-separated fields: an authorization code and a target host name.
7035 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7036 authorization required but absent, or &"?"& for unknown.
7037
7038 .cindex "A+" "in &(dnsdb)& lookup"
7039 The pseudo-type A+ performs an AAAA
7040 and then an A lookup.  All results are returned; defer processing
7041 (see below) is handled separately for each lookup.  Example:
7042 .code
7043 ${lookup dnsdb {>; a+=$sender_helo_name}}
7044 .endd
7045
7046
7047 .section "Multiple dnsdb lookups" "SECID67"
7048 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7049 However, you can specify a list of domains or IP addresses in a single
7050 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7051 the default separator, but with the ability to change this. For example:
7052 .code
7053 ${lookup dnsdb{one.domain.com:two.domain.com}}
7054 ${lookup dnsdb{a=one.host.com:two.host.com}}
7055 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7056 .endd
7057 In order to retain backwards compatibility, there is one special case: if
7058 the lookup type is PTR and no change of separator is specified, Exim looks
7059 to see if the rest of the string is precisely one IPv6 address. In this
7060 case, it does not treat it as a list.
7061
7062 The data from each lookup is concatenated, with newline separators by default,
7063 in the same way that multiple DNS records for a single item are handled. A
7064 different separator can be specified, as described above.
7065
7066
7067
7068
7069 .section "More about LDAP" "SECTldap"
7070 .cindex "LDAP" "lookup, more about"
7071 .cindex "lookup" "LDAP"
7072 .cindex "Solaris" "LDAP"
7073 The original LDAP implementation came from the University of Michigan; this has
7074 become &"Open LDAP"&, and there are now two different releases. Another
7075 implementation comes from Netscape, and Solaris 7 and subsequent releases
7076 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7077 the lookup function level, their error handling is different. For this reason
7078 it is necessary to set a compile-time variable when building Exim with LDAP, to
7079 indicate which LDAP library is in use. One of the following should appear in
7080 your &_Local/Makefile_&:
7081 .code
7082 LDAP_LIB_TYPE=UMICHIGAN
7083 LDAP_LIB_TYPE=OPENLDAP1
7084 LDAP_LIB_TYPE=OPENLDAP2
7085 LDAP_LIB_TYPE=NETSCAPE
7086 LDAP_LIB_TYPE=SOLARIS
7087 .endd
7088 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7089 same interface as the University of Michigan version.
7090
7091 There are three LDAP lookup types in Exim. These behave slightly differently in
7092 the way they handle the results of a query:
7093
7094 .ilist
7095 &(ldap)& requires the result to contain just one entry; if there are more, it
7096 gives an error.
7097 .next
7098 &(ldapdn)& also requires the result to contain just one entry, but it is the
7099 Distinguished Name that is returned rather than any attribute values.
7100 .next
7101 &(ldapm)& permits the result to contain more than one entry; the attributes
7102 from all of them are returned.
7103 .endlist
7104
7105
7106 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7107 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7108 the data returned by a successful lookup is described in the next section.
7109 First we explain how LDAP queries are coded.
7110
7111
7112 .section "Format of LDAP queries" "SECTforldaque"
7113 .cindex "LDAP" "query format"
7114 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7115 the configuration of a &(redirect)& router one might have this setting:
7116 .code
7117 data = ${lookup ldap \
7118   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7119   c=UK?mailbox?base?}}
7120 .endd
7121 .cindex "LDAP" "with TLS"
7122 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7123 secure (encrypted) LDAP connections. The second of these ensures that an
7124 encrypted TLS connection is used.
7125
7126 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7127 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7128 See the &%ldap_start_tls%& option.
7129
7130 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7131 controlled. Every part of the TLS configuration can be configured by settings in
7132 &_exim.conf_&. Depending on the version of the client libraries installed on
7133 your system, some of the initialization may have required setting options in
7134 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7135 certificates. This revealed a nuance where the current UID that exim was
7136 running as could affect which config files it read. With Exim 4.83, these
7137 methods become optional, only taking effect if not specifically set in
7138 &_exim.conf_&.
7139
7140
7141 .section "LDAP quoting" "SECID68"
7142 .cindex "LDAP" "quoting"
7143 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7144 and the second because the LDAP query is represented as a URL. Furthermore,
7145 within an LDAP query, two different kinds of quoting are required. For this
7146 reason, there are two different LDAP-specific quoting operators.
7147
7148 The &%quote_ldap%& operator is designed for use on strings that are part of
7149 filter specifications. Conceptually, it first does the following conversions on
7150 the string:
7151 .code
7152 *   =>   \2A
7153 (   =>   \28
7154 )   =>   \29
7155 \   =>   \5C
7156 .endd
7157 in accordance with RFC 2254. The resulting string is then quoted according
7158 to the rules for URLs, that is, all non-alphanumeric characters except
7159 .code
7160 ! $ ' - . _ ( ) * +
7161 .endd
7162 are converted to their hex values, preceded by a percent sign. For example:
7163 .code
7164 ${quote_ldap: a(bc)*, a<yz>; }
7165 .endd
7166 yields
7167 .code
7168 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7169 .endd
7170 Removing the URL quoting, this is (with a leading and a trailing space):
7171 .code
7172 a\28bc\29\2A, a<yz>;
7173 .endd
7174 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7175 base DN specifications in queries. Conceptually, it first converts the string
7176 by inserting a backslash in front of any of the following characters:
7177 .code
7178 , + " \ < > ;
7179 .endd
7180 It also inserts a backslash before any leading spaces or # characters, and
7181 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7182 is then quoted according to the rules for URLs. For example:
7183 .code
7184 ${quote_ldap_dn: a(bc)*, a<yz>; }
7185 .endd
7186 yields
7187 .code
7188 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7189 .endd
7190 Removing the URL quoting, this is (with a trailing space):
7191 .code
7192 \ a(bc)*\, a\<yz\>\;\
7193 .endd
7194 There are some further comments about quoting in the section on LDAP
7195 authentication below.
7196
7197
7198 .section "LDAP connections" "SECID69"
7199 .cindex "LDAP" "connections"
7200 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7201 is in use, via a Unix domain socket. The example given above does not specify
7202 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7203 by starting it with
7204 .code
7205 ldap://<hostname>:<port>/...
7206 .endd
7207 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7208 used. When no server is specified in a query, a list of default servers is
7209 taken from the &%ldap_default_servers%& configuration option. This supplies a
7210 colon-separated list of servers which are tried in turn until one successfully
7211 handles a query, or there is a serious error. Successful handling either
7212 returns the requested data, or indicates that it does not exist. Serious errors
7213 are syntactical, or multiple values when only a single value is expected.
7214 Errors which cause the next server to be tried are connection failures, bind
7215 failures, and timeouts.
7216
7217 For each server name in the list, a port number can be given. The standard way
7218 of specifying a host and port is to use a colon separator (RFC 1738). Because
7219 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7220 doubled. For example
7221 .code
7222 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7223 .endd
7224 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7225 to the LDAP library with no server name, and the library's default (normally
7226 the local host) is used.
7227
7228 If you are using the OpenLDAP library, you can connect to an LDAP server using
7229 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7230 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7231 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7232 not available.
7233
7234 For this type of connection, instead of a host name for the server, a pathname
7235 for the socket is required, and the port number is not relevant. The pathname
7236 can be specified either as an item in &%ldap_default_servers%&, or inline in
7237 the query. In the former case, you can have settings such as
7238 .code
7239 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7240 .endd
7241 When the pathname is given in the query, you have to escape the slashes as
7242 &`%2F`& to fit in with the LDAP URL syntax. For example:
7243 .code
7244 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7245 .endd
7246 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7247 a pathname, it uses the Unix domain socket code, even if the query actually
7248 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7249 socket connection. This behaviour means that you can use a setting of
7250 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7251 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7252 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7253 backup host.
7254
7255 If an explicit &`ldapi`& type is given in a query when a host name is
7256 specified, an error is diagnosed. However, if there are more items in
7257 &%ldap_default_servers%&, they are tried. In other words:
7258
7259 .ilist
7260 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7261 interface.
7262 .next
7263 Using &`ldapi`& with a host name causes an error.
7264 .endlist
7265
7266
7267 Using &`ldapi`& with no host or path in the query, and no setting of
7268 &%ldap_default_servers%&, does whatever the library does by default.
7269
7270
7271
7272 .section "LDAP authentication and control information" "SECID70"
7273 .cindex "LDAP" "authentication"
7274 The LDAP URL syntax provides no way of passing authentication and other control
7275 information to the server. To make this possible, the URL in an LDAP query may
7276 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7277 spaces. If a value contains spaces it must be enclosed in double quotes, and
7278 when double quotes are used, backslash is interpreted in the usual way inside
7279 them. The following names are recognized:
7280 .display
7281 &`DEREFERENCE`&  set the dereferencing parameter
7282 &`NETTIME    `&  set a timeout for a network operation
7283 &`USER       `&  set the DN, for authenticating the LDAP bind
7284 &`PASS       `&  set the password, likewise
7285 &`REFERRALS  `&  set the referrals parameter
7286 &`SERVERS    `&  set alternate server list for this query only
7287 &`SIZE       `&  set the limit for the number of entries returned
7288 &`TIME       `&  set the maximum waiting time for a query
7289 .endd
7290 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7291 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7292 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7293 library from trying to follow referrals issued by the LDAP server.
7294
7295 The name CONNECT is an obsolete name for NETTIME, retained for
7296 backwards compatibility. This timeout (specified as a number of seconds) is
7297 enforced from the client end for operations that can be carried out over a
7298 network. Specifically, it applies to network connections and calls to the
7299 &'ldap_result()'& function. If the value is greater than zero, it is used if
7300 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7301 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7302 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7303 Netscape SDK; for OpenLDAP no action is taken.
7304
7305 The TIME parameter (also a number of seconds) is passed to the server to
7306 set a server-side limit on the time taken to complete a search.
7307
7308 The SERVERS parameter allows you to specify an alternate list of ldap servers
7309 to use for an individual lookup.  The global ldap_servers option provides a
7310 default list of ldap servers, and a single lookup can specify a single ldap
7311 server to use.  But when you need to do a lookup with a list of servers that is
7312 different than the default list (maybe different order, maybe a completely
7313 different set of servers), the SERVERS parameter allows you to specify this
7314 alternate list (colon-separated).
7315
7316 Here is an example of an LDAP query in an Exim lookup that uses some of these
7317 values. This is a single line, folded to fit on the page:
7318 .code
7319 ${lookup ldap
7320   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7321   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7322   {$value}fail}
7323 .endd
7324 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7325 any of the auxiliary data. Exim configuration settings that include lookups
7326 which contain password information should be preceded by &"hide"& to prevent
7327 non-admin users from using the &%-bP%& option to see their values.
7328
7329 The auxiliary data items may be given in any order. The default is no
7330 connection timeout (the system timeout is used), no user or password, no limit
7331 on the number of entries returned, and no time limit on queries.
7332
7333 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7334 removes any URL quoting that it may contain before passing it LDAP. Apparently
7335 some libraries do this for themselves, but some do not. Removing the URL
7336 quoting has two advantages:
7337
7338 .ilist
7339 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7340 DNs as with DNs inside actual queries.
7341 .next
7342 It permits spaces inside USER= DNs.
7343 .endlist
7344
7345 For example, a setting such as
7346 .code
7347 USER=cn=${quote_ldap_dn:$1}
7348 .endd
7349 should work even if &$1$& contains spaces.
7350
7351 Expanded data for the PASS= value should be quoted using the &%quote%&
7352 expansion operator, rather than the LDAP quote operators. The only reason this
7353 field needs quoting is to ensure that it conforms to the Exim syntax, which
7354 does not allow unquoted spaces. For example:
7355 .code
7356 PASS=${quote:$3}
7357 .endd
7358 The LDAP authentication mechanism can be used to check passwords as part of
7359 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7360 &<<CHAPexpand>>&.
7361
7362
7363
7364 .section "Format of data returned by LDAP" "SECID71"
7365 .cindex "LDAP" "returned data formats"
7366 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7367 as a sequence of values, for example
7368 .code
7369 cn=manager, o=University of Cambridge, c=UK
7370 .endd
7371 The &(ldap)& lookup type generates an error if more than one entry matches the
7372 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7373 the result between the data from different entries. It is possible for multiple
7374 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7375 you know that whatever values are returned all came from a single entry in the
7376 directory.
7377
7378 In the common case where you specify a single attribute in your LDAP query, the
7379 result is not quoted, and does not contain the attribute name. If the attribute
7380 has multiple values, they are separated by commas.
7381
7382 If you specify multiple attributes, the result contains space-separated, quoted
7383 strings, each preceded by the attribute name and an equals sign. Within the
7384 quotes, the quote character, backslash, and newline are escaped with
7385 backslashes, and commas are used to separate multiple values for the attribute.
7386 Any commas in attribute values are doubled
7387 (permitting treatment of the values as a comma-separated list).
7388 Apart from the escaping, the string within quotes takes the same form as the
7389 output when a single attribute is requested. Specifying no attributes is the
7390 same as specifying all of an entry's attributes.
7391
7392 Here are some examples of the output format. The first line of each pair is an
7393 LDAP query, and the second is the data that is returned. The attribute called
7394 &%attr1%& has two values, one of them with an embedded comma, whereas
7395 &%attr2%& has only one value:
7396 .code
7397 ldap:///o=base?attr1?sub?(uid=fred)
7398 value1.1,value1,,2
7399
7400 ldap:///o=base?attr2?sub?(uid=fred)
7401 value two
7402
7403 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7404 attr1="value1.1,value1,,2" attr2="value two"
7405
7406 ldap:///o=base??sub?(uid=fred)
7407 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7408 .endd
7409 You can
7410 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7411 results of LDAP lookups.
7412 The &%extract%& operator in string expansions can be used to pick out
7413 individual fields from data that consists of &'key'&=&'value'& pairs.
7414 The &%listextract%& operator should be used to pick out individual values
7415 of attributes, even when only a single value is expected.
7416 The doubling of embedded commas allows you to use the returned data as a
7417 comma separated list (using the "<," syntax for changing the input list separator).
7418
7419
7420
7421
7422 .section "More about NIS+" "SECTnisplus"
7423 .cindex "NIS+ lookup type"
7424 .cindex "lookup" "NIS+"
7425 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7426 and field name. If this is given, the result of a successful query is the
7427 contents of the named field; otherwise the result consists of a concatenation
7428 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7429 values containing spaces are quoted. For example, the query
7430 .code
7431 [name=mg1456],passwd.org_dir
7432 .endd
7433 might return the string
7434 .code
7435 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7436 home=/home/mg1456 shell=/bin/bash shadow=""
7437 .endd
7438 (split over two lines here to fit on the page), whereas
7439 .code
7440 [name=mg1456],passwd.org_dir:gcos
7441 .endd
7442 would just return
7443 .code
7444 Martin Guerre
7445 .endd
7446 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7447 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7448 operator is to double any quote characters within the text.
7449
7450
7451
7452 .section "SQL lookups" "SECTsql"
7453 .cindex "SQL lookup types"
7454 .cindex "MySQL" "lookup type"
7455 .cindex "PostgreSQL lookup type"
7456 .cindex "lookup" "MySQL"
7457 .cindex "lookup" "PostgreSQL"
7458 .cindex "Oracle" "lookup type"
7459 .cindex "lookup" "Oracle"
7460 .cindex "InterBase lookup type"
7461 .cindex "lookup" "InterBase"
7462 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7463 databases. Queries for these databases contain SQL statements, so an example
7464 might be
7465 .code
7466 ${lookup mysql{select mailbox from users where id='userx'}\
7467   {$value}fail}
7468 .endd
7469 If the result of the query contains more than one field, the data for each
7470 field in the row is returned, preceded by its name, so the result of
7471 .code
7472 ${lookup pgsql{select home,name from users where id='userx'}\
7473   {$value}}
7474 .endd
7475 might be
7476 .code
7477 home=/home/userx name="Mister X"
7478 .endd
7479 Empty values and values containing spaces are double quoted, with embedded
7480 quotes escaped by a backslash. If the result of the query contains just one
7481 field, the value is passed back verbatim, without a field name, for example:
7482 .code
7483 Mister X
7484 .endd
7485 If the result of the query yields more than one row, it is all concatenated,
7486 with a newline between the data for each row.
7487
7488
7489 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7490 .cindex "MySQL" "lookup type"
7491 .cindex "PostgreSQL lookup type"
7492 .cindex "lookup" "MySQL"
7493 .cindex "lookup" "PostgreSQL"
7494 .cindex "Oracle" "lookup type"
7495 .cindex "lookup" "Oracle"
7496 .cindex "InterBase lookup type"
7497 .cindex "lookup" "InterBase"
7498 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7499 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7500 option (as appropriate) must be set to a colon-separated list of server
7501 information.
7502 (For MySQL and PostgreSQL only, the global option need not be set if all
7503 queries contain their own server information &-- see section
7504 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7505 items: host name, database name, user name, and password. In the case of
7506 Oracle, the host name field is used for the &"service name"&, and the database
7507 name field is not used and should be empty. For example:
7508 .code
7509 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7510 .endd
7511 Because password data is sensitive, you should always precede the setting with
7512 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7513 option. Here is an example where two MySQL servers are listed:
7514 .code
7515 hide mysql_servers = localhost/users/root/secret:\
7516                      otherhost/users/root/othersecret
7517 .endd
7518 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7519 because this is a colon-separated list, the colon has to be doubled. For each
7520 query, these parameter groups are tried in order until a connection is made and
7521 a query is successfully processed. The result of a query may be that no data is
7522 found, but that is still a successful query. In other words, the list of
7523 servers provides a backup facility, not a list of different places to look.
7524
7525 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7526 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7527 respectively, and the characters single-quote, double-quote, and backslash
7528 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7529 addition, escapes the percent and underscore characters. This cannot be done
7530 for MySQL because these escapes are not recognized in contexts where these
7531 characters are not special.
7532
7533 .section "Specifying the server in the query" "SECTspeserque"
7534 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7535 it is possible to specify a list of servers with an individual query. This is
7536 done by starting the query with
7537 .display
7538 &`servers=`&&'server1:server2:server3:...'&&`;`&
7539 .endd
7540 Each item in the list may take one of two forms:
7541 .olist
7542 If it contains no slashes it is assumed to be just a host name. The appropriate
7543 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7544 of the same name, and the remaining parameters (database, user, password) are
7545 taken from there.
7546 .next
7547 If it contains any slashes, it is taken as a complete parameter set.
7548 .endlist
7549 The list of servers is used in exactly the same way as the global list.
7550 Once a connection to a server has happened and a query has been
7551 successfully executed, processing of the lookup ceases.
7552
7553 This feature is intended for use in master/slave situations where updates
7554 are occurring and you want to update the master rather than a slave. If the
7555 master is in the list as a backup for reading, you might have a global setting
7556 like this:
7557 .code
7558 mysql_servers = slave1/db/name/pw:\
7559                 slave2/db/name/pw:\
7560                 master/db/name/pw
7561 .endd
7562 In an updating lookup, you could then write:
7563 .code
7564 ${lookup mysql{servers=master; UPDATE ...} }
7565 .endd
7566 That query would then be sent only to the master server. If, on the other hand,
7567 the master is not to be used for reading, and so is not present in the global
7568 option, you can still update it by a query of this form:
7569 .code
7570 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7571 .endd
7572
7573
7574 .section "Special MySQL features" "SECID73"
7575 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7576 causes a connection to the server on the local host by means of a Unix domain
7577 socket. An alternate socket can be specified in parentheses. The full syntax of
7578 each item in &%mysql_servers%& is:
7579 .display
7580 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7581   <&'user'&>/<&'password'&>
7582 .endd
7583 Any of the three sub-parts of the first field can be omitted. For normal use on
7584 the local host it can be left blank or set to just &"localhost"&.
7585
7586 No database need be supplied &-- but if it is absent here, it must be given in
7587 the queries.
7588
7589 If a MySQL query is issued that does not request any data (an insert, update,
7590 or delete command), the result of the lookup is the number of rows affected.
7591
7592 &*Warning*&: This can be misleading. If an update does not actually change
7593 anything (for example, setting a field to the value it already has), the result
7594 is zero because no rows are affected.
7595
7596
7597 .section "Special PostgreSQL features" "SECID74"
7598 PostgreSQL lookups can also use Unix domain socket connections to the database.
7599 This is usually faster and costs less CPU time than a TCP/IP connection.
7600 However it can be used only if the mail server runs on the same machine as the
7601 database server. A configuration line for PostgreSQL via Unix domain sockets
7602 looks like this:
7603 .code
7604 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7605 .endd
7606 In other words, instead of supplying a host name, a path to the socket is
7607 given. The path name is enclosed in parentheses so that its slashes aren't
7608 visually confused with the delimiters for the other server parameters.
7609
7610 If a PostgreSQL query is issued that does not request any data (an insert,
7611 update, or delete command), the result of the lookup is the number of rows
7612 affected.
7613
7614 .section "More about SQLite" "SECTsqlite"
7615 .cindex "lookup" "SQLite"
7616 .cindex "sqlite lookup type"
7617 SQLite is different to the other SQL lookups because a file name is required in
7618 addition to the SQL query. An SQLite database is a single file, and there is no
7619 daemon as in the other SQL databases. The interface to Exim requires the name
7620 of the file, as an absolute path, to be given at the start of the query. It is
7621 separated from the query by white space. This means that the path name cannot
7622 contain white space. Here is a lookup expansion example:
7623 .code
7624 ${lookup sqlite {/some/thing/sqlitedb \
7625   select name from aliases where id='userx';}}
7626 .endd
7627 In a list, the syntax is similar. For example:
7628 .code
7629 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7630    select * from relays where ip='$sender_host_address';
7631 .endd
7632 The only character affected by the &%quote_sqlite%& operator is a single
7633 quote, which it doubles.
7634
7635 The SQLite library handles multiple simultaneous accesses to the database
7636 internally. Multiple readers are permitted, but only one process can
7637 update at once. Attempts to access the database while it is being updated
7638 are rejected after a timeout period, during which the SQLite library
7639 waits for the lock to be released. In Exim, the default timeout is set
7640 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7641 option.
7642 .ecindex IIDfidalo1
7643 .ecindex IIDfidalo2
7644
7645
7646 . ////////////////////////////////////////////////////////////////////////////
7647 . ////////////////////////////////////////////////////////////////////////////
7648
7649 .chapter "Domain, host, address, and local part lists" &&&
7650          "CHAPdomhosaddlists" &&&
7651          "Domain, host, and address lists"
7652 .scindex IIDdohoadli "lists of domains; hosts; etc."
7653 A number of Exim configuration options contain lists of domains, hosts,
7654 email addresses, or local parts. For example, the &%hold_domains%& option
7655 contains a list of domains whose delivery is currently suspended. These lists
7656 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7657 arguments to expansion conditions such as &%match_domain%&.
7658
7659 Each item in one of these lists is a pattern to be matched against a domain,
7660 host, email address, or local part, respectively. In the sections below, the
7661 different types of pattern for each case are described, but first we cover some
7662 general facilities that apply to all four kinds of list.
7663
7664
7665
7666 .section "Expansion of lists" "SECID75"
7667 .cindex "expansion" "of lists"
7668 Each list is expanded as a single string before it is used. The result of
7669 expansion must be a list, possibly containing empty items, which is split up
7670 into separate items for matching. By default, colon is the separator character,
7671 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7672 &<<SECTempitelis>>& for details of the list syntax; the second of these
7673 discusses the way to specify empty list items.
7674
7675
7676 If the string expansion is forced to fail, Exim behaves as if the item it is
7677 testing (domain, host, address, or local part) is not in the list. Other
7678 expansion failures cause temporary errors.
7679
7680 If an item in a list is a regular expression, backslashes, dollars and possibly
7681 other special characters in the expression must be protected against
7682 misinterpretation by the string expander. The easiest way to do this is to use
7683 the &`\N`& expansion feature to indicate that the contents of the regular
7684 expression should not be expanded. For example, in an ACL you might have:
7685 .code
7686 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7687                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7688 .endd
7689 The first item is a regular expression that is protected from expansion by
7690 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7691 senders based on the receiving domain.
7692
7693
7694
7695
7696 .section "Negated items in lists" "SECID76"
7697 .cindex "list" "negation"
7698 .cindex "negation" "in lists"
7699 Items in a list may be positive or negative. Negative items are indicated by a
7700 leading exclamation mark, which may be followed by optional white space. A list
7701 defines a set of items (domains, etc). When Exim processes one of these lists,
7702 it is trying to find out whether a domain, host, address, or local part
7703 (respectively) is in the set that is defined by the list. It works like this:
7704
7705 The list is scanned from left to right. If a positive item is matched, the
7706 subject that is being checked is in the set; if a negative item is matched, the
7707 subject is not in the set. If the end of the list is reached without the
7708 subject having matched any of the patterns, it is in the set if the last item
7709 was a negative one, but not if it was a positive one. For example, the list in
7710 .code
7711 domainlist relay_to_domains = !a.b.c : *.b.c
7712 .endd
7713 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7714 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7715 list is positive. However, if the setting were
7716 .code
7717 domainlist relay_to_domains = !a.b.c
7718 .endd
7719 then all domains other than &'a.b.c'& would match because the last item in the
7720 list is negative. In other words, a list that ends with a negative item behaves
7721 as if it had an extra item &`:*`& on the end.
7722
7723 Another way of thinking about positive and negative items in lists is to read
7724 the connector as &"or"& after a positive item and as &"and"& after a negative
7725 item.
7726
7727
7728
7729 .section "File names in lists" "SECTfilnamlis"
7730 .cindex "list" "file name in"
7731 If an item in a domain, host, address, or local part list is an absolute file
7732 name (beginning with a slash character), each line of the file is read and
7733 processed as if it were an independent item in the list, except that further
7734 file names are not allowed,
7735 and no expansion of the data from the file takes place.
7736 Empty lines in the file are ignored, and the file may also contain comment
7737 lines:
7738
7739 .ilist
7740 For domain and host lists, if a # character appears anywhere in a line of the
7741 file, it and all following characters are ignored.
7742 .next
7743 Because local parts may legitimately contain # characters, a comment in an
7744 address list or local part list file is recognized only if # is preceded by
7745 white space or the start of the line. For example:
7746 .code
7747 not#comment@x.y.z   # but this is a comment
7748 .endd
7749 .endlist
7750
7751 Putting a file name in a list has the same effect as inserting each line of the
7752 file as an item in the list (blank lines and comments excepted). However, there
7753 is one important difference: the file is read each time the list is processed,
7754 so if its contents vary over time, Exim's behaviour changes.
7755
7756 If a file name is preceded by an exclamation mark, the sense of any match
7757 within the file is inverted. For example, if
7758 .code
7759 hold_domains = !/etc/nohold-domains
7760 .endd
7761 and the file contains the lines
7762 .code
7763 !a.b.c
7764 *.b.c
7765 .endd
7766 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7767 any domain matching &`*.b.c`& is not.
7768
7769
7770
7771 .section "An lsearch file is not an out-of-line list" "SECID77"
7772 As will be described in the sections that follow, lookups can be used in lists
7773 to provide indexed methods of checking list membership. There has been some
7774 confusion about the way &(lsearch)& lookups work in lists. Because
7775 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7776 sometimes thought that it is allowed to contain wild cards and other kinds of
7777 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7778 always fixed strings, just as for any other single-key lookup type.
7779
7780 If you want to use a file to contain wild-card patterns that form part of a
7781 list, just give the file name on its own, without a search type, as described
7782 in the previous section. You could also use the &(wildlsearch)& or
7783 &(nwildlsearch)&, but there is no advantage in doing this.
7784
7785
7786
7787
7788 .section "Named lists" "SECTnamedlists"
7789 .cindex "named lists"
7790 .cindex "list" "named"
7791 A list of domains, hosts, email addresses, or local parts can be given a name
7792 which is then used to refer to the list elsewhere in the configuration. This is
7793 particularly convenient if the same list is required in several different
7794 places. It also allows lists to be given meaningful names, which can improve
7795 the readability of the configuration. For example, it is conventional to define
7796 a domain list called &'local_domains'& for all the domains that are handled
7797 locally on a host, using a configuration line such as
7798 .code
7799 domainlist local_domains = localhost:my.dom.example
7800 .endd
7801 Named lists are referenced by giving their name preceded by a plus sign, so,
7802 for example, a router that is intended to handle local domains would be
7803 configured with the line
7804 .code
7805 domains = +local_domains
7806 .endd
7807 The first router in a configuration is often one that handles all domains
7808 except the local ones, using a configuration with a negated item like this:
7809 .code
7810 dnslookup:
7811   driver = dnslookup
7812   domains = ! +local_domains
7813   transport = remote_smtp
7814   no_more
7815 .endd
7816 The four kinds of named list are created by configuration lines starting with
7817 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7818 respectively. Then there follows the name that you are defining, followed by an
7819 equals sign and the list itself. For example:
7820 .code
7821 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7822 addresslist bad_senders = cdb;/etc/badsenders
7823 .endd
7824 A named list may refer to other named lists:
7825 .code
7826 domainlist  dom1 = first.example : second.example
7827 domainlist  dom2 = +dom1 : third.example
7828 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7829 .endd
7830 &*Warning*&: If the last item in a referenced list is a negative one, the
7831 effect may not be what you intended, because the negation does not propagate
7832 out to the higher level. For example, consider:
7833 .code
7834 domainlist  dom1 = !a.b
7835 domainlist  dom2 = +dom1 : *.b
7836 .endd
7837 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7838 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7839 means it matches the second list as well. The effect is not the same as
7840 .code
7841 domainlist  dom2 = !a.b : *.b
7842 .endd
7843 where &'x.y'& does not match. It's best to avoid negation altogether in
7844 referenced lists if you can.
7845
7846 Named lists may have a performance advantage. When Exim is routing an
7847 address or checking an incoming message, it caches the result of tests on named
7848 lists. So, if you have a setting such as
7849 .code
7850 domains = +local_domains
7851 .endd
7852 on several of your routers
7853 or in several ACL statements,
7854 the actual test is done only for the first one. However, the caching works only
7855 if there are no expansions within the list itself or any sublists that it
7856 references. In other words, caching happens only for lists that are known to be
7857 the same each time they are referenced.
7858
7859 By default, there may be up to 16 named lists of each type. This limit can be
7860 extended by changing a compile-time variable. The use of domain and host lists
7861 is recommended for concepts such as local domains, relay domains, and relay
7862 hosts. The default configuration is set up like this.
7863
7864
7865
7866 .section "Named lists compared with macros" "SECID78"
7867 .cindex "list" "named compared with macro"
7868 .cindex "macro" "compared with named list"
7869 At first sight, named lists might seem to be no different from macros in the
7870 configuration file. However, macros are just textual substitutions. If you
7871 write
7872 .code
7873 ALIST = host1 : host2
7874 auth_advertise_hosts = !ALIST
7875 .endd
7876 it probably won't do what you want, because that is exactly the same as
7877 .code
7878 auth_advertise_hosts = !host1 : host2
7879 .endd
7880 Notice that the second host name is not negated. However, if you use a host
7881 list, and write
7882 .code
7883 hostlist alist = host1 : host2
7884 auth_advertise_hosts = ! +alist
7885 .endd
7886 the negation applies to the whole list, and so that is equivalent to
7887 .code
7888 auth_advertise_hosts = !host1 : !host2
7889 .endd
7890
7891
7892 .section "Named list caching" "SECID79"
7893 .cindex "list" "caching of named"
7894 .cindex "caching" "named lists"
7895 While processing a message, Exim caches the result of checking a named list if
7896 it is sure that the list is the same each time. In practice, this means that
7897 the cache operates only if the list contains no $ characters, which guarantees
7898 that it will not change when it is expanded. Sometimes, however, you may have
7899 an expanded list that you know will be the same each time within a given
7900 message. For example:
7901 .code
7902 domainlist special_domains = \
7903            ${lookup{$sender_host_address}cdb{/some/file}}
7904 .endd
7905 This provides a list of domains that depends only on the sending host's IP
7906 address. If this domain list is referenced a number of times (for example,
7907 in several ACL lines, or in several routers) the result of the check is not
7908 cached by default, because Exim does not know that it is going to be the
7909 same list each time.
7910
7911 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7912 cache the result anyway. For example:
7913 .code
7914 domainlist_cache special_domains = ${lookup{...
7915 .endd
7916 If you do this, you should be absolutely sure that caching is going to do
7917 the right thing in all cases. When in doubt, leave it out.
7918
7919
7920
7921 .section "Domain lists" "SECTdomainlist"
7922 .cindex "domain list" "patterns for"
7923 .cindex "list" "domain list"
7924 Domain lists contain patterns that are to be matched against a mail domain.
7925 The following types of item may appear in domain lists:
7926
7927 .ilist
7928 .cindex "primary host name"
7929 .cindex "host name" "matched in domain list"
7930 .oindex "&%primary_hostname%&"
7931 .cindex "domain list" "matching primary host name"
7932 .cindex "@ in a domain list"
7933 If a pattern consists of a single @ character, it matches the local host name,
7934 as set by the &%primary_hostname%& option (or defaulted). This makes it
7935 possible to use the same configuration file on several different hosts that
7936 differ only in their names.
7937 .next
7938 .cindex "@[] in a domain list"
7939 .cindex "domain list" "matching local IP interfaces"
7940 .cindex "domain literal"
7941 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7942 in square brackets (as in an email address that contains a domain literal), but
7943 only if that IP address is recognized as local for email routing purposes. The
7944 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7945 control which of a host's several IP addresses are treated as local.
7946 In today's Internet, the use of domain literals is controversial.
7947 .next
7948 .cindex "@mx_any"
7949 .cindex "@mx_primary"
7950 .cindex "@mx_secondary"
7951 .cindex "domain list" "matching MX pointers to local host"
7952 If a pattern consists of the string &`@mx_any`& it matches any domain that
7953 has an MX record pointing to the local host or to any host that is listed in
7954 .oindex "&%hosts_treat_as_local%&"
7955 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7956 are similar, except that the first matches only when a primary MX target is the
7957 local host, and the second only when no primary MX target is the local host,
7958 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7959 preference value &-- there may of course be more than one of them.
7960
7961 The MX lookup that takes place when matching a pattern of this type is
7962 performed with the resolver options for widening names turned off. Thus, for
7963 example, a single-component domain will &'not'& be expanded by adding the
7964 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7965 options of the &(dnslookup)& router for a discussion of domain widening.
7966
7967 Sometimes you may want to ignore certain IP addresses when using one of these
7968 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7969 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7970 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7971 on a router). For example:
7972 .code
7973 domains = @mx_any/ignore=127.0.0.1
7974 .endd
7975 This example matches any domain that has an MX record pointing to one of
7976 the local host's IP addresses other than 127.0.0.1.
7977
7978 The list of IP addresses is in fact processed by the same code that processes
7979 host lists, so it may contain CIDR-coded network specifications and it may also
7980 contain negative items.
7981
7982 Because the list of IP addresses is a sublist within a domain list, you have to
7983 be careful about delimiters if there is more than one address. Like any other
7984 list, the default delimiter can be changed. Thus, you might have:
7985 .code
7986 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7987           an.other.domain : ...
7988 .endd
7989 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7990 involved, it is easiest to change the delimiter for the main list as well:
7991 .code
7992 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7993           an.other.domain ? ...
7994 .endd
7995 .next
7996 .cindex "asterisk" "in domain list"
7997 .cindex "domain list" "asterisk in"
7998 .cindex "domain list" "matching &""ends with""&"
7999 If a pattern starts with an asterisk, the remaining characters of the pattern
8000 are compared with the terminating characters of the domain. The use of &"*"& in
8001 domain lists differs from its use in partial matching lookups. In a domain
8002 list, the character following the asterisk need not be a dot, whereas partial
8003 matching works only in terms of dot-separated components. For example, a domain
8004 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8005 &'cipher.key.ex'&.
8006
8007 .next
8008 .cindex "regular expressions" "in domain list"
8009 .cindex "domain list" "matching regular expression"
8010 If a pattern starts with a circumflex character, it is treated as a regular
8011 expression, and matched against the domain using a regular expression matching
8012 function. The circumflex is treated as part of the regular expression.
8013 Email domains are case-independent, so this regular expression match is by
8014 default case-independent, but you can make it case-dependent by starting it
8015 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8016 are given in chapter &<<CHAPregexp>>&.
8017
8018 &*Warning*&: Because domain lists are expanded before being processed, you
8019 must escape any backslash and dollar characters in the regular expression, or
8020 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8021 it is not to be expanded (unless you really do want to build a regular
8022 expression by expansion, of course).
8023 .next
8024 .cindex "lookup" "in domain list"
8025 .cindex "domain list" "matching by lookup"
8026 If a pattern starts with the name of a single-key lookup type followed by a
8027 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8028 must be a file name in a suitable format for the lookup type. For example, for
8029 &"cdb;"& it must be an absolute path:
8030 .code
8031 domains = cdb;/etc/mail/local_domains.cdb
8032 .endd
8033 The appropriate type of lookup is done on the file using the domain name as the
8034 key. In most cases, the data that is looked up is not used; Exim is interested
8035 only in whether or not the key is present in the file. However, when a lookup
8036 is used for the &%domains%& option on a router
8037 or a &%domains%& condition in an ACL statement, the data is preserved in the
8038 &$domain_data$& variable and can be referred to in other router options or
8039 other statements in the same ACL.
8040
8041 .next
8042 Any of the single-key lookup type names may be preceded by
8043 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8044 .code
8045 domains = partial-dbm;/partial/domains
8046 .endd
8047 This causes partial matching logic to be invoked; a description of how this
8048 works is given in section &<<SECTpartiallookup>>&.
8049
8050 .next
8051 .cindex "asterisk" "in lookup type"
8052 Any of the single-key lookup types may be followed by an asterisk. This causes
8053 a default lookup for a key consisting of a single asterisk to be done if the
8054 original lookup fails. This is not a useful feature when using a domain list to
8055 select particular domains (because any domain would match), but it might have
8056 value if the result of the lookup is being used via the &$domain_data$&
8057 expansion variable.
8058 .next
8059 If the pattern starts with the name of a query-style lookup type followed by a
8060 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8061 pattern must be an appropriate query for the lookup type, as described in
8062 chapter &<<CHAPfdlookup>>&. For example:
8063 .code
8064 hold_domains = mysql;select domain from holdlist \
8065   where domain = '${quote_mysql:$domain}';
8066 .endd
8067 In most cases, the data that is looked up is not used (so for an SQL query, for
8068 example, it doesn't matter what field you select). Exim is interested only in
8069 whether or not the query succeeds. However, when a lookup is used for the
8070 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8071 variable and can be referred to in other options.
8072 .next
8073 .cindex "domain list" "matching literal domain name"
8074 If none of the above cases apply, a caseless textual comparison is made
8075 between the pattern and the domain.
8076 .endlist
8077
8078 Here is an example that uses several different kinds of pattern:
8079 .code
8080 domainlist funny_domains = \
8081   @ : \
8082   lib.unseen.edu : \
8083   *.foundation.fict.example : \
8084   \N^[1-2]\d{3}\.fict\.example$\N : \
8085   partial-dbm;/opt/data/penguin/book : \
8086   nis;domains.byname : \
8087   nisplus;[name=$domain,status=local],domains.org_dir
8088 .endd
8089 There are obvious processing trade-offs among the various matching modes. Using
8090 an asterisk is faster than a regular expression, and listing a few names
8091 explicitly probably is too. The use of a file or database lookup is expensive,
8092 but may be the only option if hundreds of names are required. Because the
8093 patterns are tested in order, it makes sense to put the most commonly matched
8094 patterns earlier.
8095
8096
8097
8098 .section "Host lists" "SECThostlist"
8099 .cindex "host list" "patterns in"
8100 .cindex "list" "host list"
8101 Host lists are used to control what remote hosts are allowed to do. For
8102 example, some hosts may be allowed to use the local host as a relay, and some
8103 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8104 two different ways, by name or by IP address. In a host list, some types of
8105 pattern are matched to a host name, and some are matched to an IP address.
8106 You need to be particularly careful with this when single-key lookups are
8107 involved, to ensure that the right value is being used as the key.
8108
8109
8110 .section "Special host list patterns" "SECID80"
8111 .cindex "empty item in hosts list"
8112 .cindex "host list" "empty string in"
8113 If a host list item is the empty string, it matches only when no remote host is
8114 involved. This is the case when a message is being received from a local
8115 process using SMTP on the standard input, that is, when a TCP/IP connection is
8116 not used.
8117
8118 .cindex "asterisk" "in host list"
8119 The special pattern &"*"& in a host list matches any host or no host. Neither
8120 the IP address nor the name is actually inspected.
8121
8122
8123
8124 .section "Host list patterns that match by IP address" "SECThoslispatip"
8125 .cindex "host list" "matching IP addresses"
8126 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8127 the incoming address actually appears in the IPv6 host as
8128 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8129 list, it is converted into a traditional IPv4 address first. (Not all operating
8130 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8131 concerns.)
8132
8133 The following types of pattern in a host list check the remote host by
8134 inspecting its IP address:
8135
8136 .ilist
8137 If the pattern is a plain domain name (not a regular expression, not starting
8138 with *, not a lookup of any kind), Exim calls the operating system function
8139 to find the associated IP address(es). Exim uses the newer
8140 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8141 This typically causes a forward DNS lookup of the name. The result is compared
8142 with the IP address of the subject host.
8143
8144 If there is a temporary problem (such as a DNS timeout) with the host name
8145 lookup, a temporary error occurs. For example, if the list is being used in an
8146 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8147 temporary SMTP error code. If no IP address can be found for the host name,
8148 what happens is described in section &<<SECTbehipnot>>& below.
8149
8150 .next
8151 .cindex "@ in a host list"
8152 If the pattern is &"@"&, the primary host name is substituted and used as a
8153 domain name, as just described.
8154
8155 .next
8156 If the pattern is an IP address, it is matched against the IP address of the
8157 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8158 IPv6 addresses can be given in colon-separated format, but the colons have to
8159 be doubled so as not to be taken as item separators when the default list
8160 separator is used. IPv6 addresses are recognized even when Exim is compiled
8161 without IPv6 support. This means that if they appear in a host list on an
8162 IPv4-only host, Exim will not treat them as host names. They are just addresses
8163 that can never match a client host.
8164
8165 .next
8166 .cindex "@[] in a host list"
8167 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8168 the local host. For example, if the local host is an IPv4 host with one
8169 interface address 10.45.23.56, these two ACL statements have the same effect:
8170 .code
8171 accept hosts = 127.0.0.1 : 10.45.23.56
8172 accept hosts = @[]
8173 .endd
8174 .next
8175 .cindex "CIDR notation"
8176 If the pattern is an IP address followed by a slash and a mask length (for
8177 example 10.11.42.0/24), it is matched against the IP address of the subject
8178 host under the given mask. This allows, an entire network of hosts to be
8179 included (or excluded) by a single item. The mask uses CIDR notation; it
8180 specifies the number of address bits that must match, starting from the most
8181 significant end of the address.
8182
8183 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8184 of a range of addresses. It is the number of bits in the network portion of the
8185 address. The above example specifies a 24-bit netmask, so it matches all 256
8186 addresses in the 10.11.42.0 network. An item such as
8187 .code
8188 192.168.23.236/31
8189 .endd
8190 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8191 32 for an IPv4 address is the same as no mask at all; just a single address
8192 matches.
8193
8194 Here is another example which shows an IPv4 and an IPv6 network:
8195 .code
8196 recipient_unqualified_hosts = 192.168.0.0/16: \
8197                               3ffe::ffff::836f::::/48
8198 .endd
8199 The doubling of list separator characters applies only when these items
8200 appear inline in a host list. It is not required when indirecting via a file.
8201 For example:
8202 .code
8203 recipient_unqualified_hosts = /opt/exim/unqualnets
8204 .endd
8205 could make use of a file containing
8206 .code
8207 172.16.0.0/12
8208 3ffe:ffff:836f::/48
8209 .endd
8210 to have exactly the same effect as the previous example. When listing IPv6
8211 addresses inline, it is usually more convenient to use the facility for
8212 changing separator characters. This list contains the same two networks:
8213 .code
8214 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8215                                  3ffe:ffff:836f::/48
8216 .endd
8217 The separator is changed to semicolon by the leading &"<;"& at the start of the
8218 list.
8219 .endlist
8220
8221
8222
8223 .section "Host list patterns for single-key lookups by host address" &&&
8224          "SECThoslispatsikey"
8225 .cindex "host list" "lookup of IP address"
8226 When a host is to be identified by a single-key lookup of its complete IP
8227 address, the pattern takes this form:
8228 .display
8229 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8230 .endd
8231 For example:
8232 .code
8233 hosts_lookup = net-cdb;/hosts-by-ip.db
8234 .endd
8235 The text form of the IP address of the subject host is used as the lookup key.
8236 IPv6 addresses are converted to an unabbreviated form, using lower case
8237 letters, with dots as separators because colon is the key terminator in
8238 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8239 quoting the keys, but this is a facility that was added later.] The data
8240 returned by the lookup is not used.
8241
8242 .cindex "IP address" "masking"
8243 .cindex "host list" "masked IP address"
8244 Single-key lookups can also be performed using masked IP addresses, using
8245 patterns of this form:
8246 .display
8247 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8248 .endd
8249 For example:
8250 .code
8251 net24-dbm;/networks.db
8252 .endd
8253 The IP address of the subject host is masked using <&'number'&> as the mask
8254 length. A textual string is constructed from the masked value, followed by the
8255 mask, and this is used as the lookup key. For example, if the host's IP address
8256 is 192.168.34.6, the key that is looked up for the above example is
8257 &"192.168.34.0/24"&.
8258
8259 When an IPv6 address is converted to a string, dots are normally used instead
8260 of colons, so that keys in &(lsearch)& files need not contain colons (which
8261 terminate &(lsearch)& keys). This was implemented some time before the ability
8262 to quote keys was made available in &(lsearch)& files. However, the more
8263 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8264 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8265 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8266 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8267 addresses are always used.
8268
8269 Ideally, it would be nice to tidy up this anomalous situation by changing to
8270 colons in all cases, given that quoting is now available for &(lsearch)&.
8271 However, this would be an incompatible change that might break some existing
8272 configurations.
8273
8274 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8275 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8276 the former case the key strings include the mask value, whereas in the latter
8277 case the IP address is used on its own.
8278
8279
8280
8281 .section "Host list patterns that match by host name" "SECThoslispatnam"
8282 .cindex "host" "lookup failures"
8283 .cindex "unknown host name"
8284 .cindex "host list" "matching host name"
8285 There are several types of pattern that require Exim to know the name of the
8286 remote host. These are either wildcard patterns or lookups by name. (If a
8287 complete hostname is given without any wildcarding, it is used to find an IP
8288 address to match against, as described in section &<<SECThoslispatip>>&
8289 above.)
8290
8291 If the remote host name is not already known when Exim encounters one of these
8292 patterns, it has to be found from the IP address.
8293 Although many sites on the Internet are conscientious about maintaining reverse
8294 DNS data for their hosts, there are also many that do not do this.
8295 Consequently, a name cannot always be found, and this may lead to unwanted
8296 effects. Take care when configuring host lists with wildcarded name patterns.
8297 Consider what will happen if a name cannot be found.
8298
8299 Because of the problems of determining host names from IP addresses, matching
8300 against host names is not as common as matching against IP addresses.
8301
8302 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8303 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8304 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8305 are done can be changed by setting the &%host_lookup_order%& option. For
8306 security, once Exim has found one or more names, it looks up the IP addresses
8307 for these names and compares them with the IP address that it started with.
8308 Only those names whose IP addresses match are accepted. Any other names are
8309 discarded. If no names are left, Exim behaves as if the host name cannot be
8310 found. In the most common case there is only one name and one IP address.
8311
8312 There are some options that control what happens if a host name cannot be
8313 found. These are described in section &<<SECTbehipnot>>& below.
8314
8315 .cindex "host" "alias for"
8316 .cindex "alias for host"
8317 As a result of aliasing, hosts may have more than one name. When processing any
8318 of the following types of pattern, all the host's names are checked:
8319
8320 .ilist
8321 .cindex "asterisk" "in host list"
8322 If a pattern starts with &"*"& the remainder of the item must match the end of
8323 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8324 &'.b.c'&. This special simple form is provided because this is a very common
8325 requirement. Other kinds of wildcarding require the use of a regular
8326 expression.
8327 .next
8328 .cindex "regular expressions" "in host list"
8329 .cindex "host list" "regular expression in"
8330 If the item starts with &"^"& it is taken to be a regular expression which is
8331 matched against the host name. Host names are case-independent, so this regular
8332 expression match is by default case-independent, but you can make it
8333 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8334 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8335 example,
8336 .code
8337 ^(a|b)\.c\.d$
8338 .endd
8339 is a regular expression that matches either of the two hosts &'a.c.d'& or
8340 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8341 that backslash and dollar characters are not misinterpreted as part of the
8342 string expansion. The simplest way to do this is to use &`\N`& to mark that
8343 part of the string as non-expandable. For example:
8344 .code
8345 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8346 .endd
8347 &*Warning*&: If you want to match a complete host name, you must include the
8348 &`$`& terminating metacharacter in the regular expression, as in the above
8349 example. Without it, a match at the start of the host name is all that is
8350 required.
8351 .endlist
8352
8353
8354
8355
8356 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8357 .cindex "host" "lookup failures, permanent"
8358 While processing a host list, Exim may need to look up an IP address from a
8359 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8360 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8361 behaviour when it fails to find the information it is seeking is the same.
8362
8363 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8364 apply to temporary DNS errors, whose handling is described in the next section.
8365
8366 .cindex "&`+include_unknown`&"
8367 .cindex "&`+ignore_unknown`&"
8368 Exim parses a host list from left to right. If it encounters a permanent
8369 lookup failure in any item in the host list before it has found a match,
8370 Exim treats it as a failure and the default behavior is as if the host
8371 does not match the list. This may not always be what you want to happen.
8372 To change Exim's behaviour, the special items &`+include_unknown`& or
8373 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8374 not recognized in an indirected file).
8375
8376 .ilist
8377 If any item that follows &`+include_unknown`& requires information that
8378 cannot found, Exim behaves as if the host does match the list. For example,
8379 .code
8380 host_reject_connection = +include_unknown:*.enemy.ex
8381 .endd
8382 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8383 any hosts whose name it cannot find.
8384
8385 .next
8386 If any item that follows &`+ignore_unknown`& requires information that cannot
8387 be found, Exim ignores that item and proceeds to the rest of the list. For
8388 example:
8389 .code
8390 accept hosts = +ignore_unknown : friend.example : \
8391                192.168.4.5
8392 .endd
8393 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8394 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8395 name can be found for 192.168.4.5, it is rejected.
8396 .endlist
8397
8398 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8399 list. The effect of each one lasts until the next, or until the end of the
8400 list.
8401
8402 .section "Mixing wildcarded host names and addresses in host lists" &&&
8403          "SECTmixwilhos"
8404 .cindex "host list" "mixing names and addresses in"
8405
8406 This section explains the host/ip processing logic with the same concepts
8407 as the previous section, but specifically addresses what happens when a
8408 wildcarded hostname is one of the items in the hostlist.
8409
8410 .ilist
8411 If you have name lookups or wildcarded host names and
8412 IP addresses in the same host list, you should normally put the IP
8413 addresses first. For example, in an ACL you could have:
8414 .code
8415 accept hosts = 10.9.8.7 : *.friend.example
8416 .endd
8417 The reason you normally would order it this way lies in the
8418 left-to-right way that Exim processes lists.  It can test IP addresses
8419 without doing any DNS lookups, but when it reaches an item that requires
8420 a host name, it fails if it cannot find a host name to compare with the
8421 pattern. If the above list is given in the opposite order, the
8422 &%accept%& statement fails for a host whose name cannot be found, even
8423 if its IP address is 10.9.8.7.
8424
8425 .next
8426 If you really do want to do the name check first, and still recognize the IP
8427 address, you can rewrite the ACL like this:
8428 .code
8429 accept hosts = *.friend.example
8430 accept hosts = 10.9.8.7
8431 .endd
8432 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8433 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8434 &`+ignore_unknown`&, which was discussed in depth in the first example in
8435 this section.
8436 .endlist
8437
8438
8439 .section "Temporary DNS errors when looking up host information" &&&
8440          "SECTtemdnserr"
8441 .cindex "host" "lookup failures, temporary"
8442 .cindex "&`+include_defer`&"
8443 .cindex "&`+ignore_defer`&"
8444 A temporary DNS lookup failure normally causes a defer action (except when
8445 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8446 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8447 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8448 section. These options should be used with care, probably only in non-critical
8449 host lists such as whitelists.
8450
8451
8452
8453 .section "Host list patterns for single-key lookups by host name" &&&
8454          "SECThoslispatnamsk"
8455 .cindex "unknown host name"
8456 .cindex "host list" "matching host name"
8457 If a pattern is of the form
8458 .display
8459 <&'single-key-search-type'&>;<&'search-data'&>
8460 .endd
8461 for example
8462 .code
8463 dbm;/host/accept/list
8464 .endd
8465 a single-key lookup is performed, using the host name as its key. If the
8466 lookup succeeds, the host matches the item. The actual data that is looked up
8467 is not used.
8468
8469 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8470 keys in the file, not IP addresses. If you want to do lookups based on IP
8471 addresses, you must precede the search type with &"net-"& (see section
8472 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8473 two items in the same list, one doing an address lookup and one doing a name
8474 lookup, both using the same file.
8475
8476
8477
8478 .section "Host list patterns for query-style lookups" "SECID81"
8479 If a pattern is of the form
8480 .display
8481 <&'query-style-search-type'&>;<&'query'&>
8482 .endd
8483 the query is obeyed, and if it succeeds, the host matches the item. The actual
8484 data that is looked up is not used. The variables &$sender_host_address$& and
8485 &$sender_host_name$& can be used in the query. For example:
8486 .code
8487 hosts_lookup = pgsql;\
8488   select ip from hostlist where ip='$sender_host_address'
8489 .endd
8490 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8491 can use the &%sg%& expansion item to change this if you need to. If you want to
8492 use masked IP addresses in database queries, you can use the &%mask%& expansion
8493 operator.
8494
8495 If the query contains a reference to &$sender_host_name$&, Exim automatically
8496 looks up the host name if it has not already done so. (See section
8497 &<<SECThoslispatnam>>& for comments on finding host names.)
8498
8499 Historical note: prior to release 4.30, Exim would always attempt to find a
8500 host name before running the query, unless the search type was preceded by
8501 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8502 still recognized for query-style lookups, but its presence or absence has no
8503 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8504 See section &<<SECThoslispatsikey>>&.)
8505
8506
8507
8508
8509
8510 .section "Address lists" "SECTaddresslist"
8511 .cindex "list" "address list"
8512 .cindex "address list" "empty item"
8513 .cindex "address list" "patterns"
8514 Address lists contain patterns that are matched against mail addresses. There
8515 is one special case to be considered: the sender address of a bounce message is
8516 always empty. You can test for this by providing an empty item in an address
8517 list. For example, you can set up a router to process bounce messages by
8518 using this option setting:
8519 .code
8520 senders = :
8521 .endd
8522 The presence of the colon creates an empty item. If you do not provide any
8523 data, the list is empty and matches nothing. The empty sender can also be
8524 detected by a regular expression that matches an empty string,
8525 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8526
8527 Non-empty items in an address list can be straightforward email addresses. For
8528 example:
8529 .code
8530 senders = jbc@askone.example : hs@anacreon.example
8531 .endd
8532 A certain amount of wildcarding is permitted. If a pattern contains an @
8533 character, but is not a regular expression and does not begin with a
8534 semicolon-terminated lookup type (described below), the local part of the
8535 subject address is compared with the local part of the pattern, which may start
8536 with an asterisk. If the local parts match, the domain is checked in exactly
8537 the same way as for a pattern in a domain list. For example, the domain can be
8538 wildcarded, refer to a named list, or be a lookup:
8539 .code
8540 deny senders = *@*.spamming.site:\
8541                *@+hostile_domains:\
8542                bozo@partial-lsearch;/list/of/dodgy/sites:\
8543                *@dbm;/bad/domains.db
8544 .endd
8545 .cindex "local part" "starting with !"
8546 .cindex "address list" "local part starting with !"
8547 If a local part that begins with an exclamation mark is required, it has to be
8548 specified using a regular expression, because otherwise the exclamation mark is
8549 treated as a sign of negation, as is standard in lists.
8550
8551 If a non-empty pattern that is not a regular expression or a lookup does not
8552 contain an @ character, it is matched against the domain part of the subject
8553 address. The only two formats that are recognized this way are a literal
8554 domain, or a domain pattern that starts with *. In both these cases, the effect
8555 is the same as if &`*@`& preceded the pattern. For example:
8556 .code
8557 deny senders = enemy.domain : *.enemy.domain
8558 .endd
8559
8560 The following kinds of more complicated address list pattern can match any
8561 address, including the empty address that is characteristic of bounce message
8562 senders:
8563
8564 .ilist
8565 .cindex "regular expressions" "in address list"
8566 .cindex "address list" "regular expression in"
8567 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8568 done against the complete address, with the pattern as the regular expression.
8569 You must take care that backslash and dollar characters are not misinterpreted
8570 as part of the string expansion. The simplest way to do this is to use &`\N`&
8571 to mark that part of the string as non-expandable. For example:
8572 .code
8573 deny senders = \N^.*this.*@example\.com$\N : \
8574                \N^\d{8}.+@spamhaus.example$\N : ...
8575 .endd
8576 The &`\N`& sequences are removed by the expansion, so these items do indeed
8577 start with &"^"& by the time they are being interpreted as address patterns.
8578
8579 .next
8580 .cindex "address list" "lookup for complete address"
8581 Complete addresses can be looked up by using a pattern that starts with a
8582 lookup type terminated by a semicolon, followed by the data for the lookup. For
8583 example:
8584 .code
8585 deny senders = cdb;/etc/blocked.senders : \
8586   mysql;select address from blocked where \
8587   address='${quote_mysql:$sender_address}'
8588 .endd
8589 Both query-style and single-key lookup types can be used. For a single-key
8590 lookup type, Exim uses the complete address as the key. However, empty keys are
8591 not supported for single-key lookups, so a match against the empty address
8592 always fails. This restriction does not apply to query-style lookups.
8593
8594 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8595 cannot be used, and is ignored if specified, with an entry being written to the
8596 panic log.
8597 .cindex "*@ with single-key lookup"
8598 However, you can configure lookup defaults, as described in section
8599 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8600 default. For example, with this lookup:
8601 .code
8602 accept senders = lsearch*@;/some/file
8603 .endd
8604 the file could contains lines like this:
8605 .code
8606 user1@domain1.example
8607 *@domain2.example
8608 .endd
8609 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8610 that are tried is:
8611 .code
8612 nimrod@jaeger.example
8613 *@jaeger.example
8614 *
8615 .endd
8616 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8617 would mean that every address matches, thus rendering the test useless.
8618
8619 &*Warning 2*&: Do not confuse these two kinds of item:
8620 .code
8621 deny recipients = dbm*@;/some/file
8622 deny recipients = *@dbm;/some/file
8623 .endd
8624 The first does a whole address lookup, with defaulting, as just described,
8625 because it starts with a lookup type. The second matches the local part and
8626 domain independently, as described in a bullet point below.
8627 .endlist
8628
8629
8630 The following kinds of address list pattern can match only non-empty addresses.
8631 If the subject address is empty, a match against any of these pattern types
8632 always fails.
8633
8634
8635 .ilist
8636 .cindex "@@ with single-key lookup"
8637 .cindex "address list" "@@ lookup type"
8638 .cindex "address list" "split local part and domain"
8639 If a pattern starts with &"@@"& followed by a single-key lookup item
8640 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8641 split into a local part and a domain. The domain is looked up in the file. If
8642 it is not found, there is no match. If it is found, the data that is looked up
8643 from the file is treated as a colon-separated list of local part patterns, each
8644 of which is matched against the subject local part in turn.
8645
8646 .cindex "asterisk" "in address list"
8647 The lookup may be a partial one, and/or one involving a search for a default
8648 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8649 patterns that are looked up can be regular expressions or begin with &"*"&, or
8650 even be further lookups. They may also be independently negated. For example,
8651 with
8652 .code
8653 deny senders = @@dbm;/etc/reject-by-domain
8654 .endd
8655 the data from which the DBM file is built could contain lines like
8656 .code
8657 baddomain.com:  !postmaster : *
8658 .endd
8659 to reject all senders except &%postmaster%& from that domain.
8660
8661 .cindex "local part" "starting with !"
8662 If a local part that actually begins with an exclamation mark is required, it
8663 has to be specified using a regular expression. In &(lsearch)& files, an entry
8664 may be split over several lines by indenting the second and subsequent lines,
8665 but the separating colon must still be included at line breaks. White space
8666 surrounding the colons is ignored. For example:
8667 .code
8668 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8669   spammer3 : spammer4
8670 .endd
8671 As in all colon-separated lists in Exim, a colon can be included in an item by
8672 doubling.
8673
8674 If the last item in the list starts with a right angle-bracket, the remainder
8675 of the item is taken as a new key to look up in order to obtain a continuation
8676 list of local parts. The new key can be any sequence of characters. Thus one
8677 might have entries like
8678 .code
8679 aol.com: spammer1 : spammer 2 : >*
8680 xyz.com: spammer3 : >*
8681 *:       ^\d{8}$
8682 .endd
8683 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8684 local parts for all domains, in addition to the specific local parts listed for
8685 each domain. Of course, using this feature costs another lookup each time a
8686 chain is followed, but the effort needed to maintain the data is reduced.
8687
8688 .cindex "loop" "in lookups"
8689 It is possible to construct loops using this facility, and in order to catch
8690 them, the chains may be no more than fifty items long.
8691
8692 .next
8693 The @@<&'lookup'&> style of item can also be used with a query-style
8694 lookup, but in this case, the chaining facility is not available. The lookup
8695 can only return a single list of local parts.
8696 .endlist
8697
8698 &*Warning*&: There is an important difference between the address list items
8699 in these two examples:
8700 .code
8701 senders = +my_list
8702 senders = *@+my_list
8703 .endd
8704 In the first one, &`my_list`& is a named address list, whereas in the second
8705 example it is a named domain list.
8706
8707
8708
8709
8710 .section "Case of letters in address lists" "SECTcasletadd"
8711 .cindex "case of local parts"
8712 .cindex "address list" "case forcing"
8713 .cindex "case forcing in address lists"
8714 Domains in email addresses are always handled caselessly, but for local parts
8715 case may be significant on some systems (see &%caseful_local_part%& for how
8716 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8717 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8718 blocking lists should be done in a case-independent manner. Since most address
8719 lists in Exim are used for this kind of control, Exim attempts to do this by
8720 default.
8721
8722 The domain portion of an address is always lowercased before matching it to an
8723 address list. The local part is lowercased by default, and any string
8724 comparisons that take place are done caselessly. This means that the data in
8725 the address list itself, in files included as plain file names, and in any file
8726 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8727 keys in files that are looked up by a search type other than &(lsearch)& (which
8728 works caselessly) must be in lower case, because these lookups are not
8729 case-independent.
8730
8731 .cindex "&`+caseful`&"
8732 To allow for the possibility of caseful address list matching, if an item in
8733 an address list is the string &"+caseful"&, the original case of the local
8734 part is restored for any comparisons that follow, and string comparisons are no
8735 longer case-independent. This does not affect the domain, which remains in
8736 lower case. However, although independent matches on the domain alone are still
8737 performed caselessly, regular expressions that match against an entire address
8738 become case-sensitive after &"+caseful"& has been seen.
8739
8740
8741
8742 .section "Local part lists" "SECTlocparlis"
8743 .cindex "list" "local part list"
8744 .cindex "local part" "list"
8745 Case-sensitivity in local part lists is handled in the same way as for address
8746 lists, as just described. The &"+caseful"& item can be used if required. In a
8747 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8748 set false, the subject is lowercased and the matching is initially
8749 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8750 matching in the local part list, but not elsewhere in the router. If
8751 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8752 option is case-sensitive from the start.
8753
8754 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8755 comments are handled in the same way as address lists &-- they are recognized
8756 only if the # is preceded by white space or the start of the line.
8757 Otherwise, local part lists are matched in the same way as domain lists, except
8758 that the special items that refer to the local host (&`@`&, &`@[]`&,
8759 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8760 Refer to section &<<SECTdomainlist>>& for details of the other available item
8761 types.
8762 .ecindex IIDdohoadli
8763
8764
8765
8766
8767 . ////////////////////////////////////////////////////////////////////////////
8768 . ////////////////////////////////////////////////////////////////////////////
8769
8770 .chapter "String expansions" "CHAPexpand"
8771 .scindex IIDstrexp "expansion" "of strings"
8772 Many strings in Exim's run time configuration are expanded before use. Some of
8773 them are expanded every time they are used; others are expanded only once.
8774
8775 When a string is being expanded it is copied verbatim from left to right except
8776 when a dollar or backslash character is encountered. A dollar specifies the
8777 start of a portion of the string that is interpreted and replaced as described
8778 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8779 escape character, as described in the following section.
8780
8781 Whether a string is expanded depends upon the context.  Usually this is solely
8782 dependent upon the option for which a value is sought; in this documentation,
8783 options for which string expansion is performed are marked with &dagger; after
8784 the data type.  ACL rules always expand strings.  A couple of expansion
8785 conditions do not expand some of the brace-delimited branches, for security
8786 reasons.
8787
8788
8789
8790 .section "Literal text in expanded strings" "SECTlittext"
8791 .cindex "expansion" "including literal text"
8792 An uninterpreted dollar can be included in an expanded string by putting a
8793 backslash in front of it. A backslash can be used to prevent any special
8794 character being treated specially in an expansion, including backslash itself.
8795 If the string appears in quotes in the configuration file, two backslashes are
8796 required because the quotes themselves cause interpretation of backslashes when
8797 the string is read in (see section &<<SECTstrings>>&).
8798
8799 .cindex "expansion" "non-expandable substrings"
8800 A portion of the string can specified as non-expandable by placing it between
8801 two occurrences of &`\N`&. This is particularly useful for protecting regular
8802 expressions, which often contain backslashes and dollar signs. For example:
8803 .code
8804 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8805 .endd
8806 On encountering the first &`\N`&, the expander copies subsequent characters
8807 without interpretation until it reaches the next &`\N`& or the end of the
8808 string.
8809
8810
8811
8812 .section "Character escape sequences in expanded strings" "SECID82"
8813 .cindex "expansion" "escape sequences"
8814 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8815 expanded string is recognized as an escape sequence for the character newline,
8816 carriage return, or tab, respectively. A backslash followed by up to three
8817 octal digits is recognized as an octal encoding for a single character, and a
8818 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8819 encoding.
8820
8821 These escape sequences are also recognized in quoted strings when they are read
8822 in. Their interpretation in expansions as well is useful for unquoted strings,
8823 and for other cases such as looked-up strings that are then expanded.
8824
8825
8826 .section "Testing string expansions" "SECID83"
8827 .cindex "expansion" "testing"
8828 .cindex "testing" "string expansion"
8829 .oindex "&%-be%&"
8830 Many expansions can be tested by calling Exim with the &%-be%& option. This
8831 takes the command arguments, or lines from the standard input if there are no
8832 arguments, runs them through the string expansion code, and writes the results
8833 to the standard output. Variables based on configuration values are set up, but
8834 since no message is being processed, variables such as &$local_part$& have no
8835 value. Nevertheless the &%-be%& option can be useful for checking out file and
8836 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8837 and &%nhash%&.
8838
8839 Exim gives up its root privilege when it is called with the &%-be%& option, and
8840 instead runs under the uid and gid it was called with, to prevent users from
8841 using &%-be%& for reading files to which they do not have access.
8842
8843 .oindex "&%-bem%&"
8844 If you want to test expansions that include variables whose values are taken
8845 from a message, there are two other options that can be used. The &%-bem%&
8846 option is like &%-be%& except that it is followed by a file name. The file is
8847 read as a message before doing the test expansions. For example:
8848 .code
8849 exim -bem /tmp/test.message '$h_subject:'
8850 .endd
8851 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8852 Exim message identifier. For example:
8853 .code
8854 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8855 .endd
8856 This loads the message from Exim's spool before doing the test expansions, and
8857 is therefore restricted to admin users.
8858
8859
8860 .section "Forced expansion failure" "SECTforexpfai"
8861 .cindex "expansion" "forced failure"
8862 A number of expansions that are described in the following section have
8863 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8864 (which are sometimes called &"curly brackets"&). Which of the two strings is
8865 used depends on some condition that is evaluated as part of the expansion. If,
8866 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8867 the entire string expansion fails in a way that can be detected by the code
8868 that requested the expansion. This is called &"forced expansion failure"&, and
8869 its consequences depend on the circumstances. In some cases it is no different
8870 from any other expansion failure, but in others a different action may be
8871 taken. Such variations are mentioned in the documentation of the option that is
8872 being expanded.
8873
8874
8875
8876
8877 .section "Expansion items" "SECTexpansionitems"
8878 The following items are recognized in expanded strings. White space may be used
8879 between sub-items that are keywords or substrings enclosed in braces inside an
8880 outer set of braces, to improve readability. &*Warning*&: Within braces,
8881 white space is significant.
8882
8883 .vlist
8884 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8885 .cindex "expansion" "variables"
8886 Substitute the contents of the named variable, for example:
8887 .code
8888 $local_part
8889 ${domain}
8890 .endd
8891 The second form can be used to separate the name from subsequent alphanumeric
8892 characters. This form (using braces) is available only for variables; it does
8893 &'not'& apply to message headers. The names of the variables are given in
8894 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8895 given, the expansion fails.
8896
8897 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8898 .cindex "expansion" "operators"
8899 The string is first itself expanded, and then the operation specified by
8900 <&'op'&> is applied to it. For example:
8901 .code
8902 ${lc:$local_part}
8903 .endd
8904 The string starts with the first character after the colon, which may be
8905 leading white space. A list of operators is given in section &<<SECTexpop>>&
8906 below. The operator notation is used for simple expansion items that have just
8907 one argument, because it reduces the number of braces and therefore makes the
8908 string easier to understand.
8909
8910 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8911 This item inserts &"basic"& header lines. It is described with the &%header%&
8912 expansion item below.
8913
8914
8915 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8916 .cindex "expansion" "calling an acl"
8917 .cindex "&%acl%&" "call from expansion"
8918 The name and zero to nine argument strings are first expanded separately.  The expanded
8919 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8920 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8921 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8922 and may use the variables; if another acl expansion is used the values
8923 are restored after it returns.  If the ACL sets
8924 a value using a "message =" modifier and returns accept or deny, the value becomes
8925 the result of the expansion.
8926 If no message is set and the ACL returns accept or deny
8927 the expansion result is an empty string.
8928 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8929
8930
8931 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8932        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8933 .cindex "expansion" "extracting cerificate fields"
8934 .cindex "&%certextract%&" "certificate fields"
8935 .cindex "certificate" "extracting fields"
8936 The <&'certificate'&> must be a variable of type certificate.
8937 The field name is expanded and used to retrive the relevant field from
8938 the certificate.  Supported fields are:
8939 .display
8940 &`version        `&
8941 &`serial_number  `&
8942 &`subject        `& RFC4514 DN
8943 &`issuer         `& RFC4514 DN
8944 &`notbefore      `& time
8945 &`notafter       `& time
8946 &`sig_algorithm  `&
8947 &`signature      `&
8948 &`subj_altname   `& tagged list
8949 &`ocsp_uri       `& list
8950 &`crl_uri        `& list
8951 .endd
8952 If the field is found,
8953 <&'string2'&> is expanded, and replaces the whole item;
8954 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8955 variable &$value$& contains the value that has been extracted. Afterwards, it
8956 is restored to any previous value it might have had.
8957
8958 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8959 key is not found. If {<&'string2'&>} is also omitted, the value that was
8960 extracted is used.
8961
8962 Some field names take optional modifiers, appended and separated by commas.
8963
8964 The field selectors marked as "RFC4514" above
8965 output a Distinguished Name string which is
8966 not quite
8967 parseable by Exim as a comma-separated tagged list
8968 (the exceptions being elements containing commas).
8969 RDN elements of a single type may be selected by
8970 a modifier of the type label; if so the expansion
8971 result is a list (newline-separated by default).
8972 The separator may be changed by another modifer of
8973 a right angle-bracket followed immediately by the new separator.
8974 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8975
8976 The field selectors marked as "time" above
8977 take an optional modifier of "int"
8978 for which the result is the number of seconds since epoch.
8979 Otherwise the result is a human-readable string
8980 in the timezone selected by the main "timezone" option.
8981
8982 The field selectors marked as "list" above return a list,
8983 newline-separated by default,
8984 (embedded separator characters in elements are doubled).
8985 The separator may be changed by a modifier of
8986 a right angle-bracket followed immediately by the new separator.
8987
8988 The field selectors marked as "tagged" above
8989 prefix each list element with a type string and an equals sign.
8990 Elements of only one type may be selected by a modifier
8991 which is one of "dns", "uri" or "mail";
8992 if so the elenment tags are omitted.
8993
8994 If not otherwise noted field values are presented in human-readable form.
8995
8996 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8997        {*&<&'arg'&>&*}...}*&"
8998 .cindex &%dlfunc%&
8999 This expansion dynamically loads and then calls a locally-written C function.
9000 This functionality is available only if Exim is compiled with
9001 .code
9002 EXPAND_DLFUNC=yes
9003 .endd
9004 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9005 object so that it doesn't reload the same object file in the same Exim process
9006 (but of course Exim does start new processes frequently).
9007
9008 There may be from zero to eight arguments to the function. When compiling
9009 a local function that is to be called in this way, &_local_scan.h_& should be
9010 included. The Exim variables and functions that are defined by that API
9011 are also available for dynamically loaded functions. The function itself
9012 must have the following type:
9013 .code
9014 int dlfunction(uschar **yield, int argc, uschar *argv[])
9015 .endd
9016 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9017 function should return one of the following values:
9018
9019 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9020 into the expanded string that is being built.
9021
9022 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9023 from &'yield'&, if it is set.
9024
9025 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9026 taken from &'yield'& if it is set.
9027
9028 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9029
9030 When compiling a function that is to be used in this way with gcc,
9031 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9032 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9033
9034
9035 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9036 .cindex "expansion" "extracting value from environment"
9037 .cindex "environment" "value from"
9038 The key is first expanded separately, and leading and trailing white space
9039 removed.
9040 This is then searched for as a name in the environment.
9041 If a variable is found then its value is placed in &$value$&
9042 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9043
9044 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9045 appear, for example:
9046 .code
9047 ${env{USER}{$value} fail }
9048 .endd
9049 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9050 {<&'string1'&>} must be present for &"fail"& to be recognized.
9051
9052 If {<&'string2'&>} is omitted an empty string is substituted on 
9053 search failure.
9054 If {<&'string1'&>} is omitted the search result is substituted on
9055 search success.
9056
9057
9058 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9059        {*&<&'string3'&>&*}}*&"
9060 .cindex "expansion" "extracting substrings by key"
9061 .cindex "&%extract%&" "substrings by key"
9062 The key and <&'string1'&> are first expanded separately. Leading and trailing
9063 white space is removed from the key (but not from any of the strings). The key
9064 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9065 form:
9066 .display
9067 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9068 .endd
9069 .vindex "&$value$&"
9070 where the equals signs and spaces (but not both) are optional. If any of the
9071 values contain white space, they must be enclosed in double quotes, and any
9072 values that are enclosed in double quotes are subject to escape processing as
9073 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9074 for the value that corresponds to the key. The search is case-insensitive. If
9075 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9076 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9077 variable &$value$& contains the value that has been extracted. Afterwards, it
9078 is restored to any previous value it might have had.
9079
9080 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9081 key is not found. If {<&'string2'&>} is also omitted, the value that was
9082 extracted is used. Thus, for example, these two expansions are identical, and
9083 yield &"2001"&:
9084 .code
9085 ${extract{gid}{uid=1984 gid=2001}}
9086 ${extract{gid}{uid=1984 gid=2001}{$value}}
9087 .endd
9088 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9089 appear, for example:
9090 .code
9091 ${extract{Z}{A=... B=...}{$value} fail }
9092 .endd
9093 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9094 {<&'string2'&>} must be present for &"fail"& to be recognized.
9095
9096
9097 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9098         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9099 .cindex "expansion" "extracting substrings by number"
9100 .cindex "&%extract%&" "substrings by number"
9101 The <&'number'&> argument must consist entirely of decimal digits,
9102 apart from leading and trailing white space, which is ignored.
9103 This is what distinguishes this form of &%extract%& from the previous kind. It
9104 behaves in the same way, except that, instead of extracting a named field, it
9105 extracts from <&'string1'&> the field whose number is given as the first
9106 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9107 <&'string3'&> as before.
9108
9109 The fields in the string are separated by any one of the characters in the
9110 separator string. These may include space or tab characters.
9111 The first field is numbered one. If the number is negative, the fields are
9112 counted from the end of the string, with the rightmost one numbered -1. If the
9113 number given is zero, the entire string is returned. If the modulus of the
9114 number is greater than the number of fields in the string, the result is the
9115 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9116 provided. For example:
9117 .code
9118 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9119 .endd
9120 yields &"42"&, and
9121 .code
9122 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9123 .endd
9124 yields &"99"&. Two successive separators mean that the field between them is
9125 empty (for example, the fifth field above).
9126
9127
9128 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9129 .cindex "list" "selecting by condition"
9130 .cindex "expansion" "selecting from list by condition"
9131 .vindex "&$item$&"
9132 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9133 default, but the separator can be changed in the usual way. For each item
9134 in this list, its value is place in &$item$&, and then the condition is
9135 evaluated. If the condition is true, &$item$& is added to the output as an
9136 item in a new list; if the condition is false, the item is discarded. The
9137 separator used for the output list is the same as the one used for the
9138 input, but a separator setting is not included in the output. For example:
9139 .code
9140 ${filter{a:b:c}{!eq{$item}{b}}
9141 .endd
9142 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9143 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9144
9145
9146 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9147 .cindex "hash function" "textual"
9148 .cindex "expansion" "textual hash"
9149 This is a textual hashing function, and was the first to be implemented in
9150 early versions of Exim. In current releases, there are other hashing functions
9151 (numeric, MD5, and SHA-1), which are described below.
9152
9153 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9154 <&'n'&>. If you are using fixed values for these numbers, that is, if
9155 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9156 use the simpler operator notation that avoids some of the braces:
9157 .code
9158 ${hash_<n>_<m>:<string>}
9159 .endd
9160 The second number is optional (in both notations). If <&'n'&> is greater than
9161 or equal to the length of the string, the expansion item returns the string.
9162 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9163 function to the string. The new string consists of characters taken from the
9164 first <&'m'&> characters of the string
9165 .code
9166 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9167 .endd
9168 If <&'m'&> is not present the value 26 is used, so that only lower case
9169 letters appear. For example:
9170 .display
9171 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9172 &`$hash{5}{monty}}           `&   yields  &`monty`&
9173 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9174 .endd
9175
9176 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9177         &*$h_*&<&'header&~name'&>&*:*&" &&&
9178        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9179         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9180        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9181         &*$rh_*&<&'header&~name'&>&*:*&"
9182 .cindex "expansion" "header insertion"
9183 .vindex "&$header_$&"
9184 .vindex "&$bheader_$&"
9185 .vindex "&$rheader_$&"
9186 .cindex "header lines" "in expansion strings"
9187 .cindex "header lines" "character sets"
9188 .cindex "header lines" "decoding"
9189 Substitute the contents of the named message header line, for example
9190 .code
9191 $header_reply-to:
9192 .endd
9193 The newline that terminates a header line is not included in the expansion, but
9194 internal newlines (caused by splitting the header line over several physical
9195 lines) may be present.
9196
9197 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9198 the data in the header line is interpreted.
9199
9200 .ilist
9201 .cindex "white space" "in header lines"
9202 &%rheader%& gives the original &"raw"& content of the header line, with no
9203 processing at all, and without the removal of leading and trailing white space.
9204
9205 .next
9206 .cindex "base64 encoding" "in header lines"
9207 &%bheader%& removes leading and trailing white space, and then decodes base64
9208 or quoted-printable MIME &"words"& within the header text, but does no
9209 character set translation. If decoding of what looks superficially like a MIME
9210 &"word"& fails, the raw string is returned. If decoding
9211 .cindex "binary zero" "in header line"
9212 produces a binary zero character, it is replaced by a question mark &-- this is
9213 what Exim does for binary zeros that are actually received in header lines.
9214
9215 .next
9216 &%header%& tries to translate the string as decoded by &%bheader%& to a
9217 standard character set. This is an attempt to produce the same string as would
9218 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9219 returned. Translation is attempted only on operating systems that support the
9220 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9221 a system Makefile or in &_Local/Makefile_&.
9222 .endlist ilist
9223
9224 In a filter file, the target character set for &%header%& can be specified by a
9225 command of the following form:
9226 .code
9227 headers charset "UTF-8"
9228 .endd
9229 This command affects all references to &$h_$& (or &$header_$&) expansions in
9230 subsequently obeyed filter commands. In the absence of this command, the target
9231 character set in a filter is taken from the setting of the &%headers_charset%&
9232 option in the runtime configuration. The value of this option defaults to the
9233 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9234 ISO-8859-1.
9235
9236 Header names follow the syntax of RFC 2822, which states that they may contain
9237 any printing characters except space and colon. Consequently, curly brackets
9238 &'do not'& terminate header names, and should not be used to enclose them as
9239 if they were variables. Attempting to do so causes a syntax error.
9240
9241 Only header lines that are common to all copies of a message are visible to
9242 this mechanism. These are the original header lines that are received with the
9243 message, and any that are added by an ACL statement or by a system
9244 filter. Header lines that are added to a particular copy of a message by a
9245 router or transport are not accessible.
9246
9247 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9248 before the DATA ACL, because the header structure is not set up until the
9249 message is received. Header lines that are added in a RCPT ACL (for example)
9250 are saved until the message's incoming header lines are available, at which
9251 point they are added. When a DATA ACL is running, however, header lines added
9252 by earlier ACLs are visible.
9253
9254 Upper case and lower case letters are synonymous in header names. If the
9255 following character is white space, the terminating colon may be omitted, but
9256 this is not recommended, because you may then forget it when it is needed. When
9257 white space terminates the header name, it is included in the expanded string.
9258 If the message does not contain the given header, the expansion item is
9259 replaced by an empty string. (See the &%def%& condition in section
9260 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9261
9262 If there is more than one header with the same name, they are all concatenated
9263 to form the substitution string, up to a maximum length of 64K. Unless
9264 &%rheader%& is being used, leading and trailing white space is removed from
9265 each header before concatenation, and a completely empty header is ignored. A
9266 newline character is then inserted between non-empty headers, but there is no
9267 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9268 those headers that contain lists of addresses, a comma is also inserted at the
9269 junctions between headers. This does not happen for the &%rheader%& expansion.
9270
9271
9272 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9273 .cindex "expansion" "hmac hashing"
9274 .cindex &%hmac%&
9275 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9276 shared secret and some text into a message authentication code, as specified in
9277 RFC 2104. This differs from &`${md5:secret_text...}`& or
9278 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9279 cryptographic hash, allowing for authentication that is not possible with MD5
9280 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9281 present. For example:
9282 .code
9283 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9284 .endd
9285 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9286 produces:
9287 .code
9288 dd97e3ba5d1a61b5006108f8c8252953
9289 .endd
9290 As an example of how this might be used, you might put in the main part of
9291 an Exim configuration:
9292 .code
9293 SPAMSCAN_SECRET=cohgheeLei2thahw
9294 .endd
9295 In a router or a transport you could then have:
9296 .code
9297 headers_add = \
9298   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9299   ${hmac{md5}{SPAMSCAN_SECRET}\
9300   {${primary_hostname},${message_exim_id},$h_message-id:}}
9301 .endd
9302 Then given a message, you can check where it was scanned by looking at the
9303 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9304 this header line is authentic by recomputing the authentication code from the
9305 host name, message ID and the &'Message-id:'& header line. This can be done
9306 using Exim's &%-be%& option, or by other means, for example by using the
9307 &'hmac_md5_hex()'& function in Perl.
9308
9309
9310 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9311 .cindex "expansion" "conditional"
9312 .cindex "&%if%&, expansion item"
9313 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9314 item; otherwise <&'string2'&> is used. The available conditions are described
9315 in section &<<SECTexpcond>>& below. For example:
9316 .code
9317 ${if eq {$local_part}{postmaster} {yes}{no} }
9318 .endd
9319 The second string need not be present; if it is not and the condition is not
9320 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9321 be present instead of the second string (without any curly brackets). In this
9322 case, the expansion is forced to fail if the condition is not true (see section
9323 &<<SECTforexpfai>>&).
9324
9325 If both strings are omitted, the result is the string &`true`& if the condition
9326 is true, and the empty string if the condition is false. This makes it less
9327 cumbersome to write custom ACL and router conditions. For example, instead of
9328 .code
9329 condition = ${if >{$acl_m4}{3}{true}{false}}
9330 .endd
9331 you can use
9332 .code
9333 condition = ${if >{$acl_m4}{3}}
9334 .endd
9335
9336 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9337 .cindex "expansion" "string truncation"
9338 .cindex "&%length%& expansion item"
9339 The &%length%& item is used to extract the initial portion of a string. Both
9340 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9341 you are using a fixed value for the number, that is, if <&'string1'&> does not
9342 change when expanded, you can use the simpler operator notation that avoids
9343 some of the braces:
9344 .code
9345 ${length_<n>:<string>}
9346 .endd
9347 The result of this item is either the first <&'n'&> characters or the whole
9348 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9349 &%strlen%&, which gives the length of a string.
9350
9351
9352 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9353         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9354 .cindex "expansion" "extracting list elements by number"
9355 .cindex "&%listextract%&" "extract list elements by number"
9356 .cindex "list" "extracting elements by number"
9357 The <&'number'&> argument must consist entirely of decimal digits,
9358 apart from an optional leading minus,
9359 and leading and trailing white space (which is ignored).
9360
9361 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9362 default, but the separator can be changed in the usual way.
9363
9364 The first field of the list is numbered one.
9365 If the number is negative, the fields are
9366 counted from the end of the list, with the rightmost one numbered -1.
9367 The numbered element of the list is extracted and placed in &$value$&,
9368 then <&'string2'&> is expanded as the result.
9369
9370 If the modulus of the
9371 number is zero or greater than the number of fields in the string,
9372 the result is the expansion of <&'string3'&>.
9373
9374 For example:
9375 .code
9376 ${listextract{2}{x:42:99}}
9377 .endd
9378 yields &"42"&, and
9379 .code
9380 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9381 .endd
9382 yields &"result: 99"&.
9383
9384 If {<&'string3'&>} is omitted, an empty string is used for string3.
9385 If {<&'string2'&>} is also omitted, the value that was
9386 extracted is used.
9387 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9388
9389
9390 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9391         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9392 This is the first of one of two different types of lookup item, which are both
9393 described in the next item.
9394
9395 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9396         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9397 .cindex "expansion" "lookup in"
9398 .cindex "file" "lookups"
9399 .cindex "lookup" "in expanded string"
9400 The two forms of lookup item specify data lookups in files and databases, as
9401 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9402 lookups, and the second is used for query-style lookups. The <&'key'&>,
9403 <&'file'&>, and <&'query'&> strings are expanded before use.
9404
9405 If there is any white space in a lookup item which is part of a filter command,
9406 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9407 other place where white space is significant, the lookup item must be enclosed
9408 in double quotes. The use of data lookups in users' filter files may be locked
9409 out by the system administrator.
9410
9411 .vindex "&$value$&"
9412 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9413 During its expansion, the variable &$value$& contains the data returned by the
9414 lookup. Afterwards it reverts to the value it had previously (at the outer
9415 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9416 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9417 string on failure. If <&'string2'&> is provided, it can itself be a nested
9418 lookup, thus providing a mechanism for looking up a default value when the
9419 original lookup fails.
9420
9421 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9422 data for the outer lookup while the parameters of the second lookup are
9423 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9424 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9425 appear, and in this case, if the lookup fails, the entire expansion is forced
9426 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9427 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9428 successful lookup, and nothing in the case of failure.
9429
9430 For single-key lookups, the string &"partial"& is permitted to precede the
9431 search type in order to do partial matching, and * or *@ may follow a search
9432 type to request default lookups if the key does not match (see sections
9433 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9434
9435 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9436 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9437 and non-wild parts of the key during the expansion of the replacement text.
9438 They return to their previous values at the end of the lookup item.
9439
9440 This example looks up the postmaster alias in the conventional alias file:
9441 .code
9442 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9443 .endd
9444 This example uses NIS+ to look up the full name of the user corresponding to
9445 the local part of an address, forcing the expansion to fail if it is not found:
9446 .code
9447 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9448   {$value}fail}
9449 .endd
9450
9451
9452 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9453 .cindex "expansion" "list creation"
9454 .vindex "&$item$&"
9455 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9456 default, but the separator can be changed in the usual way. For each item
9457 in this list, its value is place in &$item$&, and then <&'string2'&> is
9458 expanded and added to the output as an item in a new list. The separator used
9459 for the output list is the same as the one used for the input, but a separator
9460 setting is not included in the output. For example:
9461 .code
9462 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9463 .endd
9464 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9465 value of &$item$& is restored to what it was before. See also the &*filter*&
9466 and &*reduce*& expansion items.
9467
9468 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9469 .cindex "expansion" "numeric hash"
9470 .cindex "hash function" "numeric"
9471 The three strings are expanded; the first two must yield numbers. Call them
9472 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9473 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9474 can use the simpler operator notation that avoids some of the braces:
9475 .code
9476 ${nhash_<n>_<m>:<string>}
9477 .endd
9478 The second number is optional (in both notations). If there is only one number,
9479 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9480 processed by a div/mod hash function that returns two numbers, separated by a
9481 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9482 example,
9483 .code
9484 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9485 .endd
9486 returns the string &"6/33"&.
9487
9488
9489
9490 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9491 .cindex "Perl" "use in expanded string"
9492 .cindex "expansion" "calling Perl from"
9493 This item is available only if Exim has been built to include an embedded Perl
9494 interpreter. The subroutine name and the arguments are first separately
9495 expanded, and then the Perl subroutine is called with those arguments. No
9496 additional arguments need be given; the maximum number permitted, including the
9497 name of the subroutine, is nine.
9498
9499 The return value of the subroutine is inserted into the expanded string, unless
9500 the return value is &%undef%&. In that case, the expansion fails in the same
9501 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9502 Whatever you return is evaluated in a scalar context. For example, if you
9503 return the name of a Perl vector, the return value is the size of the vector,
9504 not its contents.
9505
9506 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9507 with the error message that was passed to &%die%&. More details of the embedded
9508 Perl facility are given in chapter &<<CHAPperl>>&.
9509
9510 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9511 out the use of this expansion item in filter files.
9512
9513
9514 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9515 .cindex "&%prvs%& expansion item"
9516 The first argument is a complete email address and the second is secret
9517 keystring. The third argument, specifying a key number, is optional. If absent,
9518 it defaults to 0. The result of the expansion is a prvs-signed email address,
9519 to be typically used with the &%return_path%& option on an &(smtp)& transport
9520 as part of a bounce address tag validation (BATV) scheme. For more discussion
9521 and an example, see section &<<SECTverifyPRVS>>&.
9522
9523 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9524         {*&<&'string'&>&*}}*&"
9525 .cindex "&%prvscheck%& expansion item"
9526 This expansion item is the complement of the &%prvs%& item. It is used for
9527 checking prvs-signed addresses. If the expansion of the first argument does not
9528 yield a syntactically valid prvs-signed address, the whole item expands to the
9529 empty string. When the first argument does expand to a syntactically valid
9530 prvs-signed address, the second argument is expanded, with the prvs-decoded
9531 version of the address and the key number extracted from the address in the
9532 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9533
9534 These two variables can be used in the expansion of the second argument to
9535 retrieve the secret. The validity of the prvs-signed address is then checked
9536 against the secret. The result is stored in the variable &$prvscheck_result$&,
9537 which is empty for failure or &"1"& for success.
9538
9539 The third argument is optional; if it is missing, it defaults to an empty
9540 string. This argument is now expanded. If the result is an empty string, the
9541 result of the expansion is the decoded version of the address. This is the case
9542 whether or not the signature was valid. Otherwise, the result of the expansion
9543 is the expansion of the third argument.
9544
9545 All three variables can be used in the expansion of the third argument.
9546 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9547 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9548
9549 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9550 .cindex "expansion" "inserting an entire file"
9551 .cindex "file" "inserting into expansion"
9552 .cindex "&%readfile%& expansion item"
9553 The file name and end-of-line string are first expanded separately. The file is
9554 then read, and its contents replace the entire item. All newline characters in
9555 the file are replaced by the end-of-line string if it is present. Otherwise,
9556 newlines are left in the string.
9557 String expansion is not applied to the contents of the file. If you want this,
9558 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9559 the string expansion fails.
9560
9561 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9562 locks out the use of this expansion item in filter files.
9563
9564
9565
9566 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9567         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9568 .cindex "expansion" "inserting from a socket"
9569 .cindex "socket, use of in expansion"
9570 .cindex "&%readsocket%& expansion item"
9571 This item inserts data from a Unix domain or TCP socket into the expanded
9572 string. The minimal way of using it uses just two arguments, as in these
9573 examples:
9574 .code
9575 ${readsocket{/socket/name}{request string}}
9576 ${readsocket{inet:some.host:1234}{request string}}
9577 .endd
9578 For a Unix domain socket, the first substring must be the path to the socket.
9579 For an Internet socket, the first substring must contain &`inet:`& followed by
9580 a host name or IP address, followed by a colon and a port, which can be a
9581 number or the name of a TCP port in &_/etc/services_&. An IP address may
9582 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9583 example:
9584 .code
9585 ${readsocket{inet:[::1]:1234}{request string}}
9586 .endd
9587 Only a single host name may be given, but if looking it up yields more than
9588 one IP address, they are each tried in turn until a connection is made. For
9589 both kinds of socket, Exim makes a connection, writes the request string
9590 (unless it is an empty string) and reads from the socket until an end-of-file
9591 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9592 extend what can be done. Firstly, you can vary the timeout. For example:
9593 .code
9594 ${readsocket{/socket/name}{request string}{3s}}
9595 .endd
9596 A fourth argument allows you to change any newlines that are in the data
9597 that is read, in the same way as for &%readfile%& (see above). This example
9598 turns them into spaces:
9599 .code
9600 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9601 .endd
9602 As with all expansions, the substrings are expanded before the processing
9603 happens. Errors in these sub-expansions cause the expansion to fail. In
9604 addition, the following errors can occur:
9605
9606 .ilist
9607 Failure to create a socket file descriptor;
9608 .next
9609 Failure to connect the socket;
9610 .next
9611 Failure to write the request string;
9612 .next
9613 Timeout on reading from the socket.
9614 .endlist
9615
9616 By default, any of these errors causes the expansion to fail. However, if
9617 you supply a fifth substring, it is expanded and used when any of the above
9618 errors occurs. For example:
9619 .code
9620 ${readsocket{/socket/name}{request string}{3s}{\n}\
9621   {socket failure}}
9622 .endd
9623 You can test for the existence of a Unix domain socket by wrapping this
9624 expansion in &`${if exists`&, but there is a race condition between that test
9625 and the actual opening of the socket, so it is safer to use the fifth argument
9626 if you want to be absolutely sure of avoiding an expansion error for a
9627 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9628
9629 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9630 locks out the use of this expansion item in filter files.
9631
9632
9633 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9634 .cindex "expansion" "reducing a list to a scalar"
9635 .cindex "list" "reducing to a scalar"
9636 .vindex "&$value$&"
9637 .vindex "&$item$&"
9638 This operation reduces a list to a single, scalar string. After expansion,
9639 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9640 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9641 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9642 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9643 them. The result of that expansion is assigned to &$value$& before the next
9644 iteration. When the end of the list is reached, the final value of &$value$& is
9645 added to the expansion output. The &*reduce*& expansion item can be used in a
9646 number of ways. For example, to add up a list of numbers:
9647 .code
9648 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9649 .endd
9650 The result of that expansion would be &`6`&. The maximum of a list of numbers
9651 can be found:
9652 .code
9653 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9654 .endd
9655 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9656 restored to what they were before. See also the &*filter*& and &*map*&
9657 expansion items.
9658
9659 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9660 This item inserts &"raw"& header lines. It is described with the &%header%&
9661 expansion item above.
9662
9663 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9664         {*&<&'string2'&>&*}}*&"
9665 .cindex "expansion" "running a command"
9666 .cindex "&%run%& expansion item"
9667 The command and its arguments are first expanded as one string. The string is
9668 split apart into individual arguments by spaces, and then the command is run
9669 in a separate process, but under the same uid and gid.  As in other command
9670 executions from Exim, a shell is not used by default. If the command requires
9671 a shell, you must explicitly code it.
9672
9673 Since the arguments are split by spaces, when there is a variable expansion
9674 which has an empty result, it will cause the situation that the argument will
9675 simply be omitted when the program is actually executed by Exim. If the
9676 script/program requires a specific number of arguments and the expanded
9677 variable could possibly result in this empty expansion, the variable must be
9678 quoted. This is more difficult if the expanded variable itself could result
9679 in a string containing quotes, because it would interfere with the quotes
9680 around the command arguments. A possible guard against this is to wrap the
9681 variable in the &%sg%& operator to change any quote marks to some other
9682 character.
9683
9684 The standard input for the command exists, but is empty. The standard output
9685 and standard error are set to the same file descriptor.
9686 .cindex "return code" "from &%run%& expansion"
9687 .vindex "&$value$&"
9688 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9689 and replaces the entire item; during this expansion, the standard output/error
9690 from the command is in the variable &$value$&. If the command fails,
9691 <&'string2'&>, if present, is expanded and used. Once again, during the
9692 expansion, the standard output/error from the command is in the variable
9693 &$value$&.
9694
9695 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9696 can be the word &"fail"& (not in braces) to force expansion failure if the
9697 command does not succeed. If both strings are omitted, the result is contents
9698 of the standard output/error on success, and nothing on failure.
9699
9700 .vindex "&$run_in_acl$&"
9701 The standard output/error of the command is put in the variable &$value$&.
9702 In this ACL example, the output of a command is logged for the admin to
9703 troubleshoot:
9704 .code
9705 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9706       log_message  = Output of id: $value
9707 .endd
9708 If the command requires shell idioms, such as the > redirect operator, the
9709 shell must be invoked directly, such as with:
9710 .code
9711 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9712 .endd
9713
9714 .vindex "&$runrc$&"
9715 The return code from the command is put in the variable &$runrc$&, and this
9716 remains set afterwards, so in a filter file you can do things like this:
9717 .code
9718 if "${run{x y z}{}}$runrc" is 1 then ...
9719   elif $runrc is 2 then ...
9720   ...
9721 endif
9722 .endd
9723 If execution of the command fails (for example, the command does not exist),
9724 the return code is 127 &-- the same code that shells use for non-existent
9725 commands.
9726
9727 &*Warning*&: In a router or transport, you cannot assume the order in which
9728 option values are expanded, except for those preconditions whose order of
9729 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9730 by the expansion of one option, and use it in another.
9731
9732 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9733 out the use of this expansion item in filter files.
9734
9735
9736 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9737 .cindex "expansion" "string substitution"
9738 .cindex "&%sg%& expansion item"
9739 This item works like Perl's substitution operator (s) with the global (/g)
9740 option; hence its name. However, unlike the Perl equivalent, Exim does not
9741 modify the subject string; instead it returns the modified string for insertion
9742 into the overall expansion. The item takes three arguments: the subject string,
9743 a regular expression, and a substitution string. For example:
9744 .code
9745 ${sg{abcdefabcdef}{abc}{xyz}}
9746 .endd
9747 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9748 if any $ or \ characters are required in the regular expression or in the
9749 substitution string, they have to be escaped. For example:
9750 .code
9751 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9752 .endd
9753 yields &"defabc"&, and
9754 .code
9755 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9756 .endd
9757 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9758 the regular expression from string expansion.
9759
9760
9761
9762 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9763 .cindex sorting "a list"
9764 .cindex list sorting
9765 .cindex expansion "list sorting"
9766 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9767 default, but the separator can be changed in the usual way.
9768 The <&'comparator'&> argument is interpreted as the operator
9769 of a two-argument expansion condition.
9770 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9771 The comparison should return true when applied to two values
9772 if the first value should sort before the second value.
9773 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9774 the element being placed in &$item$&,
9775 to give values for comparison.
9776
9777 The item result is a sorted list,
9778 with the original list separator,
9779 of the list elements (in full) of the original.
9780
9781 Examples:
9782 .code
9783 ${sort{3:2:1:4}{<}{$item}}
9784 .endd
9785 sorts a list of numbers, and
9786 .code
9787 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9788 .endd
9789 will sort an MX lookup into priority order.
9790
9791
9792 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9793 .cindex "&%substr%& expansion item"
9794 .cindex "substring extraction"
9795 .cindex "expansion" "substring extraction"
9796 The three strings are expanded; the first two must yield numbers. Call them
9797 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9798 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9799 can use the simpler operator notation that avoids some of the braces:
9800 .code
9801 ${substr_<n>_<m>:<string>}
9802 .endd
9803 The second number is optional (in both notations).
9804 If it is absent in the simpler format, the preceding underscore must also be
9805 omitted.
9806
9807 The &%substr%& item can be used to extract more general substrings than
9808 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9809 length required. For example
9810 .code
9811 ${substr{3}{2}{$local_part}}
9812 .endd
9813 If the starting offset is greater than the string length the result is the
9814 null string; if the length plus starting offset is greater than the string
9815 length, the result is the right-hand part of the string, starting from the
9816 given offset. The first character in the string has offset zero.
9817
9818 The &%substr%& expansion item can take negative offset values to count
9819 from the right-hand end of its operand. The last character is offset -1, the
9820 second-last is offset -2, and so on. Thus, for example,
9821 .code
9822 ${substr{-5}{2}{1234567}}
9823 .endd
9824 yields &"34"&. If the absolute value of a negative offset is greater than the
9825 length of the string, the substring starts at the beginning of the string, and
9826 the length is reduced by the amount of overshoot. Thus, for example,
9827 .code
9828 ${substr{-5}{2}{12}}
9829 .endd
9830 yields an empty string, but
9831 .code
9832 ${substr{-3}{2}{12}}
9833 .endd
9834 yields &"1"&.
9835
9836 When the second number is omitted from &%substr%&, the remainder of the string
9837 is taken if the offset is positive. If it is negative, all characters in the
9838 string preceding the offset point are taken. For example, an offset of -1 and
9839 no length, as in these semantically identical examples:
9840 .code
9841 ${substr_-1:abcde}
9842 ${substr{-1}{abcde}}
9843 .endd
9844 yields all but the last character of the string, that is, &"abcd"&.
9845
9846
9847
9848 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9849         {*&<&'replacements'&>&*}}*&"
9850 .cindex "expansion" "character translation"
9851 .cindex "&%tr%& expansion item"
9852 This item does single-character translation on its subject string. The second
9853 argument is a list of characters to be translated in the subject string. Each
9854 matching character is replaced by the corresponding character from the
9855 replacement list. For example
9856 .code
9857 ${tr{abcdea}{ac}{13}}
9858 .endd
9859 yields &`1b3de1`&. If there are duplicates in the second character string, the
9860 last occurrence is used. If the third string is shorter than the second, its
9861 last character is replicated. However, if it is empty, no translation takes
9862 place.
9863 .endlist
9864
9865
9866
9867 .section "Expansion operators" "SECTexpop"
9868 .cindex "expansion" "operators"
9869 For expansion items that perform transformations on a single argument string,
9870 the &"operator"& notation is used because it is simpler and uses fewer braces.
9871 The substring is first expanded before the operation is applied to it. The
9872 following operations can be performed:
9873
9874 .vlist
9875 .vitem &*${address:*&<&'string'&>&*}*&
9876 .cindex "expansion" "RFC 2822 address handling"
9877 .cindex "&%address%& expansion item"
9878 The string is interpreted as an RFC 2822 address, as it might appear in a
9879 header line, and the effective address is extracted from it. If the string does
9880 not parse successfully, the result is empty.
9881
9882
9883 .vitem &*${addresses:*&<&'string'&>&*}*&
9884 .cindex "expansion" "RFC 2822 address handling"
9885 .cindex "&%addresses%& expansion item"
9886 The string (after expansion) is interpreted as a list of addresses in RFC
9887 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9888 operative address (&'local-part@domain'&) is extracted from each item, and the
9889 result of the expansion is a colon-separated list, with appropriate
9890 doubling of colons should any happen to be present in the email addresses.
9891 Syntactically invalid RFC2822 address items are omitted from the output.
9892
9893 It is possible to specify a character other than colon for the output
9894 separator by starting the string with > followed by the new separator
9895 character. For example:
9896 .code
9897 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9898 .endd
9899 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9900 expansion item, which extracts the working address from a single RFC2822
9901 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9902 processing lists.
9903
9904 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9905 a strict interpretation of header line formatting.  Exim parses the bare,
9906 unquoted portion of an email address and if it finds a comma, treats it as an
9907 email address seperator. For the example header line:
9908 .code
9909 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9910 .endd
9911 The first example below demonstrates that Q-encoded email addresses are parsed
9912 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9913 It does not see the comma because it's still encoded as "=2C".  The second
9914 example below is passed the contents of &`$header_from:`&, meaning it gets
9915 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9916 The third example shows that the presence of a comma is skipped when it is
9917 quoted.
9918 .code
9919 # exim -be '${addresses:From: \
9920 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9921 user@example.com
9922 # exim -be '${addresses:From: Last, First <user@example.com>}'
9923 Last:user@example.com
9924 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9925 user@example.com
9926 .endd
9927
9928 .vitem &*${base62:*&<&'digits'&>&*}*&
9929 .cindex "&%base62%& expansion item"
9930 .cindex "expansion" "conversion to base 62"
9931 The string must consist entirely of decimal digits. The number is converted to
9932 base 62 and output as a string of six characters, including leading zeros. In
9933 the few operating environments where Exim uses base 36 instead of base 62 for
9934 its message identifiers (because those systems do not have case-sensitive file
9935 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9936 be absolutely clear: this is &'not'& base64 encoding.
9937
9938 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9939 .cindex "&%base62d%& expansion item"
9940 .cindex "expansion" "conversion to base 62"
9941 The string must consist entirely of base-62 digits, or, in operating
9942 environments where Exim uses base 36 instead of base 62 for its message
9943 identifiers, base-36 digits. The number is converted to decimal and output as a
9944 string.
9945
9946
9947 .vitem &*${domain:*&<&'string'&>&*}*&
9948 .cindex "domain" "extraction"
9949 .cindex "expansion" "domain extraction"
9950 The string is interpreted as an RFC 2822 address and the domain is extracted
9951 from it. If the string does not parse successfully, the result is empty.
9952
9953
9954 .vitem &*${escape:*&<&'string'&>&*}*&
9955 .cindex "expansion" "escaping non-printing characters"
9956 .cindex "&%escape%& expansion item"
9957 If the string contains any non-printing characters, they are converted to
9958 escape sequences starting with a backslash. Whether characters with the most
9959 significant bit set (so-called &"8-bit characters"&) count as printing or not
9960 is controlled by the &%print_topbitchars%& option.
9961
9962
9963 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9964 .cindex "expansion" "expression evaluation"
9965 .cindex "expansion" "arithmetic expression"
9966 .cindex "&%eval%& expansion item"
9967 These items supports simple arithmetic and bitwise logical operations in
9968 expansion strings. The string (after expansion) must be a conventional
9969 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9970 logical operators, and parentheses. All operations are carried out using
9971 integer arithmetic. The operator priorities are as follows (the same as in the
9972 C programming language):
9973 .table2 70pt 300pt
9974 .irow &'highest:'& "not (~), negate (-)"
9975 .irow ""   "multiply (*), divide (/), remainder (%)"
9976 .irow ""   "plus (+), minus (-)"
9977 .irow ""   "shift-left (<<), shift-right (>>)"
9978 .irow ""   "and (&&)"
9979 .irow ""   "xor (^)"
9980 .irow &'lowest:'&  "or (|)"
9981 .endtable
9982 Binary operators with the same priority are evaluated from left to right. White
9983 space is permitted before or after operators.
9984
9985 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9986 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9987 decimal, even if they start with a leading zero; hexadecimal numbers are not
9988 permitted. This can be useful when processing numbers extracted from dates or
9989 times, which often do have leading zeros.
9990
9991 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9992 or 1024*1024*1024,
9993 respectively. Negative numbers are supported. The result of the computation is
9994 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9995
9996 .display
9997 &`${eval:1+1}            `&  yields 2
9998 &`${eval:1+2*3}          `&  yields 7
9999 &`${eval:(1+2)*3}        `&  yields 9
10000 &`${eval:2+42%5}         `&  yields 4
10001 &`${eval:0xc&amp;5}          `&  yields 4
10002 &`${eval:0xc|5}          `&  yields 13
10003 &`${eval:0xc^5}          `&  yields 9
10004 &`${eval:0xc>>1}         `&  yields 6
10005 &`${eval:0xc<<1}         `&  yields 24
10006 &`${eval:~255&amp;0x1234}    `&  yields 4608
10007 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10008 .endd
10009
10010 As a more realistic example, in an ACL you might have
10011 .code
10012 deny   message = Too many bad recipients
10013        condition =                    \
10014          ${if and {                   \
10015            {>{$rcpt_count}{10}}       \
10016            {                          \
10017            <                          \
10018              {$recipients_count}      \
10019              {${eval:$rcpt_count/2}}  \
10020            }                          \
10021          }{yes}{no}}
10022 .endd
10023 The condition is true if there have been more than 10 RCPT commands and
10024 fewer than half of them have resulted in a valid recipient.
10025
10026
10027 .vitem &*${expand:*&<&'string'&>&*}*&
10028 .cindex "expansion" "re-expansion of substring"
10029 The &%expand%& operator causes a string to be expanded for a second time. For
10030 example,
10031 .code
10032 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10033 .endd
10034 first looks up a string in a file while expanding the operand for &%expand%&,
10035 and then re-expands what it has found.
10036
10037
10038 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10039 .cindex "Unicode"
10040 .cindex "UTF-8" "conversion from"
10041 .cindex "expansion" "UTF-8 conversion"
10042 .cindex "&%from_utf8%& expansion item"
10043 The world is slowly moving towards Unicode, although there are no standards for
10044 email yet. However, other applications (including some databases) are starting
10045 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10046 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10047 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10048 the result is an undefined sequence of bytes.
10049
10050 Unicode code points with values less than 256 are compatible with ASCII and
10051 ISO-8859-1 (also known as Latin-1).
10052 For example, character 169 is the copyright symbol in both cases, though the
10053 way it is encoded is different. In UTF-8, more than one byte is needed for
10054 characters with code values greater than 127, whereas ISO-8859-1 is a
10055 single-byte encoding (but thereby limited to 256 characters). This makes
10056 translation from UTF-8 to ISO-8859-1 straightforward.
10057
10058
10059 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10060 .cindex "hash function" "textual"
10061 .cindex "expansion" "textual hash"
10062 The &%hash%& operator is a simpler interface to the hashing function that can
10063 be used when the two parameters are fixed numbers (as opposed to strings that
10064 change when expanded). The effect is the same as
10065 .code
10066 ${hash{<n>}{<m>}{<string>}}
10067 .endd
10068 See the description of the general &%hash%& item above for details. The
10069 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10070
10071
10072
10073 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10074 .cindex "base64 encoding" "conversion from hex"
10075 .cindex "expansion" "hex to base64"
10076 .cindex "&%hex2b64%& expansion item"
10077 This operator converts a hex string into one that is base64 encoded. This can
10078 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10079
10080
10081
10082 .vitem &*${hexquote:*&<&'string'&>&*}*&
10083 .cindex "quoting" "hex-encoded unprintable characters"
10084 .cindex "&%hexquote%& expansion item"
10085 This operator converts non-printable characters in a string into a hex
10086 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10087 as is, and other byte values are converted to &`\xNN`&, for example a
10088 byte value 127 is converted to &`\x7f`&.
10089
10090
10091 .vitem &*${lc:*&<&'string'&>&*}*&
10092 .cindex "case forcing in strings"
10093 .cindex "string" "case forcing"
10094 .cindex "lower casing"
10095 .cindex "expansion" "case forcing"
10096 .cindex "&%lc%& expansion item"
10097 This forces the letters in the string into lower-case, for example:
10098 .code
10099 ${lc:$local_part}
10100 .endd
10101
10102 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10103 .cindex "expansion" "string truncation"
10104 .cindex "&%length%& expansion item"
10105 The &%length%& operator is a simpler interface to the &%length%& function that
10106 can be used when the parameter is a fixed number (as opposed to a string that
10107 changes when expanded). The effect is the same as
10108 .code
10109 ${length{<number>}{<string>}}
10110 .endd
10111 See the description of the general &%length%& item above for details. Note that
10112 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10113 when &%length%& is used as an operator.
10114
10115
10116 .vitem &*${listcount:*&<&'string'&>&*}*&
10117 .cindex "expansion" "list item count"
10118 .cindex "list" "item count"
10119 .cindex "list" "count of items"
10120 .cindex "&%listcount%& expansion item"
10121 The string is interpreted as a list and the number of items is returned.
10122
10123
10124 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10125 .cindex "expansion" "named list"
10126 .cindex "&%listnamed%& expansion item"
10127 The name is interpreted as a named list and the content of the list is returned,
10128 expanding any referenced lists, re-quoting as needed for colon-separation.
10129 If the optional type is given it must be one of "a", "d", "h" or "l"
10130 and selects address-, domain-, host- or localpart- lists to search among respectively.
10131 Otherwise all types are searched in an undefined order and the first
10132 matching list is returned.
10133
10134
10135 .vitem &*${local_part:*&<&'string'&>&*}*&
10136 .cindex "expansion" "local part extraction"
10137 .cindex "&%local_part%& expansion item"
10138 The string is interpreted as an RFC 2822 address and the local part is
10139 extracted from it. If the string does not parse successfully, the result is
10140 empty.
10141
10142
10143 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10144 .cindex "masked IP address"
10145 .cindex "IP address" "masking"
10146 .cindex "CIDR notation"
10147 .cindex "expansion" "IP address masking"
10148 .cindex "&%mask%& expansion item"
10149 If the form of the string to be operated on is not an IP address followed by a
10150 slash and an integer (that is, a network address in CIDR notation), the
10151 expansion fails. Otherwise, this operator converts the IP address to binary,
10152 masks off the least significant bits according to the bit count, and converts
10153 the result back to text, with mask appended. For example,
10154 .code
10155 ${mask:10.111.131.206/28}
10156 .endd
10157 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10158 be mostly used for looking up masked addresses in files, the result for an IPv6
10159 address uses dots to separate components instead of colons, because colon
10160 terminates a key string in lsearch files. So, for example,
10161 .code
10162 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10163 .endd
10164 returns the string
10165 .code
10166 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10167 .endd
10168 Letters in IPv6 addresses are always output in lower case.
10169
10170
10171 .vitem &*${md5:*&<&'string'&>&*}*&
10172 .cindex "MD5 hash"
10173 .cindex "expansion" "MD5 hash"
10174 .cindex "certificate fingerprint"
10175 .cindex "&%md5%& expansion item"
10176 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10177 as a 32-digit hexadecimal number, in which any letters are in lower case.
10178
10179
10180 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10181 .cindex "expansion" "numeric hash"
10182 .cindex "hash function" "numeric"
10183 The &%nhash%& operator is a simpler interface to the numeric hashing function
10184 that can be used when the two parameters are fixed numbers (as opposed to
10185 strings that change when expanded). The effect is the same as
10186 .code
10187 ${nhash{<n>}{<m>}{<string>}}
10188 .endd
10189 See the description of the general &%nhash%& item above for details.
10190
10191
10192 .vitem &*${quote:*&<&'string'&>&*}*&
10193 .cindex "quoting" "in string expansions"
10194 .cindex "expansion" "quoting"
10195 .cindex "&%quote%& expansion item"
10196 The &%quote%& operator puts its argument into double quotes if it
10197 is an empty string or
10198 contains anything other than letters, digits, underscores, dots, and hyphens.
10199 Any occurrences of double quotes and backslashes are escaped with a backslash.
10200 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10201 respectively For example,
10202 .code
10203 ${quote:ab"*"cd}
10204 .endd
10205 becomes
10206 .code
10207 "ab\"*\"cd"
10208 .endd
10209 The place where this is useful is when the argument is a substitution from a
10210 variable or a message header.
10211
10212 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10213 .cindex "&%quote_local_part%& expansion item"
10214 This operator is like &%quote%&, except that it quotes the string only if
10215 required to do so by the rules of RFC 2822 for quoting local parts. For
10216 example, a plus sign would not cause quoting (but it would for &%quote%&).
10217 If you are creating a new email address from the contents of &$local_part$&
10218 (or any other unknown data), you should always use this operator.
10219
10220
10221 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10222 .cindex "quoting" "lookup-specific"
10223 This operator applies lookup-specific quoting rules to the string. Each
10224 query-style lookup type has its own quoting rules which are described with
10225 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10226 .code
10227 ${quote_ldap:two * two}
10228 .endd
10229 returns
10230 .code
10231 two%20%5C2A%20two
10232 .endd
10233 For single-key lookup types, no quoting is ever necessary and this operator
10234 yields an unchanged string.
10235
10236
10237 .vitem &*${randint:*&<&'n'&>&*}*&
10238 .cindex "random number"
10239 This operator returns a somewhat random number which is less than the
10240 supplied number and is at least 0.  The quality of this randomness depends
10241 on how Exim was built; the values are not suitable for keying material.
10242 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10243 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10244 for versions of GnuTLS with that function.
10245 Otherwise, the implementation may be arc4random(), random() seeded by
10246 srandomdev() or srandom(), or a custom implementation even weaker than
10247 random().
10248
10249
10250 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10251 .cindex "expansion" "IP address"
10252 This operator reverses an IP address; for IPv4 addresses, the result is in
10253 dotted-quad decimal form, while for IPv6 addreses the result is in
10254 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10255 for DNS.  For example,
10256 .code
10257 ${reverse_ip:192.0.2.4}
10258 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10259 .endd
10260 returns
10261 .code
10262 4.2.0.192
10263 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
10264 .endd
10265
10266
10267 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10268 .cindex "expansion" "RFC 2047"
10269 .cindex "RFC 2047" "expansion operator"
10270 .cindex "&%rfc2047%& expansion item"
10271 This operator encodes text according to the rules of RFC 2047. This is an
10272 encoding that is used in header lines to encode non-ASCII characters. It is
10273 assumed that the input string is in the encoding specified by the
10274 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10275 contains only characters in the range 33&--126, and no instances of the
10276 characters
10277 .code
10278 ? = ( ) < > @ , ; : \ " . [ ] _
10279 .endd
10280 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10281 string, using as many &"encoded words"& as necessary to encode all the
10282 characters.
10283
10284
10285 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10286 .cindex "expansion" "RFC 2047"
10287 .cindex "RFC 2047" "decoding"
10288 .cindex "&%rfc2047d%& expansion item"
10289 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10290 bytes are replaced by question marks. Characters are converted into the
10291 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10292 not recognized unless &%check_rfc2047_length%& is set false.
10293
10294 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10295 access a header line, RFC 2047 decoding is done automatically. You do not need
10296 to use this operator as well.
10297
10298
10299
10300 .vitem &*${rxquote:*&<&'string'&>&*}*&
10301 .cindex "quoting" "in regular expressions"
10302 .cindex "regular expressions" "quoting"
10303 .cindex "&%rxquote%& expansion item"
10304 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10305 characters in its argument. This is useful when substituting the values of
10306 variables or headers inside regular expressions.
10307
10308
10309 .vitem &*${sha1:*&<&'string'&>&*}*&
10310 .cindex "SHA-1 hash"
10311 .cindex "expansion" "SHA-1 hashing"
10312 .cindex "certificate fingerprint"
10313 .cindex "&%sha2%& expansion item"
10314 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10315 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10316
10317
10318 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10319 .cindex "SHA-256 hash"
10320 .cindex "certificate fingerprint"
10321 .cindex "expansion" "SHA-256 hashing"
10322 .cindex "&%sha256%& expansion item"
10323 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10324 certificate,
10325 and returns
10326 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10327 Only arguments which are a single variable of certificate type are supported.
10328
10329
10330 .vitem &*${stat:*&<&'string'&>&*}*&
10331 .cindex "expansion" "statting a file"
10332 .cindex "file" "extracting characteristics"
10333 .cindex "&%stat%& expansion item"
10334 The string, after expansion, must be a file path. A call to the &[stat()]&
10335 function is made for this path. If &[stat()]& fails, an error occurs and the
10336 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10337 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10338 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10339 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10340 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10341 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10342 can extract individual fields using the &%extract%& expansion item.
10343
10344 The use of the &%stat%& expansion in users' filter files can be locked out by
10345 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10346 systems for files larger than 2GB.
10347
10348 .vitem &*${str2b64:*&<&'string'&>&*}*&
10349 .cindex "expansion" "base64 encoding"
10350 .cindex "base64 encoding" "in string expansion"
10351 .cindex "&%str2b64%& expansion item"
10352 This operator converts a string into one that is base64 encoded.
10353
10354
10355
10356 .vitem &*${strlen:*&<&'string'&>&*}*&
10357 .cindex "expansion" "string length"
10358 .cindex "string" "length in expansion"
10359 .cindex "&%strlen%& expansion item"
10360 The item is replace by the length of the expanded string, expressed as a
10361 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10362
10363
10364 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10365 .cindex "&%substr%& expansion item"
10366 .cindex "substring extraction"
10367 .cindex "expansion" "substring expansion"
10368 The &%substr%& operator is a simpler interface to the &%substr%& function that
10369 can be used when the two parameters are fixed numbers (as opposed to strings
10370 that change when expanded). The effect is the same as
10371 .code
10372 ${substr{<start>}{<length>}{<string>}}
10373 .endd
10374 See the description of the general &%substr%& item above for details. The
10375 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10376
10377 .vitem &*${time_eval:*&<&'string'&>&*}*&
10378 .cindex "&%time_eval%& expansion item"
10379 .cindex "time interval" "decoding"
10380 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10381 seconds.
10382
10383 .vitem &*${time_interval:*&<&'string'&>&*}*&
10384 .cindex "&%time_interval%& expansion item"
10385 .cindex "time interval" "formatting"
10386 The argument (after sub-expansion) must be a sequence of decimal digits that
10387 represents an interval of time as a number of seconds. It is converted into a
10388 number of larger units and output in Exim's normal time format, for example,
10389 &`1w3d4h2m6s`&.
10390
10391 .vitem &*${uc:*&<&'string'&>&*}*&
10392 .cindex "case forcing in strings"
10393 .cindex "string" "case forcing"
10394 .cindex "upper casing"
10395 .cindex "expansion" "case forcing"
10396 .cindex "&%uc%& expansion item"
10397 This forces the letters in the string into upper-case.
10398
10399 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10400 .cindex "correction of invalid utf-8 sequences in strings"
10401 .cindex "utf-8" "utf-8 sequences"
10402 .cindex "incorrect utf-8"
10403 .cindex "expansion" "utf-8 forcing"
10404 .cindex "&%utf8clean%& expansion item"
10405 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10406 .endlist
10407
10408
10409
10410
10411
10412
10413 .section "Expansion conditions" "SECTexpcond"
10414 .scindex IIDexpcond "expansion" "conditions"
10415 The following conditions are available for testing by the &%${if%& construct
10416 while expanding strings:
10417
10418 .vlist
10419 .vitem &*!*&<&'condition'&>
10420 .cindex "expansion" "negating a condition"
10421 .cindex "negation" "in expansion condition"
10422 Preceding any condition with an exclamation mark negates the result of the
10423 condition.
10424
10425 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10426 .cindex "numeric comparison"
10427 .cindex "expansion" "numeric comparison"
10428 There are a number of symbolic operators for doing numeric comparisons. They
10429 are:
10430 .display
10431 &`=   `&   equal
10432 &`==  `&   equal
10433 &`>   `&   greater
10434 &`>=  `&   greater or equal
10435 &`<   `&   less
10436 &`<=  `&   less or equal
10437 .endd
10438 For example:
10439 .code
10440 ${if >{$message_size}{10M} ...
10441 .endd
10442 Note that the general negation operator provides for inequality testing. The
10443 two strings must take the form of optionally signed decimal integers,
10444 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10445 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10446 As a special case, the numerical value of an empty string is taken as
10447 zero.
10448
10449 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10450 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10451 10M, not if 10M is larger than &$message_size$&.
10452
10453
10454 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10455         {*&<&'arg2'&>&*}...}*&
10456 .cindex "expansion" "calling an acl"
10457 .cindex "&%acl%&" "expansion condition"
10458 The name and zero to nine argument strings are first expanded separately.  The expanded
10459 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10460 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10461 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10462 and may use the variables; if another acl expansion is used the values
10463 are restored after it returns.  If the ACL sets
10464 a value using a "message =" modifier the variable $value becomes
10465 the result of the expansion, otherwise it is empty.
10466 If the ACL returns accept the condition is true; if deny, false.
10467 If the ACL returns defer the result is a forced-fail.
10468
10469 .vitem &*bool&~{*&<&'string'&>&*}*&
10470 .cindex "expansion" "boolean parsing"
10471 .cindex "&%bool%& expansion condition"
10472 This condition turns a string holding a true or false representation into
10473 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10474 (case-insensitively); also integer numbers map to true if non-zero,
10475 false if zero.
10476 An empty string is treated as false.
10477 Leading and trailing whitespace is ignored;
10478 thus a string consisting only of whitespace is false.
10479 All other string values will result in expansion failure.
10480
10481 When combined with ACL variables, this expansion condition will let you
10482 make decisions in one place and act on those decisions in another place.
10483 For example:
10484 .code
10485 ${if bool{$acl_m_privileged_sender} ...
10486 .endd
10487
10488
10489 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10490 .cindex "expansion" "boolean parsing"
10491 .cindex "&%bool_lax%& expansion condition"
10492 Like &%bool%&, this condition turns a string into a boolean state.  But
10493 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10494 loose definition that the Router &%condition%& option uses.  The empty string
10495 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10496 true.  Leading and trailing whitespace is ignored.
10497
10498 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10499
10500 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10501 .cindex "expansion" "encrypted comparison"
10502 .cindex "encrypted strings, comparing"
10503 .cindex "&%crypteq%& expansion condition"
10504 This condition is included in the Exim binary if it is built to support any
10505 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10506 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10507 included in the binary.
10508
10509 The &%crypteq%& condition has two arguments. The first is encrypted and
10510 compared against the second, which is already encrypted. The second string may
10511 be in the LDAP form for storing encrypted strings, which starts with the
10512 encryption type in curly brackets, followed by the data. If the second string
10513 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10514 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10515 Typically this will be a field from a password file. An example of an encrypted
10516 string in LDAP form is:
10517 .code
10518 {md5}CY9rzUYh03PK3k6DJie09g==
10519 .endd
10520 If such a string appears directly in an expansion, the curly brackets have to
10521 be quoted, because they are part of the expansion syntax. For example:
10522 .code
10523 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10524 .endd
10525 The following encryption types (whose names are matched case-independently) are
10526 supported:
10527
10528 .ilist
10529 .cindex "MD5 hash"
10530 .cindex "base64 encoding" "in encrypted password"
10531 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10532 printable characters to compare with the remainder of the second string. If the
10533 length of the comparison string is 24, Exim assumes that it is base64 encoded
10534 (as in the above example). If the length is 32, Exim assumes that it is a
10535 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10536 comparison fails.
10537
10538 .next
10539 .cindex "SHA-1 hash"
10540 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10541 printable characters to compare with the remainder of the second string. If the
10542 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10543 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10544 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10545
10546 .next
10547 .cindex "&[crypt()]&"
10548 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10549 only the first eight characters of the password. However, in modern operating
10550 systems this is no longer true, and in many cases the entire password is used,
10551 whatever its length.
10552
10553 .next
10554 .cindex "&[crypt16()]&"
10555 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10556 use up to 16 characters of the password in some operating systems. Again, in
10557 modern operating systems, more characters may be used.
10558 .endlist
10559 Exim has its own version of &[crypt16()]&, which is just a double call to
10560 &[crypt()]&. For operating systems that have their own version, setting
10561 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10562 operating system version instead of its own. This option is set by default in
10563 the OS-dependent &_Makefile_& for those operating systems that are known to
10564 support &[crypt16()]&.
10565
10566 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10567 it was not using the same algorithm as some operating systems' versions. It
10568 turns out that as well as &[crypt16()]& there is a function called
10569 &[bigcrypt()]& in some operating systems. This may or may not use the same
10570 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10571
10572 However, since there is now a move away from the traditional &[crypt()]&
10573 functions towards using SHA1 and other algorithms, tidying up this area of
10574 Exim is seen as very low priority.
10575
10576 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10577 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10578 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10579 default is &`{crypt}`&. Whatever the default, you can always use either
10580 function by specifying it explicitly in curly brackets.
10581
10582 .vitem &*def:*&<&'variable&~name'&>
10583 .cindex "expansion" "checking for empty variable"
10584 .cindex "&%def%& expansion condition"
10585 The &%def%& condition must be followed by the name of one of the expansion
10586 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10587 variable does not contain the empty string. For example:
10588 .code
10589 ${if def:sender_ident {from $sender_ident}}
10590 .endd
10591 Note that the variable name is given without a leading &%$%& character. If the
10592 variable does not exist, the expansion fails.
10593
10594 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10595         &~&*def:h_*&<&'header&~name'&>&*:*&"
10596 .cindex "expansion" "checking header line existence"
10597 This condition is true if a message is being processed and the named header
10598 exists in the message. For example,
10599 .code
10600 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10601 .endd
10602 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10603 the header name must be terminated by a colon if white space does not follow.
10604
10605 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10606        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10607 .cindex "string" "comparison"
10608 .cindex "expansion" "string comparison"
10609 .cindex "&%eq%& expansion condition"
10610 .cindex "&%eqi%& expansion condition"
10611 The two substrings are first expanded. The condition is true if the two
10612 resulting strings are identical. For &%eq%& the comparison includes the case of
10613 letters, whereas for &%eqi%& the comparison is case-independent.
10614
10615 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10616 .cindex "expansion" "file existence test"
10617 .cindex "file" "existence test"
10618 .cindex "&%exists%&, expansion condition"
10619 The substring is first expanded and then interpreted as an absolute path. The
10620 condition is true if the named file (or directory) exists. The existence test
10621 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10622 users' filter files may be locked out by the system administrator.
10623
10624 .vitem &*first_delivery*&
10625 .cindex "delivery" "first"
10626 .cindex "first delivery"
10627 .cindex "expansion" "first delivery test"
10628 .cindex "&%first_delivery%& expansion condition"
10629 This condition, which has no data, is true during a message's first delivery
10630 attempt. It is false during any subsequent delivery attempts.
10631
10632
10633 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10634        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10635 .cindex "list" "iterative conditions"
10636 .cindex "expansion" "&*forall*& condition"
10637 .cindex "expansion" "&*forany*& condition"
10638 .vindex "&$item$&"
10639 These conditions iterate over a list. The first argument is expanded to form
10640 the list. By default, the list separator is a colon, but it can be changed by
10641 the normal method. The second argument is interpreted as a condition that is to
10642 be applied to each item in the list in turn. During the interpretation of the
10643 condition, the current list item is placed in a variable called &$item$&.
10644 .ilist
10645 For &*forany*&, interpretation stops if the condition is true for any item, and
10646 the result of the whole condition is true. If the condition is false for all
10647 items in the list, the overall condition is false.
10648 .next
10649 For &*forall*&, interpretation stops if the condition is false for any item,
10650 and the result of the whole condition is false. If the condition is true for
10651 all items in the list, the overall condition is true.
10652 .endlist
10653 Note that negation of &*forany*& means that the condition must be false for all
10654 items for the overall condition to succeed, and negation of &*forall*& means
10655 that the condition must be false for at least one item. In this example, the
10656 list separator is changed to a comma:
10657 .code
10658 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10659 .endd
10660 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10661 being processed, to enable these expansion items to be nested.
10662
10663 To scan a named list, expand it with the &*listnamed*& operator.
10664
10665
10666 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10667        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10668 .cindex "string" "comparison"
10669 .cindex "expansion" "string comparison"
10670 .cindex "&%ge%& expansion condition"
10671 .cindex "&%gei%& expansion condition"
10672 The two substrings are first expanded. The condition is true if the first
10673 string is lexically greater than or equal to the second string. For &%ge%& the
10674 comparison includes the case of letters, whereas for &%gei%& the comparison is
10675 case-independent.
10676
10677 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10678        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10679 .cindex "string" "comparison"
10680 .cindex "expansion" "string comparison"
10681 .cindex "&%gt%& expansion condition"
10682 .cindex "&%gti%& expansion condition"
10683 The two substrings are first expanded. The condition is true if the first
10684 string is lexically greater than the second string. For &%gt%& the comparison
10685 includes the case of letters, whereas for &%gti%& the comparison is
10686 case-independent.
10687
10688 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10689        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10690 .cindex "string" "comparison"
10691 .cindex "list" "iterative conditions"
10692 Both strings are expanded; the second string is treated as a list of simple
10693 strings; if the first string is a member of the second, then the condition
10694 is true.
10695
10696 These are simpler to use versions of the more powerful &*forany*& condition.
10697 Examples, and the &*forany*& equivalents:
10698 .code
10699 ${if inlist{needle}{foo:needle:bar}}
10700   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10701 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10702   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10703 .endd
10704
10705 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10706        &*isip4&~{*&<&'string'&>&*}*& &&&
10707        &*isip6&~{*&<&'string'&>&*}*&
10708 .cindex "IP address" "testing string format"
10709 .cindex "string" "testing for IP address"
10710 .cindex "&%isip%& expansion condition"
10711 .cindex "&%isip4%& expansion condition"
10712 .cindex "&%isip6%& expansion condition"
10713 The substring is first expanded, and then tested to see if it has the form of
10714 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10715 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10716
10717 For an IPv4 address, the test is for four dot-separated components, each of
10718 which consists of from one to three digits. For an IPv6 address, up to eight
10719 colon-separated components are permitted, each containing from one to four
10720 hexadecimal digits. There may be fewer than eight components if an empty
10721 component (adjacent colons) is present. Only one empty component is permitted.
10722
10723 &*Note*&: The checks are just on the form of the address; actual numerical
10724 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10725 check. The main use of these tests is to distinguish between IP addresses and
10726 host names, or between IPv4 and IPv6 addresses. For example, you could use
10727 .code
10728 ${if isip4{$sender_host_address}...
10729 .endd
10730 to test which IP version an incoming SMTP connection is using.
10731
10732 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10733 .cindex "LDAP" "use for authentication"
10734 .cindex "expansion" "LDAP authentication test"
10735 .cindex "&%ldapauth%& expansion condition"
10736 This condition supports user authentication using LDAP. See section
10737 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10738 queries. For this use, the query must contain a user name and password. The
10739 query itself is not used, and can be empty. The condition is true if the
10740 password is not empty, and the user name and password are accepted by the LDAP
10741 server. An empty password is rejected without calling LDAP because LDAP binds
10742 with an empty password are considered anonymous regardless of the username, and
10743 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10744 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10745 this can be used.
10746
10747
10748 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10749        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10750 .cindex "string" "comparison"
10751 .cindex "expansion" "string comparison"
10752 .cindex "&%le%& expansion condition"
10753 .cindex "&%lei%& expansion condition"
10754 The two substrings are first expanded. The condition is true if the first
10755 string is lexically less than or equal to the second string. For &%le%& the
10756 comparison includes the case of letters, whereas for &%lei%& the comparison is
10757 case-independent.
10758
10759 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10760        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10761 .cindex "string" "comparison"
10762 .cindex "expansion" "string comparison"
10763 .cindex "&%lt%& expansion condition"
10764 .cindex "&%lti%& expansion condition"
10765 The two substrings are first expanded. The condition is true if the first
10766 string is lexically less than the second string. For &%lt%& the comparison
10767 includes the case of letters, whereas for &%lti%& the comparison is
10768 case-independent.
10769
10770
10771 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10772 .cindex "expansion" "regular expression comparison"
10773 .cindex "regular expressions" "match in expanded string"
10774 .cindex "&%match%& expansion condition"
10775 The two substrings are first expanded. The second is then treated as a regular
10776 expression and applied to the first. Because of the pre-expansion, if the
10777 regular expression contains dollar, or backslash characters, they must be
10778 escaped. Care must also be taken if the regular expression contains braces
10779 (curly brackets). A closing brace must be escaped so that it is not taken as a
10780 premature termination of <&'string2'&>. The easiest approach is to use the
10781 &`\N`& feature to disable expansion of the regular expression.
10782 For example,
10783 .code
10784 ${if match {$local_part}{\N^\d{3}\N} ...
10785 .endd
10786 If the whole expansion string is in double quotes, further escaping of
10787 backslashes is also required.
10788
10789 The condition is true if the regular expression match succeeds.
10790 The regular expression is not required to begin with a circumflex
10791 metacharacter, but if there is no circumflex, the expression is not anchored,
10792 and it may match anywhere in the subject, not just at the start. If you want
10793 the pattern to match at the end of the subject, you must include the &`$`&
10794 metacharacter at an appropriate point.
10795
10796 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10797 At the start of an &%if%& expansion the values of the numeric variable
10798 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10799 succeeds causes them to be reset to the substrings of that condition and they
10800 will have these values during the expansion of the success string. At the end
10801 of the &%if%& expansion, the previous values are restored. After testing a
10802 combination of conditions using &%or%&, the subsequent values of the numeric
10803 variables are those of the condition that succeeded.
10804
10805 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10806 .cindex "&%match_address%& expansion condition"
10807 See &*match_local_part*&.
10808
10809 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10810 .cindex "&%match_domain%& expansion condition"
10811 See &*match_local_part*&.
10812
10813 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10814 .cindex "&%match_ip%& expansion condition"
10815 This condition matches an IP address to a list of IP address patterns. It must
10816 be followed by two argument strings. The first (after expansion) must be an IP
10817 address or an empty string. The second (not expanded) is a restricted host
10818 list that can match only an IP address, not a host name. For example:
10819 .code
10820 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10821 .endd
10822 The specific types of host list item that are permitted in the list are:
10823
10824 .ilist
10825 An IP address, optionally with a CIDR mask.
10826 .next
10827 A single asterisk, which matches any IP address.
10828 .next
10829 An empty item, which matches only if the IP address is empty. This could be
10830 useful for testing for a locally submitted message or one from specific hosts
10831 in a single test such as
10832 . ==== As this is a nested list, any displays it contains must be indented
10833 . ==== as otherwise they are too far to the left. This comment applies to
10834 . ==== the use of xmlto plus fop. There's no problem when formatting with
10835 . ==== sdop, with or without the extra indent.
10836 .code
10837   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10838 .endd
10839 where the first item in the list is the empty string.
10840 .next
10841 The item @[] matches any of the local host's interface addresses.
10842 .next
10843 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10844 even if &`net-`& is not specified. There is never any attempt to turn the IP
10845 address into a host name. The most common type of linear search for
10846 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10847 masks. For example:
10848 .code
10849   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10850 .endd
10851 It is of course possible to use other kinds of lookup, and in such a case, you
10852 do need to specify the &`net-`& prefix if you want to specify a specific
10853 address mask, for example:
10854 .code
10855   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10856 .endd
10857 However, unless you are combining a &%match_ip%& condition with others, it is
10858 just as easy to use the fact that a lookup is itself a condition, and write:
10859 .code
10860   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10861 .endd
10862 .endlist ilist
10863
10864 Note that <&'string2'&> is not itself subject to string expansion, unless
10865 Exim was built with the EXPAND_LISTMATCH_RHS option.
10866
10867 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10868
10869 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10870 .cindex "domain list" "in expansion condition"
10871 .cindex "address list" "in expansion condition"
10872 .cindex "local part" "list, in expansion condition"
10873 .cindex "&%match_local_part%& expansion condition"
10874 This condition, together with &%match_address%& and &%match_domain%&, make it
10875 possible to test domain, address, and local part lists within expansions. Each
10876 condition requires two arguments: an item and a list to match. A trivial
10877 example is:
10878 .code
10879 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10880 .endd
10881 In each case, the second argument may contain any of the allowable items for a
10882 list of the appropriate type. Also, because the second argument (after
10883 expansion) is a standard form of list, it is possible to refer to a named list.
10884 Thus, you can use conditions like this:
10885 .code
10886 ${if match_domain{$domain}{+local_domains}{...
10887 .endd
10888 .cindex "&`+caseful`&"
10889 For address lists, the matching starts off caselessly, but the &`+caseful`&
10890 item can be used, as in all address lists, to cause subsequent items to
10891 have their local parts matched casefully. Domains are always matched
10892 caselessly.
10893
10894 Note that <&'string2'&> is not itself subject to string expansion, unless
10895 Exim was built with the EXPAND_LISTMATCH_RHS option.
10896
10897 &*Note*&: Host lists are &'not'& supported in this way. This is because
10898 hosts have two identities: a name and an IP address, and it is not clear
10899 how to specify cleanly how such a test would work. However, IP addresses can be
10900 matched using &%match_ip%&.
10901
10902 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10903 .cindex "PAM authentication"
10904 .cindex "AUTH" "with PAM"
10905 .cindex "Solaris" "PAM support"
10906 .cindex "expansion" "PAM authentication test"
10907 .cindex "&%pam%& expansion condition"
10908 &'Pluggable Authentication Modules'&
10909 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10910 available in the latest releases of Solaris and in some GNU/Linux
10911 distributions. The Exim support, which is intended for use in conjunction with
10912 the SMTP AUTH command, is available only if Exim is compiled with
10913 .code
10914 SUPPORT_PAM=yes
10915 .endd
10916 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10917 in some releases of GNU/Linux &%-ldl%& is also needed.
10918
10919 The argument string is first expanded, and the result must be a
10920 colon-separated list of strings. Leading and trailing white space is ignored.
10921 The PAM module is initialized with the service name &"exim"& and the user name
10922 taken from the first item in the colon-separated data string (<&'string1'&>).
10923 The remaining items in the data string are passed over in response to requests
10924 from the authentication function. In the simple case there will only be one
10925 request, for a password, so the data consists of just two strings.
10926
10927 There can be problems if any of the strings are permitted to contain colon
10928 characters. In the usual way, these have to be doubled to avoid being taken as
10929 separators. If the data is being inserted from a variable, the &%sg%& expansion
10930 item can be used to double any existing colons. For example, the configuration
10931 of a LOGIN authenticator might contain this setting:
10932 .code
10933 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10934 .endd
10935 For a PLAIN authenticator you could use:
10936 .code
10937 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10938 .endd
10939 In some operating systems, PAM authentication can be done only from a process
10940 running as root. Since Exim is running as the Exim user when receiving
10941 messages, this means that PAM cannot be used directly in those systems.
10942 A patched version of the &'pam_unix'& module that comes with the
10943 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10944 The patched module allows one special uid/gid combination, in addition to root,
10945 to authenticate. If you build the patched module to allow the Exim user and
10946 group, PAM can then be used from an Exim authenticator.
10947
10948
10949 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10950 .cindex "&'pwcheck'& daemon"
10951 .cindex "Cyrus"
10952 .cindex "expansion" "&'pwcheck'& authentication test"
10953 .cindex "&%pwcheck%& expansion condition"
10954 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10955 This is one way of making it possible for passwords to be checked by a process
10956 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10957 deprecated. Its replacement is &'saslauthd'& (see below).
10958
10959 The pwcheck support is not included in Exim by default. You need to specify
10960 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10961 building Exim. For example:
10962 .code
10963 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10964 .endd
10965 You do not need to install the full Cyrus software suite in order to use
10966 the pwcheck daemon. You can compile and install just the daemon alone
10967 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10968 access to the &_/var/pwcheck_& directory.
10969
10970 The &%pwcheck%& condition takes one argument, which must be the user name and
10971 password, separated by a colon. For example, in a LOGIN authenticator
10972 configuration, you might have this:
10973 .code
10974 server_condition = ${if pwcheck{$auth1:$auth2}}
10975 .endd
10976 Again, for a PLAIN authenticator configuration, this would be:
10977 .code
10978 server_condition = ${if pwcheck{$auth2:$auth3}}
10979 .endd
10980 .vitem &*queue_running*&
10981 .cindex "queue runner" "detecting when delivering from"
10982 .cindex "expansion" "queue runner test"
10983 .cindex "&%queue_running%& expansion condition"
10984 This condition, which has no data, is true during delivery attempts that are
10985 initiated by queue runner processes, and false otherwise.
10986
10987
10988 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10989 .cindex "Radius"
10990 .cindex "expansion" "Radius authentication"
10991 .cindex "&%radius%& expansion condition"
10992 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10993 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10994 the Radius client configuration file in order to build Exim with Radius
10995 support.
10996
10997 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10998 library, using the original API. If you are using release 0.4.0 or later of
10999 this library, you need to set
11000 .code
11001 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11002 .endd
11003 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11004 &%libradius%& library that comes with FreeBSD. To do this, set
11005 .code
11006 RADIUS_LIB_TYPE=RADLIB
11007 .endd
11008 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11009 You may also have to supply a suitable setting in EXTRALIBS so that the
11010 Radius library can be found when Exim is linked.
11011
11012 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11013 Radius client library, which calls the Radius server. The condition is true if
11014 the authentication is successful. For example:
11015 .code
11016 server_condition = ${if radius{<arguments>}}
11017 .endd
11018
11019
11020 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11021         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11022 .cindex "&'saslauthd'& daemon"
11023 .cindex "Cyrus"
11024 .cindex "expansion" "&'saslauthd'& authentication test"
11025 .cindex "&%saslauthd%& expansion condition"
11026 This condition supports user authentication using the Cyrus &'saslauthd'&
11027 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11028 Using this daemon is one way of making it possible for passwords to be checked
11029 by a process that is not running as root.
11030
11031 The saslauthd support is not included in Exim by default. You need to specify
11032 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11033 building Exim. For example:
11034 .code
11035 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11036 .endd
11037 You do not need to install the full Cyrus software suite in order to use
11038 the saslauthd daemon. You can compile and install just the daemon alone
11039 from the Cyrus SASL library.
11040
11041 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11042 two are mandatory. For example:
11043 .code
11044 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11045 .endd
11046 The service and the realm are optional (which is why the arguments are enclosed
11047 in their own set of braces). For details of the meaning of the service and
11048 realm, and how to run the daemon, consult the Cyrus documentation.
11049 .endlist vlist
11050
11051
11052
11053 .section "Combining expansion conditions" "SECID84"
11054 .cindex "expansion" "combining conditions"
11055 Several conditions can be tested at once by combining them using the &%and%&
11056 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11057 conditions on their own, and precede their lists of sub-conditions. Each
11058 sub-condition must be enclosed in braces within the overall braces that contain
11059 the list. No repetition of &%if%& is used.
11060
11061
11062 .vlist
11063 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11064 .cindex "&""or""& expansion condition"
11065 .cindex "expansion" "&""or""& of conditions"
11066 The sub-conditions are evaluated from left to right. The condition is true if
11067 any one of the sub-conditions is true.
11068 For example,
11069 .code
11070 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11071 .endd
11072 When a true sub-condition is found, the following ones are parsed but not
11073 evaluated. If there are several &"match"& sub-conditions the values of the
11074 numeric variables afterwards are taken from the first one that succeeds.
11075
11076 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11077 .cindex "&""and""& expansion condition"
11078 .cindex "expansion" "&""and""& of conditions"
11079 The sub-conditions are evaluated from left to right. The condition is true if
11080 all of the sub-conditions are true. If there are several &"match"&
11081 sub-conditions, the values of the numeric variables afterwards are taken from
11082 the last one. When a false sub-condition is found, the following ones are
11083 parsed but not evaluated.
11084 .endlist
11085 .ecindex IIDexpcond
11086
11087
11088
11089
11090 .section "Expansion variables" "SECTexpvar"
11091 .cindex "expansion" "variables, list of"
11092 This section contains an alphabetical list of all the expansion variables. Some
11093 of them are available only when Exim is compiled with specific options such as
11094 support for TLS or the content scanning extension.
11095
11096 .vlist
11097 .vitem "&$0$&, &$1$&, etc"
11098 .cindex "numerical variables (&$1$& &$2$& etc)"
11099 When a &%match%& expansion condition succeeds, these variables contain the
11100 captured substrings identified by the regular expression during subsequent
11101 processing of the success string of the containing &%if%& expansion item.
11102 However, they do not retain their values afterwards; in fact, their previous
11103 values are restored at the end of processing an &%if%& item. The numerical
11104 variables may also be set externally by some other matching process which
11105 precedes the expansion of the string. For example, the commands available in
11106 Exim filter files include an &%if%& command with its own regular expression
11107 matching condition.
11108
11109 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11110 Within an acl condition, expansion condition or expansion item
11111 any arguments are copied to these variables,
11112 any unused variables being made empty.
11113
11114 .vitem "&$acl_c...$&"
11115 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11116 can be given any name that starts with &$acl_c$& and is at least six characters
11117 long, but the sixth character must be either a digit or an underscore. For
11118 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11119 variables persist throughout the lifetime of an SMTP connection. They can be
11120 used to pass information between ACLs and between different invocations of the
11121 same ACL. When a message is received, the values of these variables are saved
11122 with the message, and can be accessed by filters, routers, and transports
11123 during subsequent delivery.
11124
11125 .vitem "&$acl_m...$&"
11126 These variables are like the &$acl_c...$& variables, except that their values
11127 are reset after a message has been received. Thus, if several messages are
11128 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11129 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11130 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11131 message is received, the values of these variables are saved with the message,
11132 and can be accessed by filters, routers, and transports during subsequent
11133 delivery.
11134
11135 .vitem &$acl_narg$&
11136 Within an acl condition, expansion condition or expansion item
11137 this variable has the number of arguments.
11138
11139 .vitem &$acl_verify_message$&
11140 .vindex "&$acl_verify_message$&"
11141 After an address verification has failed, this variable contains the failure
11142 message. It retains its value for use in subsequent modifiers. The message can
11143 be preserved by coding like this:
11144 .code
11145 warn !verify = sender
11146      set acl_m0 = $acl_verify_message
11147 .endd
11148 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11149 &%log_message%& modifiers, to include information about the verification
11150 failure.
11151
11152 .vitem &$address_data$&
11153 .vindex "&$address_data$&"
11154 This variable is set by means of the &%address_data%& option in routers. The
11155 value then remains with the address while it is processed by subsequent routers
11156 and eventually a transport. If the transport is handling multiple addresses,
11157 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11158 for more details. &*Note*&: The contents of &$address_data$& are visible in
11159 user filter files.
11160
11161 If &$address_data$& is set when the routers are called from an ACL to verify
11162 a recipient address, the final value is still in the variable for subsequent
11163 conditions and modifiers of the ACL statement. If routing the address caused it
11164 to be redirected to just one address, the child address is also routed as part
11165 of the verification, and in this case the final value of &$address_data$& is
11166 from the child's routing.
11167
11168 If &$address_data$& is set when the routers are called from an ACL to verify a
11169 sender address, the final value is also preserved, but this time in
11170 &$sender_address_data$&, to distinguish it from data from a recipient
11171 address.
11172
11173 In both cases (recipient and sender verification), the value does not persist
11174 after the end of the current ACL statement. If you want to preserve
11175 these values for longer, you can save them in ACL variables.
11176
11177 .vitem &$address_file$&
11178 .vindex "&$address_file$&"
11179 When, as a result of aliasing, forwarding, or filtering, a message is directed
11180 to a specific file, this variable holds the name of the file when the transport
11181 is running. At other times, the variable is empty. For example, using the
11182 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11183 .code
11184 /home/r2d2/savemail
11185 .endd
11186 then when the &(address_file)& transport is running, &$address_file$&
11187 contains the text string &`/home/r2d2/savemail`&.
11188 .cindex "Sieve filter" "value of &$address_file$&"
11189 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11190 then up to the transport configuration to generate an appropriate absolute path
11191 to the relevant file.
11192
11193 .vitem &$address_pipe$&
11194 .vindex "&$address_pipe$&"
11195 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11196 this variable holds the pipe command when the transport is running.
11197
11198 .vitem "&$auth1$& &-- &$auth3$&"
11199 .vindex "&$auth1$&, &$auth2$&, etc"
11200 These variables are used in SMTP authenticators (see chapters
11201 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11202
11203 .vitem &$authenticated_id$&
11204 .cindex "authentication" "id"
11205 .vindex "&$authenticated_id$&"
11206 When a server successfully authenticates a client it may be configured to
11207 preserve some of the authentication information in the variable
11208 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11209 user/password authenticator configuration might preserve the user name for use
11210 in the routers. Note that this is not the same information that is saved in
11211 &$sender_host_authenticated$&.
11212 When a message is submitted locally (that is, not over a TCP connection)
11213 the value of &$authenticated_id$& is normally the login name of the calling
11214 process. However, a trusted user can override this by means of the &%-oMai%&
11215 command line option.
11216
11217 .vitem &$authenticated_fail_id$&
11218 .cindex "authentication" "fail" "id"
11219 .vindex "&$authenticated_fail_id$&"
11220 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11221 will contain the failed authentication id. If more than one authentication
11222 id is attempted, it will contain only the last one. The variable is
11223 available for processing in the ACL's, generally the quit or notquit ACL.
11224 A message to a local recipient could still be accepted without requiring
11225 authentication, which means this variable could also be visible in all of
11226 the ACL's as well.
11227
11228
11229 .vitem &$authenticated_sender$&
11230 .cindex "sender" "authenticated"
11231 .cindex "authentication" "sender"
11232 .cindex "AUTH" "on MAIL command"
11233 .vindex "&$authenticated_sender$&"
11234 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11235 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11236 described in section &<<SECTauthparamail>>&. Unless the data is the string
11237 &"<>"&, it is set as the authenticated sender of the message, and the value is
11238 available during delivery in the &$authenticated_sender$& variable. If the
11239 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11240
11241 .vindex "&$qualify_domain$&"
11242 When a message is submitted locally (that is, not over a TCP connection), the
11243 value of &$authenticated_sender$& is an address constructed from the login
11244 name of the calling process and &$qualify_domain$&, except that a trusted user
11245 can override this by means of the &%-oMas%& command line option.
11246
11247
11248 .vitem &$authentication_failed$&
11249 .cindex "authentication" "failure"
11250 .vindex "&$authentication_failed$&"
11251 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11252 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11253 possible to distinguish between &"did not try to authenticate"&
11254 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11255 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11256 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11257 negative response to an AUTH command, including (for example) an attempt to use
11258 an undefined mechanism.
11259
11260 .vitem &$av_failed$&
11261 .cindex "content scanning" "AV scanner failure"
11262 This variable is available when Exim is compiled with the content-scanning
11263 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11264 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11265 the ACL malware condition.
11266
11267 .vitem &$body_linecount$&
11268 .cindex "message body" "line count"
11269 .cindex "body of message" "line count"
11270 .vindex "&$body_linecount$&"
11271 When a message is being received or delivered, this variable contains the
11272 number of lines in the message's body. See also &$message_linecount$&.
11273
11274 .vitem &$body_zerocount$&
11275 .cindex "message body" "binary zero count"
11276 .cindex "body of message" "binary zero count"
11277 .cindex "binary zero" "in message body"
11278 .vindex "&$body_zerocount$&"
11279 When a message is being received or delivered, this variable contains the
11280 number of binary zero bytes (ASCII NULs) in the message's body.
11281
11282 .vitem &$bounce_recipient$&
11283 .vindex "&$bounce_recipient$&"
11284 This is set to the recipient address of a bounce message while Exim is creating
11285 it. It is useful if a customized bounce message text file is in use (see
11286 chapter &<<CHAPemsgcust>>&).
11287
11288 .vitem &$bounce_return_size_limit$&
11289 .vindex "&$bounce_return_size_limit$&"
11290 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11291 up to a multiple of 1000. It is useful when a customized error message text
11292 file is in use (see chapter &<<CHAPemsgcust>>&).
11293
11294 .vitem &$caller_gid$&
11295 .cindex "gid (group id)" "caller"
11296 .vindex "&$caller_gid$&"
11297 The real group id under which the process that called Exim was running. This is
11298 not the same as the group id of the originator of a message (see
11299 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11300 incarnation normally contains the Exim gid.
11301
11302 .vitem &$caller_uid$&
11303 .cindex "uid (user id)" "caller"
11304 .vindex "&$caller_uid$&"
11305 The real user id under which the process that called Exim was running. This is
11306 not the same as the user id of the originator of a message (see
11307 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11308 incarnation normally contains the Exim uid.
11309
11310 .vitem &$compile_date$&
11311 .vindex "&$compile_date$&"
11312 The date on which the Exim binary was compiled.
11313
11314 .vitem &$compile_number$&
11315 .vindex "&$compile_number$&"
11316 The building process for Exim keeps a count of the number
11317 of times it has been compiled. This serves to distinguish different
11318 compilations of the same version of the program.
11319
11320 .new
11321 .vitem &$config_dir$&
11322 .vindex "&$config_dir$&"
11323 The directory name of the main configuration file. That is, the content of
11324 &$config_file$& with the last component stripped. The value does not
11325 contain the trailing slash. If &$config_file$& does not contain a slash,
11326 &$config_dir$& is ".".
11327
11328 .vitem &$config_file$&
11329 .vindex "&$config_file$&"
11330 The name of the main configuration file Exim is using.
11331 .wen
11332
11333 .vitem &$demime_errorlevel$&
11334 .vindex "&$demime_errorlevel$&"
11335 This variable is available when Exim is compiled with
11336 the content-scanning extension and the obsolete &%demime%& condition. For
11337 details, see section &<<SECTdemimecond>>&.
11338
11339 .vitem &$demime_reason$&
11340 .vindex "&$demime_reason$&"
11341 This variable is available when Exim is compiled with the
11342 content-scanning extension and the obsolete &%demime%& condition. For details,
11343 see section &<<SECTdemimecond>>&.
11344
11345 .vitem &$dnslist_domain$& &&&
11346        &$dnslist_matched$& &&&
11347        &$dnslist_text$& &&&
11348        &$dnslist_value$&
11349 .vindex "&$dnslist_domain$&"
11350 .vindex "&$dnslist_matched$&"
11351 .vindex "&$dnslist_text$&"
11352 .vindex "&$dnslist_value$&"
11353 .cindex "black list (DNS)"
11354 When a DNS (black) list lookup succeeds, these variables are set to contain
11355 the following data from the lookup: the list's domain name, the key that was
11356 looked up, the contents of any associated TXT record, and the value from the
11357 main A record. See section &<<SECID204>>& for more details.
11358
11359 .vitem &$domain$&
11360 .vindex "&$domain$&"
11361 When an address is being routed, or delivered on its own, this variable
11362 contains the domain. Uppercase letters in the domain are converted into lower
11363 case for &$domain$&.
11364
11365 Global address rewriting happens when a message is received, so the value of
11366 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11367 is set during user filtering, but not during system filtering, because a
11368 message may have many recipients and the system filter is called just once.
11369
11370 When more than one address is being delivered at once (for example, several
11371 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11372 have the same domain. Transports can be restricted to handling only one domain
11373 at a time if the value of &$domain$& is required at transport time &-- this is
11374 the default for local transports. For further details of the environment in
11375 which local transports are run, see chapter &<<CHAPenvironment>>&.
11376
11377 .oindex "&%delay_warning_condition%&"
11378 At the end of a delivery, if all deferred addresses have the same domain, it is
11379 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11380
11381 The &$domain$& variable is also used in some other circumstances:
11382
11383 .ilist
11384 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11385 the recipient address. The domain of the &'sender'& address is in
11386 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11387 normally set during the running of the MAIL ACL. However, if the sender address
11388 is verified with a callout during the MAIL ACL, the sender domain is placed in
11389 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11390 the &(smtp)& transport.
11391
11392 .next
11393 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11394 &$domain$& contains the domain portion of the address that is being rewritten;
11395 it can be used in the expansion of the replacement address, for example, to
11396 rewrite domains by file lookup.
11397
11398 .next
11399 With one important exception, whenever a domain list is being scanned,
11400 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11401 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11402 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11403 that, in a RCPT ACL, the sender domain list can be dependent on the
11404 recipient domain (which is what is in &$domain$& at this time).
11405
11406 .next
11407 .cindex "ETRN" "value of &$domain$&"
11408 .oindex "&%smtp_etrn_command%&"
11409 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11410 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11411 .endlist
11412
11413
11414 .vitem &$domain_data$&
11415 .vindex "&$domain_data$&"
11416 When the &%domains%& option on a router matches a domain by
11417 means of a lookup, the data read by the lookup is available during the running
11418 of the router as &$domain_data$&. In addition, if the driver routes the
11419 address to a transport, the value is available in that transport. If the
11420 transport is handling multiple addresses, the value from the first address is
11421 used.
11422
11423 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11424 domain by means of a lookup. The data read by the lookup is available during
11425 the rest of the ACL statement. In all other situations, this variable expands
11426 to nothing.
11427
11428 .vitem &$exim_gid$&
11429 .vindex "&$exim_gid$&"
11430 This variable contains the numerical value of the Exim group id.
11431
11432 .vitem &$exim_path$&
11433 .vindex "&$exim_path$&"
11434 This variable contains the path to the Exim binary.
11435
11436 .vitem &$exim_uid$&
11437 .vindex "&$exim_uid$&"
11438 This variable contains the numerical value of the Exim user id.
11439
11440 .new
11441 .vitem &$exim_version$&
11442 .vindex "&$exim_version$&"
11443 This variable contains the version string of the Exim build.
11444 The first character is a major version number, currently 4.
11445 Then after a dot, the next group of digits is a minor version number.
11446 There may be other characters following the minor version.
11447 .wen
11448
11449 .vitem &$found_extension$&
11450 .vindex "&$found_extension$&"
11451 This variable is available when Exim is compiled with the
11452 content-scanning extension and the obsolete &%demime%& condition. For details,
11453 see section &<<SECTdemimecond>>&.
11454
11455 .vitem &$header_$&<&'name'&>
11456 This is not strictly an expansion variable. It is expansion syntax for
11457 inserting the message header line with the given name. Note that the name must
11458 be terminated by colon or white space, because it may contain a wide variety of
11459 characters. Note also that braces must &'not'& be used.
11460
11461 .vitem &$headers_added$&
11462 .vindex "&$headers_added$&"
11463 Within an ACL this variable contains the headers added so far by
11464 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11465 The headers are a newline-separated list.
11466
11467 .vitem &$home$&
11468 .vindex "&$home$&"
11469 When the &%check_local_user%& option is set for a router, the user's home
11470 directory is placed in &$home$& when the check succeeds. In particular, this
11471 means it is set during the running of users' filter files. A router may also
11472 explicitly set a home directory for use by a transport; this can be overridden
11473 by a setting on the transport itself.
11474
11475 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11476 of the environment variable HOME.
11477
11478 .vitem &$host$&
11479 .vindex "&$host$&"
11480 If a router assigns an address to a transport (any transport), and passes a
11481 list of hosts with the address, the value of &$host$& when the transport starts
11482 to run is the name of the first host on the list. Note that this applies both
11483 to local and remote transports.
11484
11485 .cindex "transport" "filter"
11486 .cindex "filter" "transport filter"
11487 For the &(smtp)& transport, if there is more than one host, the value of
11488 &$host$& changes as the transport works its way through the list. In
11489 particular, when the &(smtp)& transport is expanding its options for encryption
11490 using TLS, or for specifying a transport filter (see chapter
11491 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11492 is connected.
11493
11494 When used in the client part of an authenticator configuration (see chapter
11495 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11496 client is connected.
11497
11498
11499 .vitem &$host_address$&
11500 .vindex "&$host_address$&"
11501 This variable is set to the remote host's IP address whenever &$host$& is set
11502 for a remote connection. It is also set to the IP address that is being checked
11503 when the &%ignore_target_hosts%& option is being processed.
11504
11505 .vitem &$host_data$&
11506 .vindex "&$host_data$&"
11507 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11508 result of the lookup is made available in the &$host_data$& variable. This
11509 allows you, for example, to do things like this:
11510 .code
11511 deny  hosts = net-lsearch;/some/file
11512 message = $host_data
11513 .endd
11514 .vitem &$host_lookup_deferred$&
11515 .cindex "host name" "lookup, failure of"
11516 .vindex "&$host_lookup_deferred$&"
11517 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11518 message comes from a remote host and there is an attempt to look up the host's
11519 name from its IP address, and the attempt is not successful, one of these
11520 variables is set to &"1"&.
11521
11522 .ilist
11523 If the lookup receives a definite negative response (for example, a DNS lookup
11524 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11525
11526 .next
11527 If there is any kind of problem during the lookup, such that Exim cannot
11528 tell whether or not the host name is defined (for example, a timeout for a DNS
11529 lookup), &$host_lookup_deferred$& is set to &"1"&.
11530 .endlist ilist
11531
11532 Looking up a host's name from its IP address consists of more than just a
11533 single reverse lookup. Exim checks that a forward lookup of at least one of the
11534 names it receives from a reverse lookup yields the original IP address. If this
11535 is not the case, Exim does not accept the looked up name(s), and
11536 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11537 IP address (for example, the existence of a PTR record in the DNS) is not
11538 sufficient on its own for the success of a host name lookup. If the reverse
11539 lookup succeeds, but there is a lookup problem such as a timeout when checking
11540 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11541 &"1"&. See also &$sender_host_name$&.
11542
11543 .vitem &$host_lookup_failed$&
11544 .vindex "&$host_lookup_failed$&"
11545 See &$host_lookup_deferred$&.
11546
11547 .vitem &$host_port$&
11548 .vindex "&$host_port$&"
11549 This variable is set to the remote host's TCP port whenever &$host$& is set
11550 for an outbound connection.
11551
11552
11553 .vitem &$inode$&
11554 .vindex "&$inode$&"
11555 The only time this variable is set is while expanding the &%directory_file%&
11556 option in the &(appendfile)& transport. The variable contains the inode number
11557 of the temporary file which is about to be renamed. It can be used to construct
11558 a unique name for the file.
11559
11560 .vitem &$interface_address$&
11561 .vindex "&$interface_address$&"
11562 This is an obsolete name for &$received_ip_address$&.
11563
11564 .vitem &$interface_port$&
11565 .vindex "&$interface_port$&"
11566 This is an obsolete name for &$received_port$&.
11567
11568 .vitem &$item$&
11569 .vindex "&$item$&"
11570 This variable is used during the expansion of &*forall*& and &*forany*&
11571 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11572 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11573 empty.
11574
11575 .vitem &$ldap_dn$&
11576 .vindex "&$ldap_dn$&"
11577 This variable, which is available only when Exim is compiled with LDAP support,
11578 contains the DN from the last entry in the most recently successful LDAP
11579 lookup.
11580
11581 .vitem &$load_average$&
11582 .vindex "&$load_average$&"
11583 This variable contains the system load average, multiplied by 1000 so that it
11584 is an integer. For example, if the load average is 0.21, the value of the
11585 variable is 210. The value is recomputed every time the variable is referenced.
11586
11587 .vitem &$local_part$&
11588 .vindex "&$local_part$&"
11589 When an address is being routed, or delivered on its own, this
11590 variable contains the local part. When a number of addresses are being
11591 delivered together (for example, multiple RCPT commands in an SMTP
11592 session), &$local_part$& is not set.
11593
11594 Global address rewriting happens when a message is received, so the value of
11595 &$local_part$& during routing and delivery is the value after rewriting.
11596 &$local_part$& is set during user filtering, but not during system filtering,
11597 because a message may have many recipients and the system filter is called just
11598 once.
11599
11600 .vindex "&$local_part_prefix$&"
11601 .vindex "&$local_part_suffix$&"
11602 If a local part prefix or suffix has been recognized, it is not included in the
11603 value of &$local_part$& during routing and subsequent delivery. The values of
11604 any prefix or suffix are in &$local_part_prefix$& and
11605 &$local_part_suffix$&, respectively.
11606
11607 When a message is being delivered to a file, pipe, or autoreply transport as a
11608 result of aliasing or forwarding, &$local_part$& is set to the local part of
11609 the parent address, not to the file name or command (see &$address_file$& and
11610 &$address_pipe$&).
11611
11612 When an ACL is running for a RCPT command, &$local_part$& contains the
11613 local part of the recipient address.
11614
11615 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11616 &$local_part$& contains the local part of the address that is being rewritten;
11617 it can be used in the expansion of the replacement address, for example.
11618
11619 In all cases, all quoting is removed from the local part. For example, for both
11620 the addresses
11621 .code
11622 "abc:xyz"@test.example
11623 abc\:xyz@test.example
11624 .endd
11625 the value of &$local_part$& is
11626 .code
11627 abc:xyz
11628 .endd
11629 If you use &$local_part$& to create another address, you should always wrap it
11630 inside a quoting operator. For example, in a &(redirect)& router you could
11631 have:
11632 .code
11633 data = ${quote_local_part:$local_part}@new.domain.example
11634 .endd
11635 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11636 to process local parts in a case-dependent manner in a router, you can set the
11637 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11638
11639 .vitem &$local_part_data$&
11640 .vindex "&$local_part_data$&"
11641 When the &%local_parts%& option on a router matches a local part by means of a
11642 lookup, the data read by the lookup is available during the running of the
11643 router as &$local_part_data$&. In addition, if the driver routes the address
11644 to a transport, the value is available in that transport. If the transport is
11645 handling multiple addresses, the value from the first address is used.
11646
11647 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11648 matches a local part by means of a lookup. The data read by the lookup is
11649 available during the rest of the ACL statement. In all other situations, this
11650 variable expands to nothing.
11651
11652 .vitem &$local_part_prefix$&
11653 .vindex "&$local_part_prefix$&"
11654 When an address is being routed or delivered, and a
11655 specific prefix for the local part was recognized, it is available in this
11656 variable, having been removed from &$local_part$&.
11657
11658 .vitem &$local_part_suffix$&
11659 .vindex "&$local_part_suffix$&"
11660 When an address is being routed or delivered, and a
11661 specific suffix for the local part was recognized, it is available in this
11662 variable, having been removed from &$local_part$&.
11663
11664 .vitem &$local_scan_data$&
11665 .vindex "&$local_scan_data$&"
11666 This variable contains the text returned by the &[local_scan()]& function when
11667 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11668
11669 .vitem &$local_user_gid$&
11670 .vindex "&$local_user_gid$&"
11671 See &$local_user_uid$&.
11672
11673 .vitem &$local_user_uid$&
11674 .vindex "&$local_user_uid$&"
11675 This variable and &$local_user_gid$& are set to the uid and gid after the
11676 &%check_local_user%& router precondition succeeds. This means that their values
11677 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11678 and &%condition%&), for the &%address_data%& expansion, and for any
11679 router-specific expansions. At all other times, the values in these variables
11680 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11681
11682 .vitem &$localhost_number$&
11683 .vindex "&$localhost_number$&"
11684 This contains the expanded value of the
11685 &%localhost_number%& option. The expansion happens after the main options have
11686 been read.
11687
11688 .vitem &$log_inodes$&
11689 .vindex "&$log_inodes$&"
11690 The number of free inodes in the disk partition where Exim's
11691 log files are being written. The value is recalculated whenever the variable is
11692 referenced. If the relevant file system does not have the concept of inodes,
11693 the value of is -1. See also the &%check_log_inodes%& option.
11694
11695 .vitem &$log_space$&
11696 .vindex "&$log_space$&"
11697 The amount of free space (as a number of kilobytes) in the disk
11698 partition where Exim's log files are being written. The value is recalculated
11699 whenever the variable is referenced. If the operating system does not have the
11700 ability to find the amount of free space (only true for experimental systems),
11701 the space value is -1. See also the &%check_log_space%& option.
11702
11703
11704 .vitem &$lookup_dnssec_authenticated$&
11705 .vindex "&$lookup_dnssec_authenticated$&"
11706 This variable is set after a DNS lookup done by
11707 a dnsdb lookup expansion, dnslookup router or smtp transport.
11708 .cindex "DNS" "DNSSEC"
11709 It will be empty if &(DNSSEC)& was not requested,
11710 &"no"& if the result was not labelled as authenticated data
11711 and &"yes"& if it was.
11712
11713 .vitem &$mailstore_basename$&
11714 .vindex "&$mailstore_basename$&"
11715 This variable is set only when doing deliveries in &"mailstore"& format in the
11716 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11717 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11718 contains the basename of the files that are being written, that is, the name
11719 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11720 variable is empty.
11721
11722 .vitem &$malware_name$&
11723 .vindex "&$malware_name$&"
11724 This variable is available when Exim is compiled with the
11725 content-scanning extension. It is set to the name of the virus that was found
11726 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11727
11728 .vitem &$max_received_linelength$&
11729 .vindex "&$max_received_linelength$&"
11730 .cindex "maximum" "line length"
11731 .cindex "line length" "maximum"
11732 This variable contains the number of bytes in the longest line that was
11733 received as part of the message, not counting the line termination
11734 character(s).
11735
11736 .vitem &$message_age$&
11737 .cindex "message" "age of"
11738 .vindex "&$message_age$&"
11739 This variable is set at the start of a delivery attempt to contain the number
11740 of seconds since the message was received. It does not change during a single
11741 delivery attempt.
11742
11743 .vitem &$message_body$&
11744 .cindex "body of message" "expansion variable"
11745 .cindex "message body" "in expansion"
11746 .cindex "binary zero" "in message body"
11747 .vindex "&$message_body$&"
11748 .oindex "&%message_body_visible%&"
11749 This variable contains the initial portion of a message's body while it is
11750 being delivered, and is intended mainly for use in filter files. The maximum
11751 number of characters of the body that are put into the variable is set by the
11752 &%message_body_visible%& configuration option; the default is 500.
11753
11754 .oindex "&%message_body_newlines%&"
11755 By default, newlines are converted into spaces in &$message_body$&, to make it
11756 easier to search for phrases that might be split over a line break. However,
11757 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11758 zeros are always converted into spaces.
11759
11760 .vitem &$message_body_end$&
11761 .cindex "body of message" "expansion variable"
11762 .cindex "message body" "in expansion"
11763 .vindex "&$message_body_end$&"
11764 This variable contains the final portion of a message's
11765 body while it is being delivered. The format and maximum size are as for
11766 &$message_body$&.
11767
11768 .vitem &$message_body_size$&
11769 .cindex "body of message" "size"
11770 .cindex "message body" "size"
11771 .vindex "&$message_body_size$&"
11772 When a message is being delivered, this variable contains the size of the body
11773 in bytes. The count starts from the character after the blank line that
11774 separates the body from the header. Newlines are included in the count. See
11775 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11776
11777 .vitem &$message_exim_id$&
11778 .vindex "&$message_exim_id$&"
11779 When a message is being received or delivered, this variable contains the
11780 unique message id that is generated and used by Exim to identify the message.
11781 An id is not created for a message until after its header has been successfully
11782 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11783 line; it is the local id that Exim assigns to the message, for example:
11784 &`1BXTIK-0001yO-VA`&.
11785
11786 .vitem &$message_headers$&
11787 .vindex &$message_headers$&
11788 This variable contains a concatenation of all the header lines when a message
11789 is being processed, except for lines added by routers or transports. The header
11790 lines are separated by newline characters. Their contents are decoded in the
11791 same way as a header line that is inserted by &%bheader%&.
11792
11793 .vitem &$message_headers_raw$&
11794 .vindex &$message_headers_raw$&
11795 This variable is like &$message_headers$& except that no processing of the
11796 contents of header lines is done.
11797
11798 .vitem &$message_id$&
11799 This is an old name for &$message_exim_id$&. It is now deprecated.
11800
11801 .vitem &$message_linecount$&
11802 .vindex "&$message_linecount$&"
11803 This variable contains the total number of lines in the header and body of the
11804 message. Compare &$body_linecount$&, which is the count for the body only.
11805 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11806 number of lines received. Before delivery happens (that is, before filters,
11807 routers, and transports run) the count is increased to include the
11808 &'Received:'& header line that Exim standardly adds, and also any other header
11809 lines that are added by ACLs. The blank line that separates the message header
11810 from the body is not counted.
11811
11812 As with the special case of &$message_size$&, during the expansion of the
11813 appendfile transport's maildir_tag option in maildir format, the value of
11814 &$message_linecount$& is the precise size of the number of newlines in the
11815 file that has been written (minus one for the blank line between the
11816 header and the body).
11817
11818 Here is an example of the use of this variable in a DATA ACL:
11819 .code
11820 deny message   = Too many lines in message header
11821      condition = \
11822       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11823 .endd
11824 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11825 message has not yet been received.
11826
11827 .vitem &$message_size$&
11828 .cindex "size" "of message"
11829 .cindex "message" "size"
11830 .vindex "&$message_size$&"
11831 When a message is being processed, this variable contains its size in bytes. In
11832 most cases, the size includes those headers that were received with the
11833 message, but not those (such as &'Envelope-to:'&) that are added to individual
11834 deliveries as they are written. However, there is one special case: during the
11835 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11836 doing a delivery in maildir format, the value of &$message_size$& is the
11837 precise size of the file that has been written. See also
11838 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11839
11840 .cindex "RCPT" "value of &$message_size$&"
11841 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11842 contains the size supplied on the MAIL command, or -1 if no size was given. The
11843 value may not, of course, be truthful.
11844
11845 .vitem &$mime_$&&'xxx'&
11846 A number of variables whose names start with &$mime$& are
11847 available when Exim is compiled with the content-scanning extension. For
11848 details, see section &<<SECTscanmimepart>>&.
11849
11850 .vitem "&$n0$& &-- &$n9$&"
11851 These variables are counters that can be incremented by means
11852 of the &%add%& command in filter files.
11853
11854 .vitem &$original_domain$&
11855 .vindex "&$domain$&"
11856 .vindex "&$original_domain$&"
11857 When a top-level address is being processed for delivery, this contains the
11858 same value as &$domain$&. However, if a &"child"& address (for example,
11859 generated by an alias, forward, or filter file) is being processed, this
11860 variable contains the domain of the original address (lower cased). This
11861 differs from &$parent_domain$& only when there is more than one level of
11862 aliasing or forwarding. When more than one address is being delivered in a
11863 single transport run, &$original_domain$& is not set.
11864
11865 If a new address is created by means of a &%deliver%& command in a system
11866 filter, it is set up with an artificial &"parent"& address. This has the local
11867 part &'system-filter'& and the default qualify domain.
11868
11869 .vitem &$original_local_part$&
11870 .vindex "&$local_part$&"
11871 .vindex "&$original_local_part$&"
11872 When a top-level address is being processed for delivery, this contains the
11873 same value as &$local_part$&, unless a prefix or suffix was removed from the
11874 local part, because &$original_local_part$& always contains the full local
11875 part. When a &"child"& address (for example, generated by an alias, forward, or
11876 filter file) is being processed, this variable contains the full local part of
11877 the original address.
11878
11879 If the router that did the redirection processed the local part
11880 case-insensitively, the value in &$original_local_part$& is in lower case.
11881 This variable differs from &$parent_local_part$& only when there is more than
11882 one level of aliasing or forwarding. When more than one address is being
11883 delivered in a single transport run, &$original_local_part$& is not set.
11884
11885 If a new address is created by means of a &%deliver%& command in a system
11886 filter, it is set up with an artificial &"parent"& address. This has the local
11887 part &'system-filter'& and the default qualify domain.
11888
11889 .vitem &$originator_gid$&
11890 .cindex "gid (group id)" "of originating user"
11891 .cindex "sender" "gid"
11892 .vindex "&$caller_gid$&"
11893 .vindex "&$originator_gid$&"
11894 This variable contains the value of &$caller_gid$& that was set when the
11895 message was received. For messages received via the command line, this is the
11896 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11897 normally the gid of the Exim user.
11898
11899 .vitem &$originator_uid$&
11900 .cindex "uid (user id)" "of originating user"
11901 .cindex "sender" "uid"
11902 .vindex "&$caller_uid$&"
11903 .vindex "&$originaltor_uid$&"
11904 The value of &$caller_uid$& that was set when the message was received. For
11905 messages received via the command line, this is the uid of the sending user.
11906 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11907 user.
11908
11909 .vitem &$parent_domain$&
11910 .vindex "&$parent_domain$&"
11911 This variable is similar to &$original_domain$& (see
11912 above), except that it refers to the immediately preceding parent address.
11913
11914 .vitem &$parent_local_part$&
11915 .vindex "&$parent_local_part$&"
11916 This variable is similar to &$original_local_part$&
11917 (see above), except that it refers to the immediately preceding parent address.
11918
11919 .vitem &$pid$&
11920 .cindex "pid (process id)" "of current process"
11921 .vindex "&$pid$&"
11922 This variable contains the current process id.
11923
11924 .vitem &$pipe_addresses$&
11925 .cindex "filter" "transport filter"
11926 .cindex "transport" "filter"
11927 .vindex "&$pipe_addresses$&"
11928 This is not an expansion variable, but is mentioned here because the string
11929 &`$pipe_addresses`& is handled specially in the command specification for the
11930 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11931 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11932 It cannot be used in general expansion strings, and provokes an &"unknown
11933 variable"& error if encountered.
11934
11935 .vitem &$primary_hostname$&
11936 .vindex "&$primary_hostname$&"
11937 This variable contains the value set by &%primary_hostname%& in the
11938 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11939 a single-component name, Exim calls &[gethostbyname()]& (or
11940 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11941 qualified host name. See also &$smtp_active_hostname$&.
11942
11943
11944 .vitem &$prvscheck_address$&
11945 This variable is used in conjunction with the &%prvscheck%& expansion item,
11946 which is described in sections &<<SECTexpansionitems>>& and
11947 &<<SECTverifyPRVS>>&.
11948
11949 .vitem &$prvscheck_keynum$&
11950 This variable is used in conjunction with the &%prvscheck%& expansion item,
11951 which is described in sections &<<SECTexpansionitems>>& and
11952 &<<SECTverifyPRVS>>&.
11953
11954 .vitem &$prvscheck_result$&
11955 This variable is used in conjunction with the &%prvscheck%& expansion item,
11956 which is described in sections &<<SECTexpansionitems>>& and
11957 &<<SECTverifyPRVS>>&.
11958
11959 .vitem &$qualify_domain$&
11960 .vindex "&$qualify_domain$&"
11961 The value set for the &%qualify_domain%& option in the configuration file.
11962
11963 .vitem &$qualify_recipient$&
11964 .vindex "&$qualify_recipient$&"
11965 The value set for the &%qualify_recipient%& option in the configuration file,
11966 or if not set, the value of &$qualify_domain$&.
11967
11968 .vitem &$rcpt_count$&
11969 .vindex "&$rcpt_count$&"
11970 When a message is being received by SMTP, this variable contains the number of
11971 RCPT commands received for the current message. If this variable is used in a
11972 RCPT ACL, its value includes the current command.
11973
11974 .vitem &$rcpt_defer_count$&
11975 .vindex "&$rcpt_defer_count$&"
11976 .cindex "4&'xx'& responses" "count of"
11977 When a message is being received by SMTP, this variable contains the number of
11978 RCPT commands in the current message that have previously been rejected with a
11979 temporary (4&'xx'&) response.
11980
11981 .vitem &$rcpt_fail_count$&
11982 .vindex "&$rcpt_fail_count$&"
11983 When a message is being received by SMTP, this variable contains the number of
11984 RCPT commands in the current message that have previously been rejected with a
11985 permanent (5&'xx'&) response.
11986
11987 .vitem &$received_count$&
11988 .vindex "&$received_count$&"
11989 This variable contains the number of &'Received:'& header lines in the message,
11990 including the one added by Exim (so its value is always greater than zero). It
11991 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11992 delivering.
11993
11994 .vitem &$received_for$&
11995 .vindex "&$received_for$&"
11996 If there is only a single recipient address in an incoming message, this
11997 variable contains that address when the &'Received:'& header line is being
11998 built. The value is copied after recipient rewriting has happened, but before
11999 the &[local_scan()]& function is run.
12000
12001 .vitem &$received_ip_address$&
12002 .vindex "&$received_ip_address$&"
12003 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12004 variable is set to the address of the local IP interface, and &$received_port$&
12005 is set to the local port number. (The remote IP address and port are in
12006 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12007 the port value is -1 unless it has been set using the &%-oMi%& command line
12008 option.
12009
12010 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12011 could be used, for example, to make the file name for a TLS certificate depend
12012 on which interface and/or port is being used for the incoming connection. The
12013 values of &$received_ip_address$& and &$received_port$& are saved with any
12014 messages that are received, thus making these variables available at delivery
12015 time.
12016 For outbound connections see &$sending_ip_address$&.
12017
12018 .vitem &$received_port$&
12019 .vindex "&$received_port$&"
12020 See &$received_ip_address$&.
12021
12022 .vitem &$received_protocol$&
12023 .vindex "&$received_protocol$&"
12024 When a message is being processed, this variable contains the name of the
12025 protocol by which it was received. Most of the names used by Exim are defined
12026 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12027 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12028 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12029 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12030 connection and the client was successfully authenticated.
12031
12032 Exim uses the protocol name &"smtps"& for the case when encryption is
12033 automatically set up on connection without the use of STARTTLS (see
12034 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12035 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12036 where the client initially uses EHLO, sets up an encrypted connection using
12037 STARTTLS, and then uses HELO afterwards.
12038
12039 The &%-oMr%& option provides a way of specifying a custom protocol name for
12040 messages that are injected locally by trusted callers. This is commonly used to
12041 identify messages that are being re-injected after some kind of scanning.
12042
12043 .vitem &$received_time$&
12044 .vindex "&$received_time$&"
12045 This variable contains the date and time when the current message was received,
12046 as a number of seconds since the start of the Unix epoch.
12047
12048 .vitem &$recipient_data$&
12049 .vindex "&$recipient_data$&"
12050 This variable is set after an indexing lookup success in an ACL &%recipients%&
12051 condition. It contains the data from the lookup, and the value remains set
12052 until the next &%recipients%& test. Thus, you can do things like this:
12053 .display
12054 &`require recipients  = cdb*@;/some/file`&
12055 &`deny    `&&'some further test involving'& &`$recipient_data`&
12056 .endd
12057 &*Warning*&: This variable is set only when a lookup is used as an indexing
12058 method in the address list, using the semicolon syntax as in the example above.
12059 The variable is not set for a lookup that is used as part of the string
12060 expansion that all such lists undergo before being interpreted.
12061
12062 .vitem &$recipient_verify_failure$&
12063 .vindex "&$recipient_verify_failure$&"
12064 In an ACL, when a recipient verification fails, this variable contains
12065 information about the failure. It is set to one of the following words:
12066
12067 .ilist
12068 &"qualify"&: The address was unqualified (no domain), and the message
12069 was neither local nor came from an exempted host.
12070
12071 .next
12072 &"route"&: Routing failed.
12073
12074 .next
12075 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12076 or before the MAIL command (that is, on initial connection, HELO, or
12077 MAIL).
12078
12079 .next
12080 &"recipient"&: The RCPT command in a callout was rejected.
12081 .next
12082
12083 &"postmaster"&: The postmaster check in a callout was rejected.
12084 .endlist
12085
12086 The main use of this variable is expected to be to distinguish between
12087 rejections of MAIL and rejections of RCPT.
12088
12089 .vitem &$recipients$&
12090 .vindex "&$recipients$&"
12091 This variable contains a list of envelope recipients for a message. A comma and
12092 a space separate the addresses in the replacement text. However, the variable
12093 is not generally available, to prevent exposure of Bcc recipients in
12094 unprivileged users' filter files. You can use &$recipients$& only in these
12095 cases:
12096
12097 .olist
12098 In a system filter file.
12099 .next
12100 In the ACLs associated with the DATA command and with non-SMTP messages, that
12101 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12102 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12103 &%acl_not_smtp_mime%&.
12104 .next
12105 From within a &[local_scan()]& function.
12106 .endlist
12107
12108
12109 .vitem &$recipients_count$&
12110 .vindex "&$recipients_count$&"
12111 When a message is being processed, this variable contains the number of
12112 envelope recipients that came with the message. Duplicates are not excluded
12113 from the count. While a message is being received over SMTP, the number
12114 increases for each accepted recipient. It can be referenced in an ACL.
12115
12116
12117 .vitem &$regex_match_string$&
12118 .vindex "&$regex_match_string$&"
12119 This variable is set to contain the matching regular expression after a
12120 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12121
12122
12123 .vitem &$reply_address$&
12124 .vindex "&$reply_address$&"
12125 When a message is being processed, this variable contains the contents of the
12126 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12127 contents of the &'From:'& header line. Apart from the removal of leading
12128 white space, the value is not processed in any way. In particular, no RFC 2047
12129 decoding or character code translation takes place.
12130
12131 .vitem &$return_path$&
12132 .vindex "&$return_path$&"
12133 When a message is being delivered, this variable contains the return path &--
12134 the sender field that will be sent as part of the envelope. It is not enclosed
12135 in <> characters. At the start of routing an address, &$return_path$& has the
12136 same value as &$sender_address$&, but if, for example, an incoming message to a
12137 mailing list has been expanded by a router which specifies a different address
12138 for bounce messages, &$return_path$& subsequently contains the new bounce
12139 address, whereas &$sender_address$& always contains the original sender address
12140 that was received with the message. In other words, &$sender_address$& contains
12141 the incoming envelope sender, and &$return_path$& contains the outgoing
12142 envelope sender.
12143
12144 .vitem &$return_size_limit$&
12145 .vindex "&$return_size_limit$&"
12146 This is an obsolete name for &$bounce_return_size_limit$&.
12147
12148 .vitem &$router_name$&
12149 .cindex "router" "name"
12150 .cindex "name" "of router"
12151 .vindex "&$router_name$&"
12152 During the running of a router this variable contains its name.
12153
12154 .vitem &$runrc$&
12155 .cindex "return code" "from &%run%& expansion"
12156 .vindex "&$runrc$&"
12157 This variable contains the return code from a command that is run by the
12158 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12159 assume the order in which option values are expanded, except for those
12160 preconditions whose order of testing is documented. Therefore, you cannot
12161 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12162 another.
12163
12164 .vitem &$self_hostname$&
12165 .oindex "&%self%&" "value of host name"
12166 .vindex "&$self_hostname$&"
12167 When an address is routed to a supposedly remote host that turns out to be the
12168 local host, what happens is controlled by the &%self%& generic router option.
12169 One of its values causes the address to be passed to another router. When this
12170 happens, &$self_hostname$& is set to the name of the local host that the
12171 original router encountered. In other circumstances its contents are null.
12172
12173 .vitem &$sender_address$&
12174 .vindex "&$sender_address$&"
12175 When a message is being processed, this variable contains the sender's address
12176 that was received in the message's envelope. The case of letters in the address
12177 is retained, in both the local part and the domain. For bounce messages, the
12178 value of this variable is the empty string. See also &$return_path$&.
12179
12180 .vitem &$sender_address_data$&
12181 .vindex "&$address_data$&"
12182 .vindex "&$sender_address_data$&"
12183 If &$address_data$& is set when the routers are called from an ACL to verify a
12184 sender address, the final value is preserved in &$sender_address_data$&, to
12185 distinguish it from data from a recipient address. The value does not persist
12186 after the end of the current ACL statement. If you want to preserve it for
12187 longer, you can save it in an ACL variable.
12188
12189 .vitem &$sender_address_domain$&
12190 .vindex "&$sender_address_domain$&"
12191 The domain portion of &$sender_address$&.
12192
12193 .vitem &$sender_address_local_part$&
12194 .vindex "&$sender_address_local_part$&"
12195 The local part portion of &$sender_address$&.
12196
12197 .vitem &$sender_data$&
12198 .vindex "&$sender_data$&"
12199 This variable is set after a lookup success in an ACL &%senders%& condition or
12200 in a router &%senders%& option. It contains the data from the lookup, and the
12201 value remains set until the next &%senders%& test. Thus, you can do things like
12202 this:
12203 .display
12204 &`require senders      = cdb*@;/some/file`&
12205 &`deny    `&&'some further test involving'& &`$sender_data`&
12206 .endd
12207 &*Warning*&: This variable is set only when a lookup is used as an indexing
12208 method in the address list, using the semicolon syntax as in the example above.
12209 The variable is not set for a lookup that is used as part of the string
12210 expansion that all such lists undergo before being interpreted.
12211
12212 .vitem &$sender_fullhost$&
12213 .vindex "&$sender_fullhost$&"
12214 When a message is received from a remote host, this variable contains the host
12215 name and IP address in a single string. It ends with the IP address in square
12216 brackets, followed by a colon and a port number if the logging of ports is
12217 enabled. The format of the rest of the string depends on whether the host
12218 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12219 looking up its IP address. (Looking up the IP address can be forced by the
12220 &%host_lookup%& option, independent of verification.) A plain host name at the
12221 start of the string is a verified host name; if this is not present,
12222 verification either failed or was not requested. A host name in parentheses is
12223 the argument of a HELO or EHLO command. This is omitted if it is identical to
12224 the verified host name or to the host's IP address in square brackets.
12225
12226 .new
12227 .vitem &$sender_helo_dnssec$&
12228 .vindex "&$sender_helo_dnssec$&"
12229 This boolean variable is true if a successful HELO verification was
12230 .cindex "DNS" "DNSSEC"
12231 done using DNS information the resolver library stated was authenticatied data.
12232 .wen
12233
12234 .vitem &$sender_helo_name$&
12235 .vindex "&$sender_helo_name$&"
12236 When a message is received from a remote host that has issued a HELO or EHLO
12237 command, the argument of that command is placed in this variable. It is also
12238 set if HELO or EHLO is used when a message is received using SMTP locally via
12239 the &%-bs%& or &%-bS%& options.
12240
12241 .vitem &$sender_host_address$&
12242 .vindex "&$sender_host_address$&"
12243 When a message is received from a remote host using SMTP,
12244 this variable contains that
12245 host's IP address. For locally non-SMTP submitted messages, it is empty.
12246
12247 .vitem &$sender_host_authenticated$&
12248 .vindex "&$sender_host_authenticated$&"
12249 This variable contains the name (not the public name) of the authenticator
12250 driver that successfully authenticated the client from which the message was
12251 received. It is empty if there was no successful authentication. See also
12252 &$authenticated_id$&.
12253
12254 .vitem &$sender_host_dnssec$&
12255 .vindex "&$sender_host_dnssec$&"
12256 If an attempt to populate &$sender_host_name$& has been made
12257 (by reference, &%hosts_lookup%& or
12258 otherwise) then this boolean will have been set true if, and only if, the
12259 resolver library states that both
12260 the reverse and forward DNS were authenticated data.  At all
12261 other times, this variable is false.
12262
12263 .cindex "DNS" "DNSSEC"
12264 It is likely that you will need to coerce DNSSEC support on in the resolver
12265 library, by setting:
12266 .code
12267 dns_dnssec_ok = 1
12268 .endd
12269
12270 Exim does not perform DNSSEC validation itself, instead leaving that to a
12271 validating resolver (eg, unbound, or bind with suitable configuration).
12272
12273 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12274 mechanism in the list, then this variable will be false.
12275
12276
12277 .vitem &$sender_host_name$&
12278 .vindex "&$sender_host_name$&"
12279 When a message is received from a remote host, this variable contains the
12280 host's name as obtained by looking up its IP address. For messages received by
12281 other means, this variable is empty.
12282
12283 .vindex "&$host_lookup_failed$&"
12284 If the host name has not previously been looked up, a reference to
12285 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12286 A looked up name is accepted only if it leads back to the original IP address
12287 via a forward lookup. If either the reverse or the forward lookup fails to find
12288 any data, or if the forward lookup does not yield the original IP address,
12289 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12290
12291 .vindex "&$host_lookup_deferred$&"
12292 However, if either of the lookups cannot be completed (for example, there is a
12293 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12294 &$host_lookup_failed$& remains set to &"0"&.
12295
12296 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12297 host name again if there is a subsequent reference to &$sender_host_name$&
12298 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12299 is set to &"1"&.
12300
12301 Exim does not automatically look up every calling host's name. If you want
12302 maximum efficiency, you should arrange your configuration so that it avoids
12303 these lookups altogether. The lookup happens only if one or more of the
12304 following are true:
12305
12306 .ilist
12307 A string containing &$sender_host_name$& is expanded.
12308 .next
12309 The calling host matches the list in &%host_lookup%&. In the default
12310 configuration, this option is set to *, so it must be changed if lookups are
12311 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12312 .next
12313 Exim needs the host name in order to test an item in a host list. The items
12314 that require this are described in sections &<<SECThoslispatnam>>& and
12315 &<<SECThoslispatnamsk>>&.
12316 .next
12317 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12318 In this case, the host name is required to compare with the name quoted in any
12319 EHLO or HELO commands that the client issues.
12320 .next
12321 The remote host issues a EHLO or HELO command that quotes one of the
12322 domains in &%helo_lookup_domains%&. The default value of this option is
12323 . ==== As this is a nested list, any displays it contains must be indented
12324 . ==== as otherwise they are too far to the left.
12325 .code
12326   helo_lookup_domains = @ : @[]
12327 .endd
12328 which causes a lookup if a remote host (incorrectly) gives the server's name or
12329 IP address in an EHLO or HELO command.
12330 .endlist
12331
12332
12333 .vitem &$sender_host_port$&
12334 .vindex "&$sender_host_port$&"
12335 When a message is received from a remote host, this variable contains the port
12336 number that was used on the remote host.
12337
12338 .vitem &$sender_ident$&
12339 .vindex "&$sender_ident$&"
12340 When a message is received from a remote host, this variable contains the
12341 identification received in response to an RFC 1413 request. When a message has
12342 been received locally, this variable contains the login name of the user that
12343 called Exim.
12344
12345 .vitem &$sender_rate_$&&'xxx'&
12346 A number of variables whose names begin &$sender_rate_$& are set as part of the
12347 &%ratelimit%& ACL condition. Details are given in section
12348 &<<SECTratelimiting>>&.
12349
12350 .vitem &$sender_rcvhost$&
12351 .cindex "DNS" "reverse lookup"
12352 .cindex "reverse DNS lookup"
12353 .vindex "&$sender_rcvhost$&"
12354 This is provided specifically for use in &'Received:'& headers. It starts with
12355 either the verified host name (as obtained from a reverse DNS lookup) or, if
12356 there is no verified host name, the IP address in square brackets. After that
12357 there may be text in parentheses. When the first item is a verified host name,
12358 the first thing in the parentheses is the IP address in square brackets,
12359 followed by a colon and a port number if port logging is enabled. When the
12360 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12361 the parentheses.
12362
12363 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12364 was used and its argument was not identical to the real host name or IP
12365 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12366 all three items are present in the parentheses, a newline and tab are inserted
12367 into the string, to improve the formatting of the &'Received:'& header.
12368
12369 .vitem &$sender_verify_failure$&
12370 .vindex "&$sender_verify_failure$&"
12371 In an ACL, when a sender verification fails, this variable contains information
12372 about the failure. The details are the same as for
12373 &$recipient_verify_failure$&.
12374
12375 .vitem &$sending_ip_address$&
12376 .vindex "&$sending_ip_address$&"
12377 This variable is set whenever an outgoing SMTP connection to another host has
12378 been set up. It contains the IP address of the local interface that is being
12379 used. This is useful if a host that has more than one IP address wants to take
12380 on different personalities depending on which one is being used. For incoming
12381 connections, see &$received_ip_address$&.
12382
12383 .vitem &$sending_port$&
12384 .vindex "&$sending_port$&"
12385 This variable is set whenever an outgoing SMTP connection to another host has
12386 been set up. It contains the local port that is being used. For incoming
12387 connections, see &$received_port$&.
12388
12389 .vitem &$smtp_active_hostname$&
12390 .vindex "&$smtp_active_hostname$&"
12391 During an incoming SMTP session, this variable contains the value of the active
12392 host name, as specified by the &%smtp_active_hostname%& option. The value of
12393 &$smtp_active_hostname$& is saved with any message that is received, so its
12394 value can be consulted during routing and delivery.
12395
12396 .vitem &$smtp_command$&
12397 .vindex "&$smtp_command$&"
12398 During the processing of an incoming SMTP command, this variable contains the
12399 entire command. This makes it possible to distinguish between HELO and EHLO in
12400 the HELO ACL, and also to distinguish between commands such as these:
12401 .code
12402 MAIL FROM:<>
12403 MAIL FROM: <>
12404 .endd
12405 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12406 command, the address in &$smtp_command$& is the original address before any
12407 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12408 the address after SMTP-time rewriting.
12409
12410 .vitem &$smtp_command_argument$&
12411 .cindex "SMTP" "command, argument for"
12412 .vindex "&$smtp_command_argument$&"
12413 While an ACL is running to check an SMTP command, this variable contains the
12414 argument, that is, the text that follows the command name, with leading white
12415 space removed. Following the introduction of &$smtp_command$&, this variable is
12416 somewhat redundant, but is retained for backwards compatibility.
12417
12418 .vitem &$smtp_count_at_connection_start$&
12419 .vindex "&$smtp_count_at_connection_start$&"
12420 This variable is set greater than zero only in processes spawned by the Exim
12421 daemon for handling incoming SMTP connections. The name is deliberately long,
12422 in order to emphasize what the contents are. When the daemon accepts a new
12423 connection, it increments this variable. A copy of the variable is passed to
12424 the child process that handles the connection, but its value is fixed, and
12425 never changes. It is only an approximation of how many incoming connections
12426 there actually are, because many other connections may come and go while a
12427 single connection is being processed. When a child process terminates, the
12428 daemon decrements its copy of the variable.
12429
12430 .vitem "&$sn0$& &-- &$sn9$&"
12431 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12432 that were current at the end of the system filter file. This allows a system
12433 filter file to set values that can be tested in users' filter files. For
12434 example, a system filter could set a value indicating how likely it is that a
12435 message is junk mail.
12436
12437 .vitem &$spam_$&&'xxx'&
12438 A number of variables whose names start with &$spam$& are available when Exim
12439 is compiled with the content-scanning extension. For details, see section
12440 &<<SECTscanspamass>>&.
12441
12442
12443 .vitem &$spool_directory$&
12444 .vindex "&$spool_directory$&"
12445 The name of Exim's spool directory.
12446
12447 .vitem &$spool_inodes$&
12448 .vindex "&$spool_inodes$&"
12449 The number of free inodes in the disk partition where Exim's spool files are
12450 being written. The value is recalculated whenever the variable is referenced.
12451 If the relevant file system does not have the concept of inodes, the value of
12452 is -1. See also the &%check_spool_inodes%& option.
12453
12454 .vitem &$spool_space$&
12455 .vindex "&$spool_space$&"
12456 The amount of free space (as a number of kilobytes) in the disk partition where
12457 Exim's spool files are being written. The value is recalculated whenever the
12458 variable is referenced. If the operating system does not have the ability to
12459 find the amount of free space (only true for experimental systems), the space
12460 value is -1. For example, to check in an ACL that there is at least 50
12461 megabytes free on the spool, you could write:
12462 .code
12463 condition = ${if > {$spool_space}{50000}}
12464 .endd
12465 See also the &%check_spool_space%& option.
12466
12467
12468 .vitem &$thisaddress$&
12469 .vindex "&$thisaddress$&"
12470 This variable is set only during the processing of the &%foranyaddress%&
12471 command in a filter file. Its use is explained in the description of that
12472 command, which can be found in the separate document entitled &'Exim's
12473 interfaces to mail filtering'&.
12474
12475 .vitem &$tls_in_bits$&
12476 .vindex "&$tls_in_bits$&"
12477 Contains an approximation of the TLS cipher's bit-strength
12478 on the inbound connection; the meaning of
12479 this depends upon the TLS implementation used.
12480 If TLS has not been negotiated, the value will be 0.
12481 The value of this is automatically fed into the Cyrus SASL authenticator
12482 when acting as a server, to specify the "external SSF" (a SASL term).
12483
12484 The deprecated &$tls_bits$& variable refers to the inbound side
12485 except when used in the context of an outbound SMTP delivery, when it refers to
12486 the outbound.
12487
12488 .vitem &$tls_out_bits$&
12489 .vindex "&$tls_out_bits$&"
12490 Contains an approximation of the TLS cipher's bit-strength
12491 on an outbound SMTP connection; the meaning of
12492 this depends upon the TLS implementation used.
12493 If TLS has not been negotiated, the value will be 0.
12494
12495 .vitem &$tls_in_ourcert$&
12496 .vindex "&$tls_in_ourcert$&"
12497 This variable refers to the certificate presented to the peer of an
12498 inbound connection when the message was received.
12499 It is only useful as the argument of a
12500 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12501 or a &%def%& condition.
12502
12503 .vitem &$tls_in_peercert$&
12504 .vindex "&$tls_in_peercert$&"
12505 This variable refers to the certificate presented by the peer of an
12506 inbound connection when the message was received.
12507 It is only useful as the argument of a
12508 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12509 or a &%def%& condition.
12510 If certificate verification fails it may refer to a failing chain element
12511 which is not the leaf.
12512
12513 .vitem &$tls_out_ourcert$&
12514 .vindex "&$tls_out_ourcert$&"
12515 This variable refers to the certificate presented to the peer of an
12516 outbound connection.  It is only useful as the argument of a
12517 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12518 or a &%def%& condition.
12519
12520 .vitem &$tls_out_peercert$&
12521 .vindex "&$tls_out_peercert$&"
12522 This variable refers to the certificate presented by the peer of an
12523 outbound connection.  It is only useful as the argument of a
12524 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12525 or a &%def%& condition.
12526 If certificate verification fails it may refer to a failing chain element
12527 which is not the leaf.
12528
12529 .vitem &$tls_in_certificate_verified$&
12530 .vindex "&$tls_in_certificate_verified$&"
12531 This variable is set to &"1"& if a TLS certificate was verified when the
12532 message was received, and &"0"& otherwise.
12533
12534 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12535 except when used in the context of an outbound SMTP delivery, when it refers to
12536 the outbound.
12537
12538 .vitem &$tls_out_certificate_verified$&
12539 .vindex "&$tls_out_certificate_verified$&"
12540 This variable is set to &"1"& if a TLS certificate was verified when an
12541 outbound SMTP connection was made,
12542 and &"0"& otherwise.
12543
12544 .vitem &$tls_in_cipher$&
12545 .vindex "&$tls_in_cipher$&"
12546 .vindex "&$tls_cipher$&"
12547 When a message is received from a remote host over an encrypted SMTP
12548 connection, this variable is set to the cipher suite that was negotiated, for
12549 example DES-CBC3-SHA. In other circumstances, in particular, for message
12550 received over unencrypted connections, the variable is empty. Testing
12551 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12552 non-encrypted connections during ACL processing.
12553
12554 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12555 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12556 becomes the same as &$tls_out_cipher$&.
12557
12558 .vitem &$tls_out_cipher$&
12559 .vindex "&$tls_out_cipher$&"
12560 This variable is
12561 cleared before any outgoing SMTP connection is made,
12562 and then set to the outgoing cipher suite if one is negotiated. See chapter
12563 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12564 details of the &(smtp)& transport.
12565
12566 .vitem &$tls_in_ocsp$&
12567 .vindex "&$tls_in_ocsp$&"
12568 When a message is received from a remote client connection
12569 the result of any OCSP request from the client is encoded in this variable:
12570 .code
12571 0 OCSP proof was not requested (default value)
12572 1 No response to request
12573 2 Response not verified
12574 3 Verification failed
12575 4 Verification succeeded
12576 .endd
12577
12578 .vitem &$tls_out_ocsp$&
12579 .vindex "&$tls_out_ocsp$&"
12580 When a message is sent to a remote host connection
12581 the result of any OCSP request made is encoded in this variable.
12582 See &$tls_in_ocsp$& for values.
12583
12584 .vitem &$tls_in_peerdn$&
12585 .vindex "&$tls_in_peerdn$&"
12586 .vindex "&$tls_peerdn$&"
12587 When a message is received from a remote host over an encrypted SMTP
12588 connection, and Exim is configured to request a certificate from the client,
12589 the value of the Distinguished Name of the certificate is made available in the
12590 &$tls_in_peerdn$& during subsequent processing.
12591 If certificate verification fails it may refer to a failing chain element
12592 which is not the leaf.
12593
12594 The deprecated &$tls_peerdn$& variable refers to the inbound side
12595 except when used in the context of an outbound SMTP delivery, when it refers to
12596 the outbound.
12597
12598 .vitem &$tls_out_peerdn$&
12599 .vindex "&$tls_out_peerdn$&"
12600 When a message is being delivered to a remote host over an encrypted SMTP
12601 connection, and Exim is configured to request a certificate from the server,
12602 the value of the Distinguished Name of the certificate is made available in the
12603 &$tls_out_peerdn$& during subsequent processing.
12604 If certificate verification fails it may refer to a failing chain element
12605 which is not the leaf.
12606
12607 .vitem &$tls_in_sni$&
12608 .vindex "&$tls_in_sni$&"
12609 .vindex "&$tls_sni$&"
12610 .cindex "TLS" "Server Name Indication"
12611 When a TLS session is being established, if the client sends the Server
12612 Name Indication extension, the value will be placed in this variable.
12613 If the variable appears in &%tls_certificate%& then this option and
12614 some others, described in &<<SECTtlssni>>&,
12615 will be re-expanded early in the TLS session, to permit
12616 a different certificate to be presented (and optionally a different key to be
12617 used) to the client, based upon the value of the SNI extension.
12618
12619 The deprecated &$tls_sni$& variable refers to the inbound side
12620 except when used in the context of an outbound SMTP delivery, when it refers to
12621 the outbound.
12622
12623 .vitem &$tls_out_sni$&
12624 .vindex "&$tls_out_sni$&"
12625 .cindex "TLS" "Server Name Indication"
12626 During outbound
12627 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12628 the transport.
12629
12630 .vitem &$tod_bsdinbox$&
12631 .vindex "&$tod_bsdinbox$&"
12632 The time of day and the date, in the format required for BSD-style mailbox
12633 files, for example: Thu Oct 17 17:14:09 1995.
12634
12635 .vitem &$tod_epoch$&
12636 .vindex "&$tod_epoch$&"
12637 The time and date as a number of seconds since the start of the Unix epoch.
12638
12639 .vitem &$tod_epoch_l$&
12640 .vindex "&$tod_epoch_l$&"
12641 The time and date as a number of microseconds since the start of the Unix epoch.
12642
12643 .vitem &$tod_full$&
12644 .vindex "&$tod_full$&"
12645 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12646 +0100. The timezone is always given as a numerical offset from UTC, with
12647 positive values used for timezones that are ahead (east) of UTC, and negative
12648 values for those that are behind (west).
12649
12650 .vitem &$tod_log$&
12651 .vindex "&$tod_log$&"
12652 The time and date in the format used for writing Exim's log files, for example:
12653 1995-10-12 15:32:29, but without a timezone.
12654
12655 .vitem &$tod_logfile$&
12656 .vindex "&$tod_logfile$&"
12657 This variable contains the date in the format yyyymmdd. This is the format that
12658 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12659 flag.
12660
12661 .vitem &$tod_zone$&
12662 .vindex "&$tod_zone$&"
12663 This variable contains the numerical value of the local timezone, for example:
12664 -0500.
12665
12666 .vitem &$tod_zulu$&
12667 .vindex "&$tod_zulu$&"
12668 This variable contains the UTC date and time in &"Zulu"& format, as specified
12669 by ISO 8601, for example: 20030221154023Z.
12670
12671 .vitem &$transport_name$&
12672 .cindex "transport" "name"
12673 .cindex "name" "of transport"
12674 .vindex "&$transport_name$&"
12675 During the running of a transport, this variable contains its name.
12676
12677 .vitem &$value$&
12678 .vindex "&$value$&"
12679 This variable contains the result of an expansion lookup, extraction operation,
12680 or external command, as described above. It is also used during a
12681 &*reduce*& expansion.
12682
12683 .vitem &$verify_mode$&
12684 .vindex "&$verify_mode$&"
12685 While a router or transport is being run in verify mode
12686 or for cutthrough delivery,
12687 contains "S" for sender-verification or "R" for recipient-verification.
12688 Otherwise, empty.
12689
12690 .vitem &$version_number$&
12691 .vindex "&$version_number$&"
12692 The version number of Exim.
12693
12694 .vitem &$warn_message_delay$&
12695 .vindex "&$warn_message_delay$&"
12696 This variable is set only during the creation of a message warning about a
12697 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12698
12699 .vitem &$warn_message_recipients$&
12700 .vindex "&$warn_message_recipients$&"
12701 This variable is set only during the creation of a message warning about a
12702 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12703 .endlist
12704 .ecindex IIDstrexp
12705
12706
12707
12708 . ////////////////////////////////////////////////////////////////////////////
12709 . ////////////////////////////////////////////////////////////////////////////
12710
12711 .chapter "Embedded Perl" "CHAPperl"
12712 .scindex IIDperl "Perl" "calling from Exim"
12713 Exim can be built to include an embedded Perl interpreter. When this is done,
12714 Perl subroutines can be called as part of the string expansion process. To make
12715 use of the Perl support, you need version 5.004 or later of Perl installed on
12716 your system. To include the embedded interpreter in the Exim binary, include
12717 the line
12718 .code
12719 EXIM_PERL = perl.o
12720 .endd
12721 in your &_Local/Makefile_& and then build Exim in the normal way.
12722
12723
12724 .section "Setting up so Perl can be used" "SECID85"
12725 .oindex "&%perl_startup%&"
12726 Access to Perl subroutines is via a global configuration option called
12727 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12728 no &%perl_startup%& option in the Exim configuration file then no Perl
12729 interpreter is started and there is almost no overhead for Exim (since none of
12730 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12731 option then the associated value is taken to be Perl code which is executed in
12732 a newly created Perl interpreter.
12733
12734 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12735 need backslashes before any characters to escape special meanings. The option
12736 should usually be something like
12737 .code
12738 perl_startup = do '/etc/exim.pl'
12739 .endd
12740 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12741 use from Exim. Exim can be configured either to start up a Perl interpreter as
12742 soon as it is entered, or to wait until the first time it is needed. Starting
12743 the interpreter at the beginning ensures that it is done while Exim still has
12744 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12745 fact used in a particular run. Also, note that this does not mean that Exim is
12746 necessarily running as root when Perl is called at a later time. By default,
12747 the interpreter is started only when it is needed, but this can be changed in
12748 two ways:
12749
12750 .ilist
12751 .oindex "&%perl_at_start%&"
12752 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12753 a startup when Exim is entered.
12754 .next
12755 The command line option &%-ps%& also requests a startup when Exim is entered,
12756 overriding the setting of &%perl_at_start%&.
12757 .endlist
12758
12759 There is also a command line option &%-pd%& (for delay) which suppresses the
12760 initial startup, even if &%perl_at_start%& is set.
12761
12762
12763 .section "Calling Perl subroutines" "SECID86"
12764 When the configuration file includes a &%perl_startup%& option you can make use
12765 of the string expansion item to call the Perl subroutines that are defined
12766 by the &%perl_startup%& code. The operator is used in any of the following
12767 forms:
12768 .code
12769 ${perl{foo}}
12770 ${perl{foo}{argument}}
12771 ${perl{foo}{argument1}{argument2} ... }
12772 .endd
12773 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12774 arguments may be passed. Passing more than this results in an expansion failure
12775 with an error message of the form
12776 .code
12777 Too many arguments passed to Perl subroutine "foo" (max is 8)
12778 .endd
12779 The return value of the Perl subroutine is evaluated in a scalar context before
12780 it is passed back to Exim to be inserted into the expanded string. If the
12781 return value is &'undef'&, the expansion is forced to fail in the same way as
12782 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12783 by obeying Perl's &%die%& function, the expansion fails with the error message
12784 that was passed to &%die%&.
12785
12786
12787 .section "Calling Exim functions from Perl" "SECID87"
12788 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12789 is available to call back into Exim's string expansion function. For example,
12790 the Perl code
12791 .code
12792 my $lp = Exim::expand_string('$local_part');
12793 .endd
12794 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12795 Note those are single quotes and not double quotes to protect against
12796 &$local_part$& being interpolated as a Perl variable.
12797
12798 If the string expansion is forced to fail by a &"fail"& item, the result of
12799 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12800 expansion string, the Perl call from the original expansion string fails with
12801 an appropriate error message, in the same way as if &%die%& were used.
12802
12803 .cindex "debugging" "from embedded Perl"
12804 .cindex "log" "writing from embedded Perl"
12805 Two other Exim functions are available for use from within Perl code.
12806 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12807 debugging is enabled. If you want a newline at the end, you must supply it.
12808 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12809 timestamp. In this case, you should not supply a terminating newline.
12810
12811
12812 .section "Use of standard output and error by Perl" "SECID88"
12813 .cindex "Perl" "standard output and error"
12814 You should not write to the standard error or output streams from within your
12815 Perl code, as it is not defined how these are set up. In versions of Exim
12816 before 4.50, it is possible for the standard output or error to refer to the
12817 SMTP connection during message reception via the daemon. Writing to this stream
12818 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12819 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12820 avoided, but the output is lost.
12821
12822 .cindex "Perl" "use of &%warn%&"
12823 The Perl &%warn%& statement writes to the standard error stream by default.
12824 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12825 you have no control. When Exim starts up the Perl interpreter, it arranges for
12826 output from the &%warn%& statement to be written to the Exim main log. You can
12827 change this by including appropriate Perl magic somewhere in your Perl code.
12828 For example, to discard &%warn%& output completely, you need this:
12829 .code
12830 $SIG{__WARN__} = sub { };
12831 .endd
12832 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12833 example, the code for the subroutine is empty, so it does nothing, but you can
12834 include any Perl code that you like. The text of the &%warn%& message is passed
12835 as the first subroutine argument.
12836 .ecindex IIDperl
12837
12838
12839 . ////////////////////////////////////////////////////////////////////////////
12840 . ////////////////////////////////////////////////////////////////////////////
12841
12842 .chapter "Starting the daemon and the use of network interfaces" &&&
12843          "CHAPinterfaces" &&&
12844          "Starting the daemon"
12845 .cindex "daemon" "starting"
12846 .cindex "interface" "listening"
12847 .cindex "network interface"
12848 .cindex "interface" "network"
12849 .cindex "IP address" "for listening"
12850 .cindex "daemon" "listening IP addresses"
12851 .cindex "TCP/IP" "setting listening interfaces"
12852 .cindex "TCP/IP" "setting listening ports"
12853 A host that is connected to a TCP/IP network may have one or more physical
12854 hardware network interfaces. Each of these interfaces may be configured as one
12855 or more &"logical"& interfaces, which are the entities that a program actually
12856 works with. Each of these logical interfaces is associated with an IP address.
12857 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12858 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12859 knowledge about the host's interfaces for use in three different circumstances:
12860
12861 .olist
12862 When a listening daemon is started, Exim needs to know which interfaces
12863 and ports to listen on.
12864 .next
12865 When Exim is routing an address, it needs to know which IP addresses
12866 are associated with local interfaces. This is required for the correct
12867 processing of MX lists by removing the local host and others with the
12868 same or higher priority values. Also, Exim needs to detect cases
12869 when an address is routed to an IP address that in fact belongs to the
12870 local host. Unless the &%self%& router option or the &%allow_localhost%&
12871 option of the smtp transport is set (as appropriate), this is treated
12872 as an error situation.
12873 .next
12874 When Exim connects to a remote host, it may need to know which interface to use
12875 for the outgoing connection.
12876 .endlist
12877
12878
12879 Exim's default behaviour is likely to be appropriate in the vast majority
12880 of cases. If your host has only one interface, and you want all its IP
12881 addresses to be treated in the same way, and you are using only the
12882 standard SMTP port, you should not need to take any special action. The
12883 rest of this chapter does not apply to you.
12884
12885 In a more complicated situation you may want to listen only on certain
12886 interfaces, or on different ports, and for this reason there are a number of
12887 options that can be used to influence Exim's behaviour. The rest of this
12888 chapter describes how they operate.
12889
12890 When a message is received over TCP/IP, the interface and port that were
12891 actually used are set in &$received_ip_address$& and &$received_port$&.
12892
12893
12894
12895 .section "Starting a listening daemon" "SECID89"
12896 When a listening daemon is started (by means of the &%-bd%& command line
12897 option), the interfaces and ports on which it listens are controlled by the
12898 following options:
12899
12900 .ilist
12901 &%daemon_smtp_ports%& contains a list of default ports
12902 or service names.
12903 (For backward compatibility, this option can also be specified in the singular.)
12904 .next
12905 &%local_interfaces%& contains list of interface IP addresses on which to
12906 listen. Each item may optionally also specify a port.
12907 .endlist
12908
12909 The default list separator in both cases is a colon, but this can be changed as
12910 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12911 it is usually best to change the separator to avoid having to double all the
12912 colons. For example:
12913 .code
12914 local_interfaces = <; 127.0.0.1 ; \
12915                       192.168.23.65 ; \
12916                       ::1 ; \
12917                       3ffe:ffff:836f::fe86:a061
12918 .endd
12919 There are two different formats for specifying a port along with an IP address
12920 in &%local_interfaces%&:
12921
12922 .olist
12923 The port is added onto the address with a dot separator. For example, to listen
12924 on port 1234 on two different IP addresses:
12925 .code
12926 local_interfaces = <; 192.168.23.65.1234 ; \
12927                       3ffe:ffff:836f::fe86:a061.1234
12928 .endd
12929 .next
12930 The IP address is enclosed in square brackets, and the port is added
12931 with a colon separator, for example:
12932 .code
12933 local_interfaces = <; [192.168.23.65]:1234 ; \
12934                       [3ffe:ffff:836f::fe86:a061]:1234
12935 .endd
12936 .endlist
12937
12938 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12939 default setting contains just one port:
12940 .code
12941 daemon_smtp_ports = smtp
12942 .endd
12943 If more than one port is listed, each interface that does not have its own port
12944 specified listens on all of them. Ports that are listed in
12945 &%daemon_smtp_ports%& can be identified either by name (defined in
12946 &_/etc/services_&) or by number. However, when ports are given with individual
12947 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12948
12949
12950
12951 .section "Special IP listening addresses" "SECID90"
12952 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12953 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12954 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12955 instead of setting up separate listening sockets for each interface. The
12956 default value of &%local_interfaces%& is
12957 .code
12958 local_interfaces = 0.0.0.0
12959 .endd
12960 when Exim is built without IPv6 support; otherwise it is:
12961 .code
12962 local_interfaces = <; ::0 ; 0.0.0.0
12963 .endd
12964 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12965
12966
12967
12968 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12969 The &%-oX%& command line option can be used to override the values of
12970 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12971 instance. Another way of doing this would be to use macros and the &%-D%&
12972 option. However, &%-oX%& can be used by any admin user, whereas modification of
12973 the runtime configuration by &%-D%& is allowed only when the caller is root or
12974 exim.
12975
12976 The value of &%-oX%& is a list of items. The default colon separator can be
12977 changed in the usual way if required. If there are any items that do not
12978 contain dots or colons (that is, are not IP addresses), the value of
12979 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12980 items that do contain dots or colons, the value of &%local_interfaces%& is
12981 replaced by those items. Thus, for example,
12982 .code
12983 -oX 1225
12984 .endd
12985 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12986 whereas
12987 .code
12988 -oX 192.168.34.5.1125
12989 .endd
12990 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12991 (However, since &%local_interfaces%& now contains no items without ports, the
12992 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12993
12994
12995
12996 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12997 .cindex "ssmtp protocol"
12998 .cindex "smtps protocol"
12999 .cindex "SMTP" "ssmtp protocol"
13000 .cindex "SMTP" "smtps protocol"
13001 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13002 before the STARTTLS command was standardized for SMTP. Some legacy clients
13003 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13004 list of port numbers or service names,
13005 connections to those ports must use SSMTP. The most
13006 common use of this option is expected to be
13007 .code
13008 tls_on_connect_ports = 465
13009 .endd
13010 because 465 is the usual port number used by the legacy clients. There is also
13011 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13012 this way when a daemon is started.
13013
13014 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13015 daemon to listen on those ports. You must still specify them in
13016 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13017 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13018 connections via the daemon.)
13019
13020
13021
13022
13023 .section "IPv6 address scopes" "SECID92"
13024 .cindex "IPv6" "address scopes"
13025 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13026 can, in principle, have the same link-local IPv6 address on different
13027 interfaces. Thus, additional information is needed, over and above the IP
13028 address, to distinguish individual interfaces. A convention of using a
13029 percent sign followed by something (often the interface name) has been
13030 adopted in some cases, leading to addresses like this:
13031 .code
13032 fe80::202:b3ff:fe03:45c1%eth0
13033 .endd
13034 To accommodate this usage, a percent sign followed by an arbitrary string is
13035 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13036 to convert a textual IPv6 address for actual use. This function recognizes the
13037 percent convention in operating systems that support it, and it processes the
13038 address appropriately. Unfortunately, some older libraries have problems with
13039 &[getaddrinfo()]&. If
13040 .code
13041 IPV6_USE_INET_PTON=yes
13042 .endd
13043 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13044 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13045 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13046 function.) Of course, this means that the additional functionality of
13047 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13048
13049 .section "Disabling IPv6" "SECID93"
13050 .cindex "IPv6" "disabling"
13051 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13052 run on a host whose kernel does not support IPv6. The binary will fall back to
13053 using IPv4, but it may waste resources looking up AAAA records, and trying to
13054 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13055 .oindex "&%disable_ipv6%&"
13056 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13057 activities take place. AAAA records are never looked up, and any IPv6 addresses
13058 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13059 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13060 to handle IPv6 literal addresses.
13061
13062 On the other hand, when IPv6 is in use, there may be times when you want to
13063 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13064 option to globally suppress the lookup of AAAA records for specified domains,
13065 and you can use the &%ignore_target_hosts%& generic router option to ignore
13066 IPv6 addresses in an individual router.
13067
13068
13069
13070 .section "Examples of starting a listening daemon" "SECID94"
13071 The default case in an IPv6 environment is
13072 .code
13073 daemon_smtp_ports = smtp
13074 local_interfaces = <; ::0 ; 0.0.0.0
13075 .endd
13076 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13077 Either one or two sockets may be used, depending on the characteristics of
13078 the TCP/IP stack. (This is complicated and messy; for more information,
13079 read the comments in the &_daemon.c_& source file.)
13080
13081 To specify listening on ports 25 and 26 on all interfaces:
13082 .code
13083 daemon_smtp_ports = 25 : 26
13084 .endd
13085 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13086 .code
13087 local_interfaces = <; ::0.25     ; ::0.26 \
13088                       0.0.0.0.25 ; 0.0.0.0.26
13089 .endd
13090 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13091 IPv4 loopback address only:
13092 .code
13093 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13094 .endd
13095 To specify listening on the default port on specific interfaces only:
13096 .code
13097 local_interfaces = 10.0.0.67 : 192.168.34.67
13098 .endd
13099 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13100
13101
13102
13103 .section "Recognizing the local host" "SECTreclocipadd"
13104 The &%local_interfaces%& option is also used when Exim needs to determine
13105 whether or not an IP address refers to the local host. That is, the IP
13106 addresses of all the interfaces on which a daemon is listening are always
13107 treated as local.
13108
13109 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13110 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13111 available interfaces from the operating system, and extracts the relevant
13112 (that is, IPv4 or IPv6) addresses to use for checking.
13113
13114 Some systems set up large numbers of virtual interfaces in order to provide
13115 many virtual web servers. In this situation, you may want to listen for
13116 email on only a few of the available interfaces, but nevertheless treat all
13117 interfaces as local when routing. You can do this by setting
13118 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13119 &"all"& wildcard values. These addresses are recognized as local, but are not
13120 used for listening. Consider this example:
13121 .code
13122 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13123                       192.168.53.235 ; \
13124                       3ffe:2101:12:1:a00:20ff:fe86:a061
13125
13126 extra_local_interfaces = <; ::0 ; 0.0.0.0
13127 .endd
13128 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13129 address, but all available interface addresses are treated as local when
13130 Exim is routing.
13131
13132 In some environments the local host name may be in an MX list, but with an IP
13133 address that is not assigned to any local interface. In other cases it may be
13134 desirable to treat other host names as if they referred to the local host. Both
13135 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13136 This contains host names rather than IP addresses. When a host is referenced
13137 during routing, either via an MX record or directly, it is treated as the local
13138 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13139 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13140
13141
13142
13143 .section "Delivering to a remote host" "SECID95"
13144 Delivery to a remote host is handled by the smtp transport. By default, it
13145 allows the system's TCP/IP functions to choose which interface to use (if
13146 there is more than one) when connecting to a remote host. However, the
13147 &%interface%& option can be set to specify which interface is used. See the
13148 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13149 details.
13150
13151
13152
13153
13154 . ////////////////////////////////////////////////////////////////////////////
13155 . ////////////////////////////////////////////////////////////////////////////
13156
13157 .chapter "Main configuration" "CHAPmainconfig"
13158 .scindex IIDconfima "configuration file" "main section"
13159 .scindex IIDmaiconf "main configuration"
13160 The first part of the run time configuration file contains three types of item:
13161
13162 .ilist
13163 Macro definitions: These lines start with an upper case letter. See section
13164 &<<SECTmacrodefs>>& for details of macro processing.
13165 .next
13166 Named list definitions: These lines start with one of the words &"domainlist"&,
13167 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13168 section &<<SECTnamedlists>>&.
13169 .next
13170 Main configuration settings: Each setting occupies one line of the file
13171 (with possible continuations). If any setting is preceded by the word
13172 &"hide"&, the &%-bP%& command line option displays its value to admin users
13173 only. See section &<<SECTcos>>& for a description of the syntax of these option
13174 settings.
13175 .endlist
13176
13177 This chapter specifies all the main configuration options, along with their
13178 types and default values. For ease of finding a particular option, they appear
13179 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13180 are now so many options, they are first listed briefly in functional groups, as
13181 an aid to finding the name of the option you are looking for. Some options are
13182 listed in more than one group.
13183
13184 .section "Miscellaneous" "SECID96"
13185 .table2
13186 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13187 .row &%disable_ipv6%&                "do no IPv6 processing"
13188 .row &%keep_malformed%&              "for broken files &-- should not happen"
13189 .row &%localhost_number%&            "for unique message ids in clusters"
13190 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13191 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13192 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13193 .row &%print_topbitchars%&           "top-bit characters are printing"
13194 .row &%timezone%&                    "force time zone"
13195 .endtable
13196
13197
13198 .section "Exim parameters" "SECID97"
13199 .table2
13200 .row &%exim_group%&                  "override compiled-in value"
13201 .row &%exim_path%&                   "override compiled-in value"
13202 .row &%exim_user%&                   "override compiled-in value"
13203 .row &%primary_hostname%&            "default from &[uname()]&"
13204 .row &%split_spool_directory%&       "use multiple directories"
13205 .row &%spool_directory%&             "override compiled-in value"
13206 .endtable
13207
13208
13209
13210 .section "Privilege controls" "SECID98"
13211 .table2
13212 .row &%admin_groups%&                "groups that are Exim admin users"
13213 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13214 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13215 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13216 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13217 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13218 .row &%never_users%&                 "do not run deliveries as these"
13219 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13220 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13221 .row &%trusted_groups%&              "groups that are trusted"
13222 .row &%trusted_users%&               "users that are trusted"
13223 .endtable
13224
13225
13226
13227 .section "Logging" "SECID99"
13228 .table2
13229 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13230 .row &%log_file_path%&               "override compiled-in value"
13231 .row &%log_selector%&                "set/unset optional logging"
13232 .row &%log_timezone%&                "add timezone to log lines"
13233 .row &%message_logs%&                "create per-message logs"
13234 .row &%preserve_message_logs%&       "after message completion"
13235 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13236 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13237 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13238 .row &%syslog_facility%&             "set syslog &""facility""& field"
13239 .row &%syslog_processname%&          "set syslog &""ident""& field"
13240 .row &%syslog_timestamp%&            "timestamp syslog lines"
13241 .row &%write_rejectlog%&             "control use of message log"
13242 .endtable
13243
13244
13245
13246 .section "Frozen messages" "SECID100"
13247 .table2
13248 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13249 .row &%freeze_tell%&                 "send message when freezing"
13250 .row &%move_frozen_messages%&        "to another directory"
13251 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13252 .endtable
13253
13254
13255
13256 .section "Data lookups" "SECID101"
13257 .table2
13258 .row &%ibase_servers%&               "InterBase servers"
13259 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13260 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13261 .row &%ldap_cert_file%&              "client cert file for LDAP"
13262 .row &%ldap_cert_key%&               "client key file for LDAP"
13263 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13264 .row &%ldap_default_servers%&        "used if no server in query"
13265 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13266 .row &%ldap_start_tls%&              "require TLS within LDAP"
13267 .row &%ldap_version%&                "set protocol version"
13268 .row &%lookup_open_max%&             "lookup files held open"
13269 .row &%mysql_servers%&               "default MySQL servers"
13270 .row &%oracle_servers%&              "Oracle servers"
13271 .row &%pgsql_servers%&               "default PostgreSQL servers"
13272 .row &%sqlite_lock_timeout%&         "as it says"
13273 .endtable
13274
13275
13276
13277 .section "Message ids" "SECID102"
13278 .table2
13279 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13280 .row &%message_id_header_text%&      "ditto"
13281 .endtable
13282
13283
13284
13285 .section "Embedded Perl Startup" "SECID103"
13286 .table2
13287 .row &%perl_at_start%&               "always start the interpreter"
13288 .row &%perl_startup%&                "code to obey when starting Perl"
13289 .endtable
13290
13291
13292
13293 .section "Daemon" "SECID104"
13294 .table2
13295 .row &%daemon_smtp_ports%&           "default ports"
13296 .row &%daemon_startup_retries%&      "number of times to retry"
13297 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13298 .row &%extra_local_interfaces%&      "not necessarily listened on"
13299 .row &%local_interfaces%&            "on which to listen, with optional ports"
13300 .row &%pid_file_path%&               "override compiled-in value"
13301 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13302 .endtable
13303
13304
13305
13306 .section "Resource control" "SECID105"
13307 .table2
13308 .row &%check_log_inodes%&            "before accepting a message"
13309 .row &%check_log_space%&             "before accepting a message"
13310 .row &%check_spool_inodes%&          "before accepting a message"
13311 .row &%check_spool_space%&           "before accepting a message"
13312 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13313 .row &%queue_only_load%&             "queue incoming if load high"
13314 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13315 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13316 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13317 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13318 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13319 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13320 .row &%smtp_accept_max_per_connection%& "messages per connection"
13321 .row &%smtp_accept_max_per_host%&    "connections from one host"
13322 .row &%smtp_accept_queue%&           "queue mail if more connections"
13323 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13324                                            connection"
13325 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13326 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13327 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13328 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13329 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13330 .endtable
13331
13332
13333
13334 .section "Policy controls" "SECID106"
13335 .table2
13336 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13337 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13338 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13339 .row &%acl_smtp_auth%&               "ACL for AUTH"
13340 .row &%acl_smtp_connect%&            "ACL for connection"
13341 .row &%acl_smtp_data%&               "ACL for DATA"
13342 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13343 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13344 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13345 .row &%acl_smtp_expn%&               "ACL for EXPN"
13346 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13347 .row &%acl_smtp_mail%&               "ACL for MAIL"
13348 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13349 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13350 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13351 .row &%acl_smtp_predata%&            "ACL for start of data"
13352 .row &%acl_smtp_quit%&               "ACL for QUIT"
13353 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13354 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13355 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13356 .row &%av_scanner%&                  "specify virus scanner"
13357 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13358                                       words""&"
13359 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13360 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13361 .row &%header_maxsize%&              "total size of message header"
13362 .row &%header_line_maxsize%&         "individual header line limit"
13363 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13364 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13365 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13366 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13367 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13368 .row &%host_lookup%&                 "host name looked up for these hosts"
13369 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13370 .row &%host_reject_connection%&      "reject connection from these hosts"
13371 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13372 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13373 .row &%message_size_limit%&          "for all messages"
13374 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13375 .row &%spamd_address%&               "set interface to SpamAssassin"
13376 .row &%strict_acl_vars%&             "object to unset ACL variables"
13377 .endtable
13378
13379
13380
13381 .section "Callout cache" "SECID107"
13382 .table2
13383 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13384                                          item"
13385 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13386                                          item"
13387 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13388 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13389 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13390 .endtable
13391
13392
13393
13394 .section "TLS" "SECID108"
13395 .table2
13396 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13397 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13398 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13399 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13400 .row &%tls_certificate%&             "location of server certificate"
13401 .row &%tls_crl%&                     "certificate revocation list"
13402 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13403 .row &%tls_dhparam%&                 "DH parameters for server"
13404 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13405 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13406 .row &%tls_privatekey%&              "location of server private key"
13407 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13408 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13409 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13410 .row &%tls_verify_certificates%&     "expected client certificates"
13411 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13412 .endtable
13413
13414
13415
13416 .section "Local user handling" "SECID109"
13417 .table2
13418 .row &%finduser_retries%&            "useful in NIS environments"
13419 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13420 .row &%gecos_pattern%&               "ditto"
13421 .row &%max_username_length%&         "for systems that truncate"
13422 .row &%unknown_login%&               "used when no login name found"
13423 .row &%unknown_username%&            "ditto"
13424 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13425 .row &%uucp_from_sender%&            "ditto"
13426 .endtable
13427
13428
13429
13430 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13431 .table2
13432 .row &%header_maxsize%&              "total size of message header"
13433 .row &%header_line_maxsize%&         "individual header line limit"
13434 .row &%message_size_limit%&          "applies to all messages"
13435 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13436 .row &%received_header_text%&        "expanded to make &'Received:'&"
13437 .row &%received_headers_max%&        "for mail loop detection"
13438 .row &%recipients_max%&              "limit per message"
13439 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13440 .endtable
13441
13442
13443
13444
13445 .section "Non-SMTP incoming messages" "SECID111"
13446 .table2
13447 .row &%receive_timeout%&             "for non-SMTP messages"
13448 .endtable
13449
13450
13451
13452
13453
13454 .section "Incoming SMTP messages" "SECID112"
13455 See also the &'Policy controls'& section above.
13456
13457 .table2
13458 .row &%host_lookup%&                 "host name looked up for these hosts"
13459 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13460 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13461 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13462 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13463 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13464 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13465 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13466 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13467 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13468 .row &%smtp_accept_max_per_connection%& "messages per connection"
13469 .row &%smtp_accept_max_per_host%&    "connections from one host"
13470 .row &%smtp_accept_queue%&           "queue mail if more connections"
13471 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13472                                            connection"
13473 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13474 .row &%smtp_active_hostname%&        "host name to use in messages"
13475 .row &%smtp_banner%&                 "text for welcome banner"
13476 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13477 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13478 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13479 .row &%smtp_etrn_command%&           "what to run for ETRN"
13480 .row &%smtp_etrn_serialize%&         "only one at once"
13481 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13482 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13483 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13484 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13485 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13486 .row &%smtp_receive_timeout%&        "per command or data line"
13487 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13488 .row &%smtp_return_error_details%&   "give detail on rejections"
13489 .endtable
13490
13491
13492
13493 .section "SMTP extensions" "SECID113"
13494 .table2
13495 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13496 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13497 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13498 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13499 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13500 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13501 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13502 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13503 .endtable
13504
13505
13506
13507 .section "Processing messages" "SECID114"
13508 .table2
13509 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13510 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13511 .row &%allow_utf8_domains%&          "in addresses"
13512 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13513                                       words""&"
13514 .row &%delivery_date_remove%&        "from incoming messages"
13515 .row &%envelope_to_remove%&          "from incoming messages"
13516 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13517 .row &%headers_charset%&             "default for translations"
13518 .row &%qualify_domain%&              "default for senders"
13519 .row &%qualify_recipient%&           "default for recipients"
13520 .row &%return_path_remove%&          "from incoming messages"
13521 .row &%strip_excess_angle_brackets%& "in addresses"
13522 .row &%strip_trailing_dot%&          "at end of addresses"
13523 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13524 .endtable
13525
13526
13527
13528 .section "System filter" "SECID115"
13529 .table2
13530 .row &%system_filter%&               "locate system filter"
13531 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13532                                             directory"
13533 .row &%system_filter_file_transport%& "transport for delivery to a file"
13534 .row &%system_filter_group%&         "group for filter running"
13535 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13536 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13537 .row &%system_filter_user%&          "user for filter running"
13538 .endtable
13539
13540
13541
13542 .section "Routing and delivery" "SECID116"
13543 .table2
13544 .row &%disable_ipv6%&                "do no IPv6 processing"
13545 .row &%dns_again_means_nonexist%&    "for broken domains"
13546 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13547 .row &%dns_dnssec_ok%&               "parameter for resolver"
13548 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13549 .row &%dns_retrans%&                 "parameter for resolver"
13550 .row &%dns_retry%&                   "parameter for resolver"
13551 .row &%dns_use_edns0%&               "parameter for resolver"
13552 .row &%hold_domains%&                "hold delivery for these domains"
13553 .row &%local_interfaces%&            "for routing checks"
13554 .row &%queue_domains%&               "no immediate delivery for these"
13555 .row &%queue_only%&                  "no immediate delivery at all"
13556 .row &%queue_only_file%&             "no immediate delivery if file exists"
13557 .row &%queue_only_load%&             "no immediate delivery if load is high"
13558 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13559 .row &%queue_only_override%&         "allow command line to override"
13560 .row &%queue_run_in_order%&          "order of arrival"
13561 .row &%queue_run_max%&               "of simultaneous queue runners"
13562 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13563 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13564 .row &%remote_sort_domains%&         "order of remote deliveries"
13565 .row &%retry_data_expire%&           "timeout for retry data"
13566 .row &%retry_interval_max%&          "safety net for retry rules"
13567 .endtable
13568
13569
13570
13571 .section "Bounce and warning messages" "SECID117"
13572 .table2
13573 .row &%bounce_message_file%&         "content of bounce"
13574 .row &%bounce_message_text%&         "content of bounce"
13575 .row &%bounce_return_body%&          "include body if returning message"
13576 .row &%bounce_return_message%&       "include original message in bounce"
13577 .row &%bounce_return_size_limit%&    "limit on returned message"
13578 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13579 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13580 .row &%errors_copy%&                 "copy bounce messages"
13581 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13582 .row &%delay_warning%&               "time schedule"
13583 .row &%delay_warning_condition%&     "condition for warning messages"
13584 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13585 .row &%smtp_return_error_details%&   "give detail on rejections"
13586 .row &%warn_message_file%&           "content of warning message"
13587 .endtable
13588
13589
13590
13591 .section "Alphabetical list of main options" "SECTalomo"
13592 Those options that undergo string expansion before use are marked with
13593 &dagger;.
13594
13595 .option accept_8bitmime main boolean true
13596 .cindex "8BITMIME"
13597 .cindex "8-bit characters"
13598 .cindex "log" "selectors"
13599 .cindex "log" "8BITMIME"
13600 This option causes Exim to send 8BITMIME in its response to an SMTP
13601 EHLO command, and to accept the BODY= parameter on MAIL commands.
13602 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13603 takes no steps to do anything special with messages received by this route.
13604
13605 Historically Exim kept this option off by default, but the maintainers
13606 feel that in today's Internet, this causes more problems than it solves.
13607 It now defaults to true.
13608 A more detailed analysis of the issues is provided by Dan Bernstein:
13609 .display
13610 &url(http://cr.yp.to/smtp/8bitmime.html)
13611 .endd
13612
13613 To log received 8BITMIME status use
13614 .code
13615 log_selector = +8bitmime
13616 .endd
13617
13618 .option acl_not_smtp main string&!! unset
13619 .cindex "&ACL;" "for non-SMTP messages"
13620 .cindex "non-SMTP messages" "ACLs for"
13621 This option defines the ACL that is run when a non-SMTP message has been
13622 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13623 further details.
13624
13625 .option acl_not_smtp_mime main string&!! unset
13626 This option defines the ACL that is run for individual MIME parts of non-SMTP
13627 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13628 SMTP messages.
13629
13630 .option acl_not_smtp_start main string&!! unset
13631 .cindex "&ACL;" "at start of non-SMTP message"
13632 .cindex "non-SMTP messages" "ACLs for"
13633 This option defines the ACL that is run before Exim starts reading a
13634 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13635
13636 .option acl_smtp_auth main string&!! unset
13637 .cindex "&ACL;" "setting up for SMTP commands"
13638 .cindex "AUTH" "ACL for"
13639 This option defines the ACL that is run when an SMTP AUTH command is
13640 received. See chapter &<<CHAPACL>>& for further details.
13641
13642 .option acl_smtp_connect main string&!! unset
13643 .cindex "&ACL;" "on SMTP connection"
13644 This option defines the ACL that is run when an SMTP connection is received.
13645 See chapter &<<CHAPACL>>& for further details.
13646
13647 .option acl_smtp_data main string&!! unset
13648 .cindex "DATA" "ACL for"
13649 This option defines the ACL that is run after an SMTP DATA command has been
13650 processed and the message itself has been received, but before the final
13651 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13652
13653 .new
13654 .option acl_smtp_data_prdr main string&!! accept
13655 .cindex "PRDR" "ACL for"
13656 .cindex "DATA" "PRDR ACL for"
13657 .cindex "&ACL;" "PRDR-related"
13658 .cindex "&ACL;" "per-user data processing"
13659 .wen
13660 This option defines the ACL that,
13661 if the PRDR feature has been negotiated,
13662 is run for each recipient after an SMTP DATA command has been
13663 processed and the message itself has been received, but before the
13664 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13665
13666 .option acl_smtp_etrn main string&!! unset
13667 .cindex "ETRN" "ACL for"
13668 This option defines the ACL that is run when an SMTP ETRN command is
13669 received. See chapter &<<CHAPACL>>& for further details.
13670
13671 .option acl_smtp_expn main string&!! unset
13672 .cindex "EXPN" "ACL for"
13673 This option defines the ACL that is run when an SMTP EXPN command is
13674 received. See chapter &<<CHAPACL>>& for further details.
13675
13676 .option acl_smtp_helo main string&!! unset
13677 .cindex "EHLO" "ACL for"
13678 .cindex "HELO" "ACL for"
13679 This option defines the ACL that is run when an SMTP EHLO or HELO
13680 command is received. See chapter &<<CHAPACL>>& for further details.
13681
13682
13683 .option acl_smtp_mail main string&!! unset
13684 .cindex "MAIL" "ACL for"
13685 This option defines the ACL that is run when an SMTP MAIL command is
13686 received. See chapter &<<CHAPACL>>& for further details.
13687
13688 .option acl_smtp_mailauth main string&!! unset
13689 .cindex "AUTH" "on MAIL command"
13690 This option defines the ACL that is run when there is an AUTH parameter on
13691 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13692 &<<CHAPSMTPAUTH>>& for details of authentication.
13693
13694 .option acl_smtp_mime main string&!! unset
13695 .cindex "MIME content scanning" "ACL for"
13696 This option is available when Exim is built with the content-scanning
13697 extension. It defines the ACL that is run for each MIME part in a message. See
13698 section &<<SECTscanmimepart>>& for details.
13699
13700 .option acl_smtp_notquit main string&!! unset
13701 .cindex "not-QUIT, ACL for"
13702 This option defines the ACL that is run when an SMTP session
13703 ends without a QUIT command being received.
13704 See chapter &<<CHAPACL>>& for further details.
13705
13706 .option acl_smtp_predata main string&!! unset
13707 This option defines the ACL that is run when an SMTP DATA command is
13708 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13709 further details.
13710
13711 .option acl_smtp_quit main string&!! unset
13712 .cindex "QUIT, ACL for"
13713 This option defines the ACL that is run when an SMTP QUIT command is
13714 received. See chapter &<<CHAPACL>>& for further details.
13715
13716 .option acl_smtp_rcpt main string&!! unset
13717 .cindex "RCPT" "ACL for"
13718 This option defines the ACL that is run when an SMTP RCPT command is
13719 received. See chapter &<<CHAPACL>>& for further details.
13720
13721 .option acl_smtp_starttls main string&!! unset
13722 .cindex "STARTTLS, ACL for"
13723 This option defines the ACL that is run when an SMTP STARTTLS command is
13724 received. See chapter &<<CHAPACL>>& for further details.
13725
13726 .option acl_smtp_vrfy main string&!! unset
13727 .cindex "VRFY" "ACL for"
13728 This option defines the ACL that is run when an SMTP VRFY command is
13729 received. See chapter &<<CHAPACL>>& for further details.
13730
13731 .option admin_groups main "string list&!!" unset
13732 .cindex "admin user"
13733 This option is expanded just once, at the start of Exim's processing. If the
13734 current group or any of the supplementary groups of an Exim caller is in this
13735 colon-separated list, the caller has admin privileges. If all your system
13736 programmers are in a specific group, for example, you can give them all Exim
13737 admin privileges by putting that group in &%admin_groups%&. However, this does
13738 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13739 To permit this, you have to add individuals to the Exim group.
13740
13741 .option allow_domain_literals main boolean false
13742 .cindex "domain literal"
13743 If this option is set, the RFC 2822 domain literal format is permitted in
13744 email addresses. The option is not set by default, because the domain literal
13745 format is not normally required these days, and few people know about it. It
13746 has, however, been exploited by mail abusers.
13747
13748 Unfortunately, it seems that some DNS black list maintainers are using this
13749 format to report black listing to postmasters. If you want to accept messages
13750 addressed to your hosts by IP address, you need to set
13751 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13752 domains (defined in the named domain list &%local_domains%& in the default
13753 configuration). This &"magic string"& matches the domain literal form of all
13754 the local host's IP addresses.
13755
13756
13757 .option allow_mx_to_ip main boolean false
13758 .cindex "MX record" "pointing to IP address"
13759 It appears that more and more DNS zone administrators are breaking the rules
13760 and putting domain names that look like IP addresses on the right hand side of
13761 MX records. Exim follows the rules and rejects this, giving an error message
13762 that explains the mis-configuration. However, some other MTAs support this
13763 practice, so to avoid &"Why can't Exim do this?"& complaints,
13764 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13765 recommended, except when you have no other choice.
13766
13767 .option allow_utf8_domains main boolean false
13768 .cindex "domain" "UTF-8 characters in"
13769 .cindex "UTF-8" "in domain name"
13770 Lots of discussion is going on about internationalized domain names. One
13771 camp is strongly in favour of just using UTF-8 characters, and it seems
13772 that at least two other MTAs permit this. This option allows Exim users to
13773 experiment if they wish.
13774
13775 If it is set true, Exim's domain parsing function allows valid
13776 UTF-8 multicharacters to appear in domain name components, in addition to
13777 letters, digits, and hyphens. However, just setting this option is not
13778 enough; if you want to look up these domain names in the DNS, you must also
13779 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13780 suitable setting is:
13781 .code
13782 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13783   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13784 .endd
13785 Alternatively, you can just disable this feature by setting
13786 .code
13787 dns_check_names_pattern =
13788 .endd
13789 That is, set the option to an empty string so that no check is done.
13790
13791
13792 .option auth_advertise_hosts main "host list&!!" *
13793 .cindex "authentication" "advertising"
13794 .cindex "AUTH" "advertising"
13795 If any server authentication mechanisms are configured, Exim advertises them in
13796 response to an EHLO command only if the calling host matches this list.
13797 Otherwise, Exim does not advertise AUTH.
13798 Exim does not accept AUTH commands from clients to which it has not
13799 advertised the availability of AUTH. The advertising of individual
13800 authentication mechanisms can be controlled by the use of the
13801 &%server_advertise_condition%& generic authenticator option on the individual
13802 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13803
13804 Certain mail clients (for example, Netscape) require the user to provide a name
13805 and password for authentication if AUTH is advertised, even though it may
13806 not be needed (the host may accept messages from hosts on its local LAN without
13807 authentication, for example). The &%auth_advertise_hosts%& option can be used
13808 to make these clients more friendly by excluding them from the set of hosts to
13809 which Exim advertises AUTH.
13810
13811 .cindex "AUTH" "advertising when encrypted"
13812 If you want to advertise the availability of AUTH only when the connection
13813 is encrypted using TLS, you can make use of the fact that the value of this
13814 option is expanded, with a setting like this:
13815 .code
13816 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13817 .endd
13818 .vindex "&$tls_in_cipher$&"
13819 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13820 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13821 expansion is *, which matches all hosts.
13822
13823
13824 .option auto_thaw main time 0s
13825 .cindex "thawing messages"
13826 .cindex "unfreezing messages"
13827 If this option is set to a time greater than zero, a queue runner will try a
13828 new delivery attempt on any frozen message, other than a bounce message, if
13829 this much time has passed since it was frozen. This may result in the message
13830 being re-frozen if nothing has changed since the last attempt. It is a way of
13831 saying &"keep on trying, even though there are big problems"&.
13832
13833 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13834 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13835 thought to be very useful any more, and its use should probably be avoided.
13836
13837
13838 .option av_scanner main string "see below"
13839 This option is available if Exim is built with the content-scanning extension.
13840 It specifies which anti-virus scanner to use. The default value is:
13841 .code
13842 sophie:/var/run/sophie
13843 .endd
13844 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13845 before use. See section &<<SECTscanvirus>>& for further details.
13846
13847
13848 .option bi_command main string unset
13849 .oindex "&%-bi%&"
13850 This option supplies the name of a command that is run when Exim is called with
13851 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13852 just the command name, it is not a complete command line. If an argument is
13853 required, it must come from the &%-oA%& command line option.
13854
13855
13856 .option bounce_message_file main string unset
13857 .cindex "bounce message" "customizing"
13858 .cindex "customizing" "bounce message"
13859 This option defines a template file containing paragraphs of text to be used
13860 for constructing bounce messages.  Details of the file's contents are given in
13861 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13862
13863
13864 .option bounce_message_text main string unset
13865 When this option is set, its contents are included in the default bounce
13866 message immediately after &"This message was created automatically by mail
13867 delivery software."& It is not used if &%bounce_message_file%& is set.
13868
13869 .option bounce_return_body main boolean true
13870 .cindex "bounce message" "including body"
13871 This option controls whether the body of an incoming message is included in a
13872 bounce message when &%bounce_return_message%& is true. The default setting
13873 causes the entire message, both header and body, to be returned (subject to the
13874 value of &%bounce_return_size_limit%&). If this option is false, only the
13875 message header is included. In the case of a non-SMTP message containing an
13876 error that is detected during reception, only those header lines preceding the
13877 point at which the error was detected are returned.
13878 .cindex "bounce message" "including original"
13879
13880 .option bounce_return_message main boolean true
13881 If this option is set false, none of the original message is included in
13882 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13883 &%bounce_return_body%&.
13884
13885
13886 .option bounce_return_size_limit main integer 100K
13887 .cindex "size" "of bounce, limit"
13888 .cindex "bounce message" "size limit"
13889 .cindex "limit" "bounce message size"
13890 This option sets a limit in bytes on the size of messages that are returned to
13891 senders as part of bounce messages when &%bounce_return_message%& is true. The
13892 limit should be less than the value of the global &%message_size_limit%& and of
13893 any &%message_size_limit%& settings on transports, to allow for the bounce text
13894 that Exim generates. If this option is set to zero there is no limit.
13895
13896 When the body of any message that is to be included in a bounce message is
13897 greater than the limit, it is truncated, and a comment pointing this out is
13898 added at the top. The actual cutoff may be greater than the value given, owing
13899 to the use of buffering for transferring the message in chunks (typically 8K in
13900 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13901 messages.
13902
13903 .option bounce_sender_authentication main string unset
13904 .cindex "bounce message" "sender authentication"
13905 .cindex "authentication" "bounce message"
13906 .cindex "AUTH" "on bounce message"
13907 This option provides an authenticated sender address that is sent with any
13908 bounce messages generated by Exim that are sent over an authenticated SMTP
13909 connection. A typical setting might be:
13910 .code
13911 bounce_sender_authentication = mailer-daemon@my.domain.example
13912 .endd
13913 which would cause bounce messages to be sent using the SMTP command:
13914 .code
13915 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13916 .endd
13917 The value of &%bounce_sender_authentication%& must always be a complete email
13918 address.
13919
13920 .option callout_domain_negative_expire main time 3h
13921 .cindex "caching" "callout timeouts"
13922 .cindex "callout" "caching timeouts"
13923 This option specifies the expiry time for negative callout cache data for a
13924 domain. See section &<<SECTcallver>>& for details of callout verification, and
13925 section &<<SECTcallvercache>>& for details of the caching.
13926
13927
13928 .option callout_domain_positive_expire main time 7d
13929 This option specifies the expiry time for positive callout cache data for a
13930 domain. See section &<<SECTcallver>>& for details of callout verification, and
13931 section &<<SECTcallvercache>>& for details of the caching.
13932
13933
13934 .option callout_negative_expire main time 2h
13935 This option specifies the expiry time for negative callout cache data for an
13936 address. See section &<<SECTcallver>>& for details of callout verification, and
13937 section &<<SECTcallvercache>>& for details of the caching.
13938
13939
13940 .option callout_positive_expire main time 24h
13941 This option specifies the expiry time for positive callout cache data for an
13942 address. See section &<<SECTcallver>>& for details of callout verification, and
13943 section &<<SECTcallvercache>>& for details of the caching.
13944
13945
13946 .option callout_random_local_part main string&!! "see below"
13947 This option defines the &"random"& local part that can be used as part of
13948 callout verification. The default value is
13949 .code
13950 $primary_hostname-$tod_epoch-testing
13951 .endd
13952 See section &<<CALLaddparcall>>& for details of how this value is used.
13953
13954
13955 .option check_log_inodes main integer 0
13956 See &%check_spool_space%& below.
13957
13958
13959 .option check_log_space main integer 0
13960 See &%check_spool_space%& below.
13961
13962 .oindex "&%check_rfc2047_length%&"
13963 .cindex "RFC 2047" "disabling length check"
13964 .option check_rfc2047_length main boolean true
13965 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13966 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13967 word; strings to be encoded that exceed this length are supposed to use
13968 multiple encoded words. By default, Exim does not recognize encoded words that
13969 exceed the maximum length. However, it seems that some software, in violation
13970 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13971 set false, Exim recognizes encoded words of any length.
13972
13973
13974 .option check_spool_inodes main integer 0
13975 See &%check_spool_space%& below.
13976
13977
13978 .option check_spool_space main integer 0
13979 .cindex "checking disk space"
13980 .cindex "disk space, checking"
13981 .cindex "spool directory" "checking space"
13982 The four &%check_...%& options allow for checking of disk resources before a
13983 message is accepted.
13984
13985 .vindex "&$log_inodes$&"
13986 .vindex "&$log_space$&"
13987 .vindex "&$spool_inodes$&"
13988 .vindex "&$spool_space$&"
13989 When any of these options are set, they apply to all incoming messages. If you
13990 want to apply different checks to different kinds of message, you can do so by
13991 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13992 &$spool_space$& in an ACL with appropriate additional conditions.
13993
13994
13995 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13996 either value is greater than zero, for example:
13997 .code
13998 check_spool_space = 10M
13999 check_spool_inodes = 100
14000 .endd
14001 The spool partition is the one that contains the directory defined by
14002 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14003 transit.
14004
14005 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14006 files are written if either is greater than zero. These should be set only if
14007 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14008
14009 If there is less space or fewer inodes than requested, Exim refuses to accept
14010 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14011 error response to the MAIL command. If ESMTP is in use and there was a
14012 SIZE parameter on the MAIL command, its value is added to the
14013 &%check_spool_space%& value, and the check is performed even if
14014 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14015
14016 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14017 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14018
14019 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14020 failure a message is written to stderr and Exim exits with a non-zero code, as
14021 it obviously cannot send an error message of any kind.
14022
14023 .option daemon_smtp_ports main string &`smtp`&
14024 .cindex "port" "for daemon"
14025 .cindex "TCP/IP" "setting listening ports"
14026 This option specifies one or more default SMTP ports on which the Exim daemon
14027 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14028 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14029
14030 .option daemon_startup_retries main integer 9
14031 .cindex "daemon startup, retrying"
14032 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14033 the daemon at startup when it cannot immediately bind a listening socket
14034 (typically because the socket is already in use): &%daemon_startup_retries%&
14035 defines the number of retries after the first failure, and
14036 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14037
14038 .option daemon_startup_sleep main time 30s
14039 See &%daemon_startup_retries%&.
14040
14041 .option delay_warning main "time list" 24h
14042 .cindex "warning of delay"
14043 .cindex "delay warning, specifying"
14044 When a message is delayed, Exim sends a warning message to the sender at
14045 intervals specified by this option. The data is a colon-separated list of times
14046 after which to send warning messages. If the value of the option is an empty
14047 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14048 message has been on the queue for longer than the last time, the last interval
14049 between the times is used to compute subsequent warning times. For example,
14050 with
14051 .code
14052 delay_warning = 4h:8h:24h
14053 .endd
14054 the first message is sent after 4 hours, the second after 8 hours, and
14055 the third one after 24 hours. After that, messages are sent every 16 hours,
14056 because that is the interval between the last two times on the list. If you set
14057 just one time, it specifies the repeat interval. For example, with:
14058 .code
14059 delay_warning = 6h
14060 .endd
14061 messages are repeated every six hours. To stop warnings after a given time, set
14062 a very large time at the end of the list. For example:
14063 .code
14064 delay_warning = 2h:12h:99d
14065 .endd
14066 Note that the option is only evaluated at the time a delivery attempt fails,
14067 which depends on retry and queue-runner configuration.
14068 Typically retries will be configured more frequently than warning messages.
14069
14070 .option delay_warning_condition main string&!! "see below"
14071 .vindex "&$domain$&"
14072 The string is expanded at the time a warning message might be sent. If all the
14073 deferred addresses have the same domain, it is set in &$domain$& during the
14074 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14075 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14076 &"false"& (the comparison being done caselessly) then the warning message is
14077 not sent. The default is:
14078 .code
14079 delay_warning_condition = ${if or {\
14080   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14081   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14082   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14083   } {no}{yes}}
14084 .endd
14085 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14086 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14087 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14088 &"auto-replied"& in an &'Auto-Submitted:'& header.
14089
14090 .option deliver_drop_privilege main boolean false
14091 .cindex "unprivileged delivery"
14092 .cindex "delivery" "unprivileged"
14093 If this option is set true, Exim drops its root privilege at the start of a
14094 delivery process, and runs as the Exim user throughout. This severely restricts
14095 the kinds of local delivery that are possible, but is viable in certain types
14096 of configuration. There is a discussion about the use of root privilege in
14097 chapter &<<CHAPsecurity>>&.
14098
14099 .option deliver_queue_load_max main fixed-point unset
14100 .cindex "load average"
14101 .cindex "queue runner" "abandoning"
14102 When this option is set, a queue run is abandoned if the system load average
14103 becomes greater than the value of the option. The option has no effect on
14104 ancient operating systems on which Exim cannot determine the load average.
14105 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14106
14107
14108 .option delivery_date_remove main boolean true
14109 .cindex "&'Delivery-date:'& header line"
14110 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14111 message when it is delivered, in exactly the same way as &'Return-path:'& is
14112 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14113 should not be present in incoming messages, and this option causes them to be
14114 removed at the time the message is received, to avoid any problems that might
14115 occur when a delivered message is subsequently sent on to some other recipient.
14116
14117 .option disable_fsync main boolean false
14118 .cindex "&[fsync()]&, disabling"
14119 This option is available only if Exim was built with the compile-time option
14120 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14121 a runtime configuration generates an &"unknown option"& error. You should not
14122 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14123 really, really, really understand what you are doing. &'No pre-compiled
14124 distributions of Exim should ever make this option available.'&
14125
14126 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14127 updated files' data to be written to disc before continuing. Unexpected events
14128 such as crashes and power outages may cause data to be lost or scrambled.
14129 Here be Dragons. &*Beware.*&
14130
14131
14132 .option disable_ipv6 main boolean false
14133 .cindex "IPv6" "disabling"
14134 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14135 activities take place. AAAA records are never looked up, and any IPv6 addresses
14136 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14137 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14138 to handle IPv6 literal addresses.
14139
14140
14141 .option dns_again_means_nonexist main "domain list&!!" unset
14142 .cindex "DNS" "&""try again""& response; overriding"
14143 DNS lookups give a &"try again"& response for the DNS errors
14144 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14145 keep trying to deliver a message, or to give repeated temporary errors to
14146 incoming mail. Sometimes the effect is caused by a badly set up name server and
14147 may persist for a long time. If a domain which exhibits this problem matches
14148 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14149 This option should be used with care. You can make it apply to reverse lookups
14150 by a setting such as this:
14151 .code
14152 dns_again_means_nonexist = *.in-addr.arpa
14153 .endd
14154 This option applies to all DNS lookups that Exim does. It also applies when the
14155 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14156 since these are most likely to be caused by DNS lookup problems. The
14157 &(dnslookup)& router has some options of its own for controlling what happens
14158 when lookups for MX or SRV records give temporary errors. These more specific
14159 options are applied after this global option.
14160
14161 .option dns_check_names_pattern main string "see below"
14162 .cindex "DNS" "pre-check of name syntax"
14163 When this option is set to a non-empty string, it causes Exim to check domain
14164 names for characters that are not allowed in host names before handing them to
14165 the DNS resolver, because some resolvers give temporary errors for names that
14166 contain unusual characters. If a domain name contains any unwanted characters,
14167 a &"not found"& result is forced, and the resolver is not called. The check is
14168 done by matching the domain name against a regular expression, which is the
14169 value of this option. The default pattern is
14170 .code
14171 dns_check_names_pattern = \
14172   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14173 .endd
14174 which permits only letters, digits, slashes, and hyphens in components, but
14175 they must start and end with a letter or digit. Slashes are not, in fact,
14176 permitted in host names, but they are found in certain NS records (which can be
14177 accessed in Exim by using a &%dnsdb%& lookup). If you set
14178 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14179 empty string.
14180
14181 .option dns_csa_search_limit main integer 5
14182 This option controls the depth of parental searching for CSA SRV records in the
14183 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14184
14185 .option dns_csa_use_reverse main boolean true
14186 This option controls whether or not an IP address, given as a CSA domain, is
14187 reversed and looked up in the reverse DNS, as described in more detail in
14188 section &<<SECTverifyCSA>>&.
14189
14190
14191 .option dns_dnssec_ok main integer -1
14192 .cindex "DNS" "resolver options"
14193 .cindex "DNS" "DNSSEC"
14194 If this option is set to a non-negative number then Exim will initialise the
14195 DNS resolver library to either use or not use DNSSEC, overriding the system
14196 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14197
14198 If the resolver library does not support DNSSEC then this option has no effect.
14199
14200
14201 .option dns_ipv4_lookup main "domain list&!!" unset
14202 .cindex "IPv6" "DNS lookup for AAAA records"
14203 .cindex "DNS" "IPv6 lookup for AAAA records"
14204 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14205 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14206 (A records) when trying to find IP addresses for hosts, unless the host's
14207 domain matches this list.
14208
14209 This is a fudge to help with name servers that give big delays or otherwise do
14210 not work for the AAAA record type. In due course, when the world's name
14211 servers have all been upgraded, there should be no need for this option.
14212
14213
14214 .option dns_retrans main time 0s
14215 .cindex "DNS" "resolver options"
14216 .cindex timeout "dns lookup"
14217 .cindex "DNS" timeout
14218 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14219 retransmission and retry parameters for DNS lookups. Values of zero (the
14220 defaults) leave the system default settings unchanged. The first value is the
14221 time between retries, and the second is the number of retries. It isn't
14222 totally clear exactly how these settings affect the total time a DNS lookup may
14223 take. I haven't found any documentation about timeouts on DNS lookups; these
14224 parameter values are available in the external resolver interface structure,
14225 but nowhere does it seem to describe how they are used or what you might want
14226 to set in them.
14227 See also the &%slow_lookup_log%& option.
14228
14229
14230 .option dns_retry main integer 0
14231 See &%dns_retrans%& above.
14232
14233
14234 .option dns_use_edns0 main integer -1
14235 .cindex "DNS" "resolver options"
14236 .cindex "DNS" "EDNS0"
14237 If this option is set to a non-negative number then Exim will initialise the
14238 DNS resolver library to either use or not use EDNS0 extensions, overriding
14239 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14240 on.
14241
14242 If the resolver library does not support EDNS0 then this option has no effect.
14243
14244
14245 .option drop_cr main boolean false
14246 This is an obsolete option that is now a no-op. It used to affect the way Exim
14247 handled CR and LF characters in incoming messages. What happens now is
14248 described in section &<<SECTlineendings>>&.
14249
14250 .new
14251 .option dsn_advertise_hosts main "host list&!!" unset
14252 .cindex "bounce messages" "success"
14253 .cindex "DSN" "success"
14254 .cindex "Delivery Status Notification" "success"
14255 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14256 and accepted from, these hosts.
14257 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14258 and RET and ORCPT options on MAIL FROM commands.
14259 A NOTIFY=SUCCESS option requests success-DSN messages.
14260 A NOTIFY= option with no argument requests that no delay or failure DSNs
14261 are sent.
14262 .wen
14263
14264 .option dsn_from main "string&!!" "see below"
14265 .cindex "&'From:'& header line" "in bounces"
14266 .cindex "bounce messages" "&'From:'& line, specifying"
14267 This option can be used to vary the contents of &'From:'& header lines in
14268 bounces and other automatically generated messages (&"Delivery Status
14269 Notifications"& &-- hence the name of the option). The default setting is:
14270 .code
14271 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14272 .endd
14273 The value is expanded every time it is needed. If the expansion fails, a
14274 panic is logged, and the default value is used.
14275
14276 .option envelope_to_remove main boolean true
14277 .cindex "&'Envelope-to:'& header line"
14278 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14279 message when it is delivered, in exactly the same way as &'Return-path:'& is
14280 handled. &'Envelope-to:'& records the original recipient address from the
14281 messages's envelope that caused the delivery to happen. Such headers should not
14282 be present in incoming messages, and this option causes them to be removed at
14283 the time the message is received, to avoid any problems that might occur when a
14284 delivered message is subsequently sent on to some other recipient.
14285
14286
14287 .option errors_copy main "string list&!!" unset
14288 .cindex "bounce message" "copy to other address"
14289 .cindex "copy of bounce message"
14290 Setting this option causes Exim to send bcc copies of bounce messages that it
14291 generates to other addresses. &*Note*&: This does not apply to bounce messages
14292 coming from elsewhere. The value of the option is a colon-separated list of
14293 items. Each item consists of a pattern, terminated by white space, followed by
14294 a comma-separated list of email addresses. If a pattern contains spaces, it
14295 must be enclosed in double quotes.
14296
14297 Each pattern is processed in the same way as a single item in an address list
14298 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14299 the bounce message, the message is copied to the addresses on the list. The
14300 items are scanned in order, and once a matching one is found, no further items
14301 are examined. For example:
14302 .code
14303 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14304               rqps@mydomain   hostmaster@mydomain.example,\
14305                               postmaster@mydomain.example
14306 .endd
14307 .vindex "&$domain$&"
14308 .vindex "&$local_part$&"
14309 The address list is expanded before use. The expansion variables &$local_part$&
14310 and &$domain$& are set from the original recipient of the error message, and if
14311 there was any wildcard matching in the pattern, the expansion
14312 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14313 variables &$0$&, &$1$&, etc. are set in the normal way.
14314
14315
14316 .option errors_reply_to main string unset
14317 .cindex "bounce message" "&'Reply-to:'& in"
14318 By default, Exim's bounce and delivery warning messages contain the header line
14319 .display
14320 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14321 .endd
14322 .oindex &%quota_warn_message%&
14323 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14324 A warning message that is generated by the &%quota_warn_message%& option in an
14325 &(appendfile)& transport may contain its own &'From:'& header line that
14326 overrides the default.
14327
14328 Experience shows that people reply to bounce messages. If the
14329 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14330 and warning messages. For example:
14331 .code
14332 errors_reply_to = postmaster@my.domain.example
14333 .endd
14334 The value of the option is not expanded. It must specify a valid RFC 2822
14335 address. However, if a warning message that is generated by the
14336 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14337 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14338 not used.
14339
14340
14341 .option exim_group main string "compile-time configured"
14342 .cindex "gid (group id)" "Exim's own"
14343 .cindex "Exim group"
14344 This option changes the gid under which Exim runs when it gives up root
14345 privilege. The default value is compiled into the binary. The value of this
14346 option is used only when &%exim_user%& is also set. Unless it consists entirely
14347 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14348 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14349 security issues.
14350
14351
14352 .option exim_path main string "see below"
14353 .cindex "Exim binary, path name"
14354 This option specifies the path name of the Exim binary, which is used when Exim
14355 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14356 the directory configured at compile time by the BIN_DIRECTORY setting. It
14357 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14358 other place.
14359 &*Warning*&: Do not use a macro to define the value of this option, because
14360 you will break those Exim utilities that scan the configuration file to find
14361 where the binary is. (They then use the &%-bP%& option to extract option
14362 settings such as the value of &%spool_directory%&.)
14363
14364
14365 .option exim_user main string "compile-time configured"
14366 .cindex "uid (user id)" "Exim's own"
14367 .cindex "Exim user"
14368 This option changes the uid under which Exim runs when it gives up root
14369 privilege. The default value is compiled into the binary. Ownership of the run
14370 time configuration file and the use of the &%-C%& and &%-D%& command line
14371 options is checked against the values in the binary, not what is set here.
14372
14373 Unless it consists entirely of digits, the string is looked up using
14374 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14375 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14376 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14377
14378
14379 .option extra_local_interfaces main "string list" unset
14380 This option defines network interfaces that are to be considered local when
14381 routing, but which are not used for listening by the daemon. See section
14382 &<<SECTreclocipadd>>& for details.
14383
14384
14385 . Allow this long option name to split; give it unsplit as a fifth argument
14386 . for the automatic .oindex that is generated by .option.
14387
14388 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14389          extract_addresses_remove_arguments
14390 .oindex "&%-t%&"
14391 .cindex "command line" "addresses with &%-t%&"
14392 .cindex "Sendmail compatibility" "&%-t%& option"
14393 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14394 are present on the command line when the &%-t%& option is used to build an
14395 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14396 line addresses are removed from the recipients list. This is also how Smail
14397 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14398 command line addresses are added to those obtained from the header lines. When
14399 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14400 argument headers. If it is set false, Exim adds rather than removes argument
14401 addresses.
14402
14403
14404 .option finduser_retries main integer 0
14405 .cindex "NIS, retrying user lookups"
14406 On systems running NIS or other schemes in which user and group information is
14407 distributed from a remote system, there can be times when &[getpwnam()]& and
14408 related functions fail, even when given valid data, because things time out.
14409 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14410 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14411 many extra times to find a user or a group, waiting for one second between
14412 retries.
14413
14414 .cindex "&_/etc/passwd_&" "multiple reading of"
14415 You should not set this option greater than zero if your user information is in
14416 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14417 search the file multiple times for non-existent users, and also cause delay.
14418
14419
14420
14421 .option freeze_tell main "string list, comma separated" unset
14422 .cindex "freezing messages" "sending a message when freezing"
14423 On encountering certain errors, or when configured to do so in a system filter,
14424 ACL, or special router, Exim freezes a message. This means that no further
14425 delivery attempts take place until an administrator thaws the message, or the
14426 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14427 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14428 warning message whenever it freezes something, unless the message it is
14429 freezing is a locally-generated bounce message. (Without this exception there
14430 is the possibility of looping.) The warning message is sent to the addresses
14431 supplied as the comma-separated value of this option. If several of the
14432 message's addresses cause freezing, only a single message is sent. If the
14433 freezing was automatic, the reason(s) for freezing can be found in the message
14434 log. If you configure freezing in a filter or ACL, you must arrange for any
14435 logging that you require.
14436
14437
14438 .option gecos_name main string&!! unset
14439 .cindex "HP-UX"
14440 .cindex "&""gecos""& field, parsing"
14441 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14442 password file to hold other information in addition to users' real names. Exim
14443 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14444 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14445 of the field are used unchanged, except that, if an ampersand is encountered,
14446 it is replaced by the user's login name with the first character forced to
14447 upper case, since this is a convention that is observed on many systems.
14448
14449 When these options are set, &%gecos_pattern%& is treated as a regular
14450 expression that is to be applied to the field (again with && replaced by the
14451 login name), and if it matches, &%gecos_name%& is expanded and used as the
14452 user's name.
14453
14454 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14455 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14456 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14457 name terminates at the first comma, the following can be used:
14458 .code
14459 gecos_pattern = ([^,]*)
14460 gecos_name = $1
14461 .endd
14462
14463 .option gecos_pattern main string unset
14464 See &%gecos_name%& above.
14465
14466
14467 .option gnutls_compat_mode main boolean unset
14468 This option controls whether GnuTLS is used in compatibility mode in an Exim
14469 server. This reduces security slightly, but improves interworking with older
14470 implementations of TLS.
14471
14472
14473 option gnutls_allow_auto_pkcs11 main boolean unset
14474 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14475 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14476
14477 See
14478 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14479 for documentation.
14480
14481
14482
14483 .option headers_charset main string "see below"
14484 This option sets a default character set for translating from encoded MIME
14485 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14486 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14487 ultimate default is ISO-8859-1. For more details see the description of header
14488 insertions in section &<<SECTexpansionitems>>&.
14489
14490
14491
14492 .option header_maxsize main integer "see below"
14493 .cindex "header section" "maximum size of"
14494 .cindex "limit" "size of message header section"
14495 This option controls the overall maximum size of a message's header
14496 section. The default is the value of HEADER_MAXSIZE in
14497 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14498 sections are rejected.
14499
14500
14501 .option header_line_maxsize main integer 0
14502 .cindex "header lines" "maximum size of"
14503 .cindex "limit" "size of one header line"
14504 This option limits the length of any individual header line in a message, after
14505 all the continuations have been joined together. Messages with individual
14506 header lines that are longer than the limit are rejected. The default value of
14507 zero means &"no limit"&.
14508
14509
14510
14511
14512 .option helo_accept_junk_hosts main "host list&!!" unset
14513 .cindex "HELO" "accepting junk data"
14514 .cindex "EHLO" "accepting junk data"
14515 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14516 mail, and gives an error response for invalid data. Unfortunately, there are
14517 some SMTP clients that send syntactic junk. They can be accommodated by setting
14518 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14519 if you want to do semantic checking.
14520 See also &%helo_allow_chars%& for a way of extending the permitted character
14521 set.
14522
14523
14524 .option helo_allow_chars main string unset
14525 .cindex "HELO" "underscores in"
14526 .cindex "EHLO" "underscores in"
14527 .cindex "underscore in EHLO/HELO"
14528 This option can be set to a string of rogue characters that are permitted in
14529 all EHLO and HELO names in addition to the standard letters, digits,
14530 hyphens, and dots. If you really must allow underscores, you can set
14531 .code
14532 helo_allow_chars = _
14533 .endd
14534 Note that the value is one string, not a list.
14535
14536
14537 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14538 .cindex "HELO" "forcing reverse lookup"
14539 .cindex "EHLO" "forcing reverse lookup"
14540 If the domain given by a client in a HELO or EHLO command matches this
14541 list, a reverse lookup is done in order to establish the host's true name. The
14542 default forces a lookup if the client host gives the server's name or any of
14543 its IP addresses (in brackets), something that broken clients have been seen to
14544 do.
14545
14546
14547 .option helo_try_verify_hosts main "host list&!!" unset
14548 .cindex "HELO verifying" "optional"
14549 .cindex "EHLO" "verifying, optional"
14550 By default, Exim just checks the syntax of HELO and EHLO commands (see
14551 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14552 to do more extensive checking of the data supplied by these commands. The ACL
14553 condition &`verify = helo`& is provided to make this possible.
14554 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14555 to force the check to occur. From release 4.53 onwards, this is no longer
14556 necessary. If the check has not been done before &`verify = helo`& is
14557 encountered, it is done at that time. Consequently, this option is obsolete.
14558 Its specification is retained here for backwards compatibility.
14559
14560 When an EHLO or HELO command is received, if the calling host matches
14561 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14562 EHLO command either:
14563
14564 .ilist
14565 is an IP literal matching the calling address of the host, or
14566 .next
14567 .cindex "DNS" "reverse lookup"
14568 .cindex "reverse DNS lookup"
14569 matches the host name that Exim obtains by doing a reverse lookup of the
14570 calling host address, or
14571 .next
14572 when looked up in DNS yields the calling host address.
14573 .endlist
14574
14575 However, the EHLO or HELO command is not rejected if any of the checks
14576 fail. Processing continues, but the result of the check is remembered, and can
14577 be detected later in an ACL by the &`verify = helo`& condition.
14578
14579 If DNS was used for successful verification, the variable
14580 .cindex "DNS" "DNSSEC"
14581 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14582
14583 .option helo_verify_hosts main "host list&!!" unset
14584 .cindex "HELO verifying" "mandatory"
14585 .cindex "EHLO" "verifying, mandatory"
14586 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14587 backwards compatibility. For hosts that match this option, Exim checks the host
14588 name given in the HELO or EHLO in the same way as for
14589 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14590 rejected with a 550 error, and entries are written to the main and reject logs.
14591 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14592 error.
14593
14594 .option hold_domains main "domain list&!!" unset
14595 .cindex "domain" "delaying delivery"
14596 .cindex "delivery" "delaying certain domains"
14597 This option allows mail for particular domains to be held on the queue
14598 manually. The option is overridden if a message delivery is forced with the
14599 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14600 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14601 item in &%hold_domains%&, no routing or delivery for that address is done, and
14602 it is deferred every time the message is looked at.
14603
14604 This option is intended as a temporary operational measure for delaying the
14605 delivery of mail while some problem is being sorted out, or some new
14606 configuration tested. If you just want to delay the processing of some
14607 domains until a queue run occurs, you should use &%queue_domains%& or
14608 &%queue_smtp_domains%&, not &%hold_domains%&.
14609
14610 A setting of &%hold_domains%& does not override Exim's code for removing
14611 messages from the queue if they have been there longer than the longest retry
14612 time in any retry rule. If you want to hold messages for longer than the normal
14613 retry times, insert a dummy retry rule with a long retry time.
14614
14615
14616 .option host_lookup main "host list&!!" unset
14617 .cindex "host name" "lookup, forcing"
14618 Exim does not look up the name of a calling host from its IP address unless it
14619 is required to compare against some host list, or the host matches
14620 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14621 option (which normally contains IP addresses rather than host names). The
14622 default configuration file contains
14623 .code
14624 host_lookup = *
14625 .endd
14626 which causes a lookup to happen for all hosts. If the expense of these lookups
14627 is felt to be too great, the setting can be changed or removed.
14628
14629 After a successful reverse lookup, Exim does a forward lookup on the name it
14630 has obtained, to verify that it yields the IP address that it started with. If
14631 this check fails, Exim behaves as if the name lookup failed.
14632
14633 .vindex "&$host_lookup_failed$&"
14634 .vindex "&$sender_host_name$&"
14635 After any kind of failure, the host name (in &$sender_host_name$&) remains
14636 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14637 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14638 &`verify = reverse_host_lookup`& in ACLs.
14639
14640
14641 .option host_lookup_order main "string list" &`bydns:byaddr`&
14642 This option specifies the order of different lookup methods when Exim is trying
14643 to find a host name from an IP address. The default is to do a DNS lookup
14644 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14645 if that fails. You can change the order of these lookups, or omit one entirely,
14646 if you want.
14647
14648 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14649 multiple PTR records in the DNS and the IP address is not listed in
14650 &_/etc/hosts_&. Different operating systems give different results in this
14651 case. That is why the default tries a DNS lookup first.
14652
14653
14654
14655 .option host_reject_connection main "host list&!!" unset
14656 .cindex "host" "rejecting connections from"
14657 If this option is set, incoming SMTP calls from the hosts listed are rejected
14658 as soon as the connection is made.
14659 This option is obsolete, and retained only for backward compatibility, because
14660 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14661 connections immediately.
14662
14663 The ability to give an immediate rejection (either by this option or using an
14664 ACL) is provided for use in unusual cases. Many hosts will just try again,
14665 sometimes without much delay. Normally, it is better to use an ACL to reject
14666 incoming messages at a later stage, such as after RCPT commands. See
14667 chapter &<<CHAPACL>>&.
14668
14669
14670 .option hosts_connection_nolog main "host list&!!" unset
14671 .cindex "host" "not logging connections from"
14672 This option defines a list of hosts for which connection logging does not
14673 happen, even though the &%smtp_connection%& log selector is set. For example,
14674 you might want not to log SMTP connections from local processes, or from
14675 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14676 the daemon; you should therefore strive to restrict its value to a short inline
14677 list of IP addresses and networks. To disable logging SMTP connections from
14678 local processes, you must create a host list with an empty item. For example:
14679 .code
14680 hosts_connection_nolog = :
14681 .endd
14682 If the &%smtp_connection%& log selector is not set, this option has no effect.
14683
14684
14685
14686 .option hosts_treat_as_local main "domain list&!!" unset
14687 .cindex "local host" "domains treated as"
14688 .cindex "host" "treated as local"
14689 If this option is set, any host names that match the domain list are treated as
14690 if they were the local host when Exim is scanning host lists obtained from MX
14691 records
14692 or other sources. Note that the value of this option is a domain list, not a
14693 host list, because it is always used to check host names, not IP addresses.
14694
14695 This option also applies when Exim is matching the special items
14696 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14697 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14698 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14699 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14700 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14701 interfaces and recognizing the local host.
14702
14703
14704 .option ibase_servers main "string list" unset
14705 .cindex "InterBase" "server list"
14706 This option provides a list of InterBase servers and associated connection data,
14707 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14708 The option is available only if Exim has been built with InterBase support.
14709
14710
14711
14712 .option ignore_bounce_errors_after main time 10w
14713 .cindex "bounce message" "discarding"
14714 .cindex "discarding bounce message"
14715 This option affects the processing of bounce messages that cannot be delivered,
14716 that is, those that suffer a permanent delivery failure. (Bounce messages that
14717 suffer temporary delivery failures are of course retried in the usual way.)
14718
14719 After a permanent delivery failure, bounce messages are frozen,
14720 because there is no sender to whom they can be returned. When a frozen bounce
14721 message has been on the queue for more than the given time, it is unfrozen at
14722 the next queue run, and a further delivery is attempted. If delivery fails
14723 again, the bounce message is discarded. This makes it possible to keep failed
14724 bounce messages around for a shorter time than the normal maximum retry time
14725 for frozen messages. For example,
14726 .code
14727 ignore_bounce_errors_after = 12h
14728 .endd
14729 retries failed bounce message deliveries after 12 hours, discarding any further
14730 failures. If the value of this option is set to a zero time period, bounce
14731 failures are discarded immediately. Setting a very long time (as in the default
14732 value) has the effect of disabling this option. For ways of automatically
14733 dealing with other kinds of frozen message, see &%auto_thaw%& and
14734 &%timeout_frozen_after%&.
14735
14736
14737 .option ignore_fromline_hosts main "host list&!!" unset
14738 .cindex "&""From""& line"
14739 .cindex "UUCP" "&""From""& line"
14740 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14741 the headers of a message. By default this is treated as the start of the
14742 message's body, which means that any following headers are not recognized as
14743 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14744 match those hosts that insist on sending it. If the sender is actually a local
14745 process rather than a remote host, and is using &%-bs%& to inject the messages,
14746 &%ignore_fromline_local%& must be set to achieve this effect.
14747
14748
14749 .option ignore_fromline_local main boolean false
14750 See &%ignore_fromline_hosts%& above.
14751
14752
14753 .option keep_malformed main time 4d
14754 This option specifies the length of time to keep messages whose spool files
14755 have been corrupted in some way. This should, of course, never happen. At the
14756 next attempt to deliver such a message, it gets removed. The incident is
14757 logged.
14758
14759
14760 .option ldap_ca_cert_dir main string unset
14761 .cindex "LDAP", "TLS CA certificate directory"
14762 This option indicates which directory contains CA certificates for verifying
14763 a TLS certificate presented by an LDAP server.
14764 While Exim does not provide a default value, your SSL library may.
14765 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14766 and constrained to be a directory.
14767
14768
14769 .option ldap_ca_cert_file main string unset
14770 .cindex "LDAP", "TLS CA certificate file"
14771 This option indicates which file contains CA certificates for verifying
14772 a TLS certificate presented by an LDAP server.
14773 While Exim does not provide a default value, your SSL library may.
14774 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14775 and constrained to be a file.
14776
14777
14778 .option ldap_cert_file main string unset
14779 .cindex "LDAP" "TLS client certificate file"
14780 This option indicates which file contains an TLS client certificate which
14781 Exim should present to the LDAP server during TLS negotiation.
14782 Should be used together with &%ldap_cert_key%&.
14783
14784
14785 .option ldap_cert_key main string unset
14786 .cindex "LDAP" "TLS client key file"
14787 This option indicates which file contains the secret/private key to use
14788 to prove identity to the LDAP server during TLS negotiation.
14789 Should be used together with &%ldap_cert_file%&, which contains the
14790 identity to be proven.
14791
14792
14793 .option ldap_cipher_suite main string unset
14794 .cindex "LDAP" "TLS cipher suite"
14795 This controls the TLS cipher-suite negotiation during TLS negotiation with
14796 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14797 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14798
14799
14800 .option ldap_default_servers main "string list" unset
14801 .cindex "LDAP" "default servers"
14802 This option provides a list of LDAP servers which are tried in turn when an
14803 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14804 details of LDAP queries. This option is available only when Exim has been built
14805 with LDAP support.
14806
14807
14808 .option ldap_require_cert main string unset.
14809 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14810 This should be one of the values "hard", "demand", "allow", "try" or "never".
14811 A value other than one of these is interpreted as "never".
14812 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14813 Although Exim does not set a default, the LDAP library probably defaults
14814 to hard/demand.
14815
14816
14817 .option ldap_start_tls main boolean false
14818 .cindex "LDAP" "whether or not to negotiate TLS"
14819 If set, Exim will attempt to negotiate TLS with the LDAP server when
14820 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14821 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14822 of SSL-on-connect.
14823 In the event of failure to negotiate TLS, the action taken is controlled
14824 by &%ldap_require_cert%&.
14825
14826
14827 .option ldap_version main integer unset
14828 .cindex "LDAP" "protocol version, forcing"
14829 This option can be used to force Exim to set a specific protocol version for
14830 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14831 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14832 the LDAP headers; otherwise it is 2. This option is available only when Exim
14833 has been built with LDAP support.
14834
14835
14836
14837 .option local_from_check main boolean true
14838 .cindex "&'Sender:'& header line" "disabling addition of"
14839 .cindex "&'From:'& header line" "disabling checking of"
14840 When a message is submitted locally (that is, not over a TCP/IP connection) by
14841 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14842 checks that the &'From:'& header line matches the login of the calling user and
14843 the domain specified by &%qualify_domain%&.
14844
14845 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14846 locally submitted message is automatically qualified by Exim, unless the
14847 &%-bnq%& command line option is used.
14848
14849 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14850 on the local part. If the &'From:'& header line does not match, Exim adds a
14851 &'Sender:'& header with an address constructed from the calling user's login
14852 and the default qualify domain.
14853
14854 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14855 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14856 &'Sender:'& header lines supplied by untrusted users, you must also set
14857 &%local_sender_retain%& to be true.
14858
14859 .cindex "envelope sender"
14860 These options affect only the header lines in the message. The envelope sender
14861 is still forced to be the login id at the qualify domain unless
14862 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14863
14864 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14865 request similar header line checking. See section &<<SECTthesenhea>>&, which
14866 has more details about &'Sender:'& processing.
14867
14868
14869
14870
14871 .option local_from_prefix main string unset
14872 When Exim checks the &'From:'& header line of locally submitted messages for
14873 matching the login id (see &%local_from_check%& above), it can be configured to
14874 ignore certain prefixes and suffixes in the local part of the address. This is
14875 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14876 appropriate lists, in the same form as the &%local_part_prefix%& and
14877 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14878 example, if
14879 .code
14880 local_from_prefix = *-
14881 .endd
14882 is set, a &'From:'& line containing
14883 .code
14884 From: anything-user@your.domain.example
14885 .endd
14886 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14887 matches the actual sender address that is constructed from the login name and
14888 qualify domain.
14889
14890
14891 .option local_from_suffix main string unset
14892 See &%local_from_prefix%& above.
14893
14894
14895 .option local_interfaces main "string list" "see below"
14896 This option controls which network interfaces are used by the daemon for
14897 listening; they are also used to identify the local host when routing. Chapter
14898 &<<CHAPinterfaces>>& contains a full description of this option and the related
14899 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14900 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14901 &%local_interfaces%& is
14902 .code
14903 local_interfaces = 0.0.0.0
14904 .endd
14905 when Exim is built without IPv6 support; otherwise it is
14906 .code
14907 local_interfaces = <; ::0 ; 0.0.0.0
14908 .endd
14909
14910 .option local_scan_timeout main time 5m
14911 .cindex "timeout" "for &[local_scan()]& function"
14912 .cindex "&[local_scan()]& function" "timeout"
14913 This timeout applies to the &[local_scan()]& function (see chapter
14914 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14915 the incoming message is rejected with a temporary error if it is an SMTP
14916 message. For a non-SMTP message, the message is dropped and Exim ends with a
14917 non-zero code. The incident is logged on the main and reject logs.
14918
14919
14920
14921 .option local_sender_retain main boolean false
14922 .cindex "&'Sender:'& header line" "retaining from local submission"
14923 When a message is submitted locally (that is, not over a TCP/IP connection) by
14924 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14925 do not want this to happen, you must set &%local_sender_retain%&, and you must
14926 also set &%local_from_check%& to be false (Exim will complain if you do not).
14927 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14928 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14929
14930
14931
14932
14933 .option localhost_number main string&!! unset
14934 .cindex "host" "locally unique number for"
14935 .cindex "message ids" "with multiple hosts"
14936 .vindex "&$localhost_number$&"
14937 Exim's message ids are normally unique only within the local host. If
14938 uniqueness among a set of hosts is required, each host must set a different
14939 value for the &%localhost_number%& option. The string is expanded immediately
14940 after reading the configuration file (so that a number can be computed from the
14941 host name, for example) and the result of the expansion must be a number in the
14942 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14943 systems). This is available in subsequent string expansions via the variable
14944 &$localhost_number$&. When &%localhost_number is set%&, the final two
14945 characters of the message id, instead of just being a fractional part of the
14946 time, are computed from the time and the local host number as described in
14947 section &<<SECTmessiden>>&.
14948
14949
14950
14951 .option log_file_path main "string list&!!" "set at compile time"
14952 .cindex "log" "file path for"
14953 This option sets the path which is used to determine the names of Exim's log
14954 files, or indicates that logging is to be to syslog, or both. It is expanded
14955 when Exim is entered, so it can, for example, contain a reference to the host
14956 name. If no specific path is set for the log files at compile or run time,
14957 or if the option is unset at run time (i.e.  &`log_file_path = `&)
14958 they are written in a sub-directory called &_log_& in Exim's spool directory.
14959 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14960 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14961 used. If this string is fixed at your installation (contains no expansion
14962 variables) it is recommended that you do not set this option in the
14963 configuration file, but instead supply the path using LOG_FILE_PATH in
14964 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14965 early on &-- in particular, failure to read the configuration file.
14966
14967
14968 .option log_selector main string unset
14969 .cindex "log" "selectors"
14970 This option can be used to reduce or increase the number of things that Exim
14971 writes to its log files. Its argument is made up of names preceded by plus or
14972 minus characters. For example:
14973 .code
14974 log_selector = +arguments -retry_defer
14975 .endd
14976 A list of possible names and what they control is given in the chapter on
14977 logging, in section &<<SECTlogselector>>&.
14978
14979
14980 .option log_timezone main boolean false
14981 .cindex "log" "timezone for entries"
14982 .vindex "&$tod_log$&"
14983 .vindex "&$tod_zone$&"
14984 By default, the timestamps on log lines are in local time without the
14985 timezone. This means that if your timezone changes twice a year, the timestamps
14986 in log lines are ambiguous for an hour when the clocks go back. One way of
14987 avoiding this problem is to set the timezone to UTC. An alternative is to set
14988 &%log_timezone%& true. This turns on the addition of the timezone offset to
14989 timestamps in log lines. Turning on this option can add quite a lot to the size
14990 of log files because each line is extended by 6 characters. Note that the
14991 &$tod_log$& variable contains the log timestamp without the zone, but there is
14992 another variable called &$tod_zone$& that contains just the timezone offset.
14993
14994
14995 .option lookup_open_max main integer 25
14996 .cindex "too many open files"
14997 .cindex "open files, too many"
14998 .cindex "file" "too many open"
14999 .cindex "lookup" "maximum open files"
15000 .cindex "limit" "open files for lookups"
15001 This option limits the number of simultaneously open files for single-key
15002 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15003 Exim normally keeps these files open during routing, because often the same
15004 file is required several times. If the limit is reached, Exim closes the least
15005 recently used file. Note that if you are using the &'ndbm'& library, it
15006 actually opens two files for each logical DBM database, though it still counts
15007 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15008 open files"& errors with NDBM, you need to reduce the value of
15009 &%lookup_open_max%&.
15010
15011
15012 .option max_username_length main integer 0
15013 .cindex "length of login name"
15014 .cindex "user name" "maximum length"
15015 .cindex "limit" "user name length"
15016 Some operating systems are broken in that they truncate long arguments to
15017 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15018 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15019 an argument that is longer behaves as if &[getpwnam()]& failed.
15020
15021
15022 .option message_body_newlines main bool false
15023 .cindex "message body" "newlines in variables"
15024 .cindex "newline" "in message body variables"
15025 .vindex "&$message_body$&"
15026 .vindex "&$message_body_end$&"
15027 By default, newlines in the message body are replaced by spaces when setting
15028 the &$message_body$& and &$message_body_end$& expansion variables. If this
15029 option is set true, this no longer happens.
15030
15031
15032 .option message_body_visible main integer 500
15033 .cindex "body of message" "visible size"
15034 .cindex "message body" "visible size"
15035 .vindex "&$message_body$&"
15036 .vindex "&$message_body_end$&"
15037 This option specifies how much of a message's body is to be included in the
15038 &$message_body$& and &$message_body_end$& expansion variables.
15039
15040
15041 .option message_id_header_domain main string&!! unset
15042 .cindex "&'Message-ID:'& header line"
15043 If this option is set, the string is expanded and used as the right hand side
15044 (domain) of the &'Message-ID:'& header that Exim creates if a
15045 locally-originated incoming message does not have one. &"Locally-originated"&
15046 means &"not received over TCP/IP."&
15047 Otherwise, the primary host name is used.
15048 Only letters, digits, dot and hyphen are accepted; any other characters are
15049 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15050 empty string, the option is ignored.
15051
15052
15053 .option message_id_header_text main string&!! unset
15054 If this variable is set, the string is expanded and used to augment the text of
15055 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15056 message does not have one. The text of this header is required by RFC 2822 to
15057 take the form of an address. By default, Exim uses its internal message id as
15058 the local part, and the primary host name as the domain. If this option is set,
15059 it is expanded, and provided the expansion is not forced to fail, and does not
15060 yield an empty string, the result is inserted into the header immediately
15061 before the @, separated from the internal message id by a dot. Any characters
15062 that are illegal in an address are automatically converted into hyphens. This
15063 means that variables such as &$tod_log$& can be used, because the spaces and
15064 colons will become hyphens.
15065
15066
15067 .option message_logs main boolean true
15068 .cindex "message logs" "disabling"
15069 .cindex "log" "message log; disabling"
15070 If this option is turned off, per-message log files are not created in the
15071 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15072 Exim, by reducing the number of files involved in handling a message from a
15073 minimum of four (header spool file, body spool file, delivery journal, and
15074 per-message log) to three. The other major I/O activity is Exim's main log,
15075 which is not affected by this option.
15076
15077
15078 .option message_size_limit main string&!! 50M
15079 .cindex "message" "size limit"
15080 .cindex "limit" "message size"
15081 .cindex "size" "of message, limit"
15082 This option limits the maximum size of message that Exim will process. The
15083 value is expanded for each incoming connection so, for example, it can be made
15084 to depend on the IP address of the remote host for messages arriving via
15085 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15086 optionally followed by K or M.
15087
15088 &*Note*&: This limit cannot be made to depend on a message's sender or any
15089 other properties of an individual message, because it has to be advertised in
15090 the server's response to EHLO. String expansion failure causes a temporary
15091 error. A value of zero means no limit, but its use is not recommended. See also
15092 &%bounce_return_size_limit%&.
15093
15094 Incoming SMTP messages are failed with a 552 error if the limit is
15095 exceeded; locally-generated messages either get a stderr message or a delivery
15096 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15097 an oversized message is logged in both the main and the reject logs. See also
15098 the generic transport option &%message_size_limit%&, which limits the size of
15099 message that an individual transport can process.
15100
15101 If you use a virus-scanner and set this option to to a value larger than the
15102 maximum size that your virus-scanner is configured to support, you may get
15103 failures triggered by large mails.  The right size to configure for the
15104 virus-scanner depends upon what data is passed and the options in use but it's
15105 probably safest to just set it to a little larger than this value.  Eg, with a
15106 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15107 some problems may result.
15108
15109 A value of 0 will disable size limit checking; Exim will still advertise the
15110 SIZE extension in an EHLO response, but without a limit, so as to permit
15111 SMTP clients to still indicate the message size along with the MAIL verb.
15112
15113
15114 .option move_frozen_messages main boolean false
15115 .cindex "frozen messages" "moving"
15116 This option, which is available only if Exim has been built with the setting
15117 .code
15118 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15119 .endd
15120 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15121 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15122 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15123 standard utilities for handling such moved messages, and they do not show up in
15124 lists generated by &%-bp%& or by the Exim monitor.
15125
15126
15127 .option mua_wrapper main boolean false
15128 Setting this option true causes Exim to run in a very restrictive mode in which
15129 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15130 contains a full description of this facility.
15131
15132
15133
15134 .option mysql_servers main "string list" unset
15135 .cindex "MySQL" "server list"
15136 This option provides a list of MySQL servers and associated connection data, to
15137 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15138 option is available only if Exim has been built with MySQL support.
15139
15140
15141 .option never_users main "string list&!!" unset
15142 This option is expanded just once, at the start of Exim's processing. Local
15143 message deliveries are normally run in processes that are setuid to the
15144 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15145 It is usually desirable to prevent any deliveries from running as root, as a
15146 safety precaution.
15147
15148 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15149 list of users that must not be used for local deliveries. This list is fixed in
15150 the binary and cannot be overridden by the configuration file. By default, it
15151 contains just the single user name &"root"&. The &%never_users%& runtime option
15152 can be used to add more users to the fixed list.
15153
15154 If a message is to be delivered as one of the users on the fixed list or the
15155 &%never_users%& list, an error occurs, and delivery is deferred. A common
15156 example is
15157 .code
15158 never_users = root:daemon:bin
15159 .endd
15160 Including root is redundant if it is also on the fixed list, but it does no
15161 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15162 transport driver.
15163
15164
15165 .option openssl_options main "string list" "+no_sslv2"
15166 .cindex "OpenSSL "compatibility options"
15167 This option allows an administrator to adjust the SSL options applied
15168 by OpenSSL to connections.  It is given as a space-separated list of items,
15169 each one to be +added or -subtracted from the current value.
15170
15171 This option is only available if Exim is built against OpenSSL.  The values
15172 available for this option vary according to the age of your OpenSSL install.
15173 The &"all"& value controls a subset of flags which are available, typically
15174 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15175 list the values known on your system and Exim should support all the
15176 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15177 names lose the leading &"SSL_OP_"& and are lower-cased.
15178
15179 Note that adjusting the options can have severe impact upon the security of
15180 SSL as used by Exim.  It is possible to disable safety checks and shoot
15181 yourself in the foot in various unpleasant ways.  This option should not be
15182 adjusted lightly.  An unrecognised item will be detected at startup, by
15183 invoking Exim with the &%-bV%& flag.
15184
15185 The option affects Exim operating both as a server and as a client.
15186
15187 Historical note: prior to release 4.80, Exim defaulted this value to
15188 "+dont_insert_empty_fragments", which may still be needed for compatibility
15189 with some clients, but which lowers security by increasing exposure to
15190 some now infamous attacks.
15191
15192 Examples:
15193 .code
15194 # Make both old MS and old Eudora happy:
15195 openssl_options = -all +microsoft_big_sslv3_buffer \
15196                        +dont_insert_empty_fragments
15197
15198 # Disable older protocol versions:
15199 openssl_options = +no_sslv2 +no_sslv3
15200 .endd
15201
15202 Possible options may include:
15203 .ilist
15204 &`all`&
15205 .next
15206 &`allow_unsafe_legacy_renegotiation`&
15207 .next
15208 &`cipher_server_preference`&
15209 .next
15210 &`dont_insert_empty_fragments`&
15211 .next
15212 &`ephemeral_rsa`&
15213 .next
15214 &`legacy_server_connect`&
15215 .next
15216 &`microsoft_big_sslv3_buffer`&
15217 .next
15218 &`microsoft_sess_id_bug`&
15219 .next
15220 &`msie_sslv2_rsa_padding`&
15221 .next
15222 &`netscape_challenge_bug`&
15223 .next
15224 &`netscape_reuse_cipher_change_bug`&
15225 .next
15226 &`no_compression`&
15227 .next
15228 &`no_session_resumption_on_renegotiation`&
15229 .next
15230 &`no_sslv2`&
15231 .next
15232 &`no_sslv3`&
15233 .next
15234 &`no_ticket`&
15235 .next
15236 &`no_tlsv1`&
15237 .next
15238 &`no_tlsv1_1`&
15239 .next
15240 &`no_tlsv1_2`&
15241 .next
15242 &`safari_ecdhe_ecdsa_bug`&
15243 .next
15244 &`single_dh_use`&
15245 .next
15246 &`single_ecdh_use`&
15247 .next
15248 &`ssleay_080_client_dh_bug`&
15249 .next
15250 &`sslref2_reuse_cert_type_bug`&
15251 .next
15252 &`tls_block_padding_bug`&
15253 .next
15254 &`tls_d5_bug`&
15255 .next
15256 &`tls_rollback_bug`&
15257 .endlist
15258
15259 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15260 all clients connecting using the MacOS SecureTransport TLS facility prior
15261 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15262 to negotiate TLS then this option value might help, provided that your OpenSSL
15263 release is new enough to contain this work-around.  This may be a situation
15264 where you have to upgrade OpenSSL to get buggy clients working.
15265
15266
15267 .option oracle_servers main "string list" unset
15268 .cindex "Oracle" "server list"
15269 This option provides a list of Oracle servers and associated connection data,
15270 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15271 The option is available only if Exim has been built with Oracle support.
15272
15273
15274 .option percent_hack_domains main "domain list&!!" unset
15275 .cindex "&""percent hack""&"
15276 .cindex "source routing" "in email address"
15277 .cindex "address" "source-routed"
15278 The &"percent hack"& is the convention whereby a local part containing a
15279 percent sign is re-interpreted as a new email address, with the percent
15280 replaced by @. This is sometimes called &"source routing"&, though that term is
15281 also applied to RFC 2822 addresses that begin with an @ character. If this
15282 option is set, Exim implements the percent facility for those domains listed,
15283 but no others. This happens before an incoming SMTP address is tested against
15284 an ACL.
15285
15286 &*Warning*&: The &"percent hack"& has often been abused by people who are
15287 trying to get round relaying restrictions. For this reason, it is best avoided
15288 if at all possible. Unfortunately, a number of less security-conscious MTAs
15289 implement it unconditionally. If you are running Exim on a gateway host, and
15290 routing mail through to internal MTAs without processing the local parts, it is
15291 a good idea to reject recipient addresses with percent characters in their
15292 local parts. Exim's default configuration does this.
15293
15294
15295 .option perl_at_start main boolean false
15296 This option is available only when Exim is built with an embedded Perl
15297 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15298
15299
15300 .option perl_startup main string unset
15301 This option is available only when Exim is built with an embedded Perl
15302 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15303
15304
15305 .option pgsql_servers main "string list" unset
15306 .cindex "PostgreSQL lookup type" "server list"
15307 This option provides a list of PostgreSQL servers and associated connection
15308 data, to be used in conjunction with &(pgsql)& lookups (see section
15309 &<<SECID72>>&). The option is available only if Exim has been built with
15310 PostgreSQL support.
15311
15312
15313 .option pid_file_path main string&!! "set at compile time"
15314 .cindex "daemon" "pid file path"
15315 .cindex "pid file, path for"
15316 This option sets the name of the file to which the Exim daemon writes its
15317 process id. The string is expanded, so it can contain, for example, references
15318 to the host name:
15319 .code
15320 pid_file_path = /var/log/$primary_hostname/exim.pid
15321 .endd
15322 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15323 spool directory.
15324 The value set by the option can be overridden by the &%-oP%& command line
15325 option. A pid file is not written if a &"non-standard"& daemon is run by means
15326 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15327
15328
15329 .option pipelining_advertise_hosts main "host list&!!" *
15330 .cindex "PIPELINING" "suppressing advertising"
15331 This option can be used to suppress the advertisement of the SMTP
15332 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15333 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15334 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15335 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15336 that clients will use it; &"out of order"& commands that are &"expected"& do
15337 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15338
15339
15340 .option prdr_enable main boolean false
15341 .cindex "PRDR" "enabling on server"
15342 This option can be used to enable the Per-Recipient Data Response extension
15343 to SMTP, defined by Eric Hall.
15344 If the option is set, PRDR is advertised by Exim when operating as a server.
15345 If the client requests PRDR, and more than one recipient, for a message 
15346 an additional ACL is called for each recipient after the message content
15347 is recieved.  See section &<<SECTPRDRACL>>&.
15348
15349 .option preserve_message_logs main boolean false
15350 .cindex "message logs" "preserving"
15351 If this option is set, message log files are not deleted when messages are
15352 completed. Instead, they are moved to a sub-directory of the spool directory
15353 called &_msglog.OLD_&, where they remain available for statistical or debugging
15354 purposes. This is a dangerous option to set on systems with any appreciable
15355 volume of mail. Use with care!
15356
15357
15358 .option primary_hostname main string "see below"
15359 .cindex "name" "of local host"
15360 .cindex "host" "name of local"
15361 .cindex "local host" "name of"
15362 .vindex "&$primary_hostname$&"
15363 This specifies the name of the current host. It is used in the default EHLO or
15364 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15365 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15366 The value is also used by default in some SMTP response messages from an Exim
15367 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15368
15369 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15370 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15371 contains only one component, Exim passes it to &[gethostbyname()]& (or
15372 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15373 version. The variable &$primary_hostname$& contains the host name, whether set
15374 explicitly by this option, or defaulted.
15375
15376
15377 .option print_topbitchars main boolean false
15378 .cindex "printing characters"
15379 .cindex "8-bit characters"
15380 By default, Exim considers only those characters whose codes lie in the range
15381 32&--126 to be printing characters. In a number of circumstances (for example,
15382 when writing log entries) non-printing characters are converted into escape
15383 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15384 is set, code values of 128 and above are also considered to be printing
15385 characters.
15386
15387 This option also affects the header syntax checks performed by the
15388 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15389 the user's full name when constructing From: and Sender: addresses (as
15390 described in section &<<SECTconstr>>&). Setting this option can cause
15391 Exim to generate eight bit message headers that do not conform to the
15392 standards.
15393
15394
15395 .option process_log_path main string unset
15396 .cindex "process log path"
15397 .cindex "log" "process log"
15398 .cindex "&'exiwhat'&"
15399 This option sets the name of the file to which an Exim process writes its
15400 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15401 utility script. If this option is unset, the file called &_exim-process.info_&
15402 in Exim's spool directory is used. The ability to specify the name explicitly
15403 can be useful in environments where two different Exims are running, using
15404 different spool directories.
15405
15406
15407 .option prod_requires_admin main boolean true
15408 .oindex "&%-M%&"
15409 .oindex "&%-R%&"
15410 .oindex "&%-q%&"
15411 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15412 admin user unless &%prod_requires_admin%& is set false. See also
15413 &%queue_list_requires_admin%&.
15414
15415
15416 .option qualify_domain main string "see below"
15417 .cindex "domain" "for qualifying addresses"
15418 .cindex "address" "qualification"
15419 This option specifies the domain name that is added to any envelope sender
15420 addresses that do not have a domain qualification. It also applies to
15421 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15422 are accepted by default only for locally-generated messages. Qualification is
15423 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15424 locally-generated messages, unless the &%-bnq%& command line option is used.
15425
15426 Messages from external sources must always contain fully qualified addresses,
15427 unless the sending host matches &%sender_unqualified_hosts%& or
15428 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15429 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15430 necessary. Internally, Exim always works with fully qualified envelope
15431 addresses. If &%qualify_domain%& is not set, it defaults to the
15432 &%primary_hostname%& value.
15433
15434
15435 .option qualify_recipient main string "see below"
15436 This option allows you to specify a different domain for qualifying recipient
15437 addresses to the one that is used for senders. See &%qualify_domain%& above.
15438
15439
15440
15441 .option queue_domains main "domain list&!!" unset
15442 .cindex "domain" "specifying non-immediate delivery"
15443 .cindex "queueing incoming messages"
15444 .cindex "message" "queueing certain domains"
15445 This option lists domains for which immediate delivery is not required.
15446 A delivery process is started whenever a message is received, but only those
15447 domains that do not match are processed. All other deliveries wait until the
15448 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15449
15450
15451 .option queue_list_requires_admin main boolean true
15452 .oindex "&%-bp%&"
15453 The &%-bp%& command-line option, which lists the messages that are on the
15454 queue, requires the caller to be an admin user unless
15455 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15456
15457
15458 .option queue_only main boolean false
15459 .cindex "queueing incoming messages"
15460 .cindex "message" "queueing unconditionally"
15461 If &%queue_only%& is set, a delivery process is not automatically started
15462 whenever a message is received. Instead, the message waits on the queue for the
15463 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15464 delivered immediately when certain conditions (such as heavy load) occur.
15465
15466 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15467 and &%-odi%& command line options override &%queue_only%& unless
15468 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15469 &%queue_only_load%&, and &%smtp_accept_queue%&.
15470
15471
15472 .option queue_only_file main string unset
15473 .cindex "queueing incoming messages"
15474 .cindex "message" "queueing by file existence"
15475 This option can be set to a colon-separated list of absolute path names, each
15476 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15477 it tests for the existence of each listed path using a call to &[stat()]&. For
15478 each path that exists, the corresponding queueing option is set.
15479 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15480 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15481 .code
15482 queue_only_file = smtp/some/file
15483 .endd
15484 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15485 &_/some/file_& exists.
15486
15487
15488 .option queue_only_load main fixed-point unset
15489 .cindex "load average"
15490 .cindex "queueing incoming messages"
15491 .cindex "message" "queueing by load"
15492 If the system load average is higher than this value, incoming messages from
15493 all sources are queued, and no automatic deliveries are started. If this
15494 happens during local or remote SMTP input, all subsequent messages received on
15495 the same SMTP connection are queued by default, whatever happens to the load in
15496 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15497 false.
15498
15499 Deliveries will subsequently be performed by queue runner processes. This
15500 option has no effect on ancient operating systems on which Exim cannot
15501 determine the load average. See also &%deliver_queue_load_max%& and
15502 &%smtp_load_reserve%&.
15503
15504
15505 .option queue_only_load_latch main boolean true
15506 .cindex "load average" "re-evaluating per message"
15507 When this option is true (the default), once one message has been queued
15508 because the load average is higher than the value set by &%queue_only_load%&,
15509 all subsequent messages received on the same SMTP connection are also queued.
15510 This is a deliberate choice; even though the load average may fall below the
15511 threshold, it doesn't seem right to deliver later messages on the same
15512 connection when not delivering earlier ones. However, there are special
15513 circumstances such as very long-lived connections from scanning appliances
15514 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15515 should be set false. This causes the value of the load average to be
15516 re-evaluated for each message.
15517
15518
15519 .option queue_only_override main boolean true
15520 .cindex "queueing incoming messages"
15521 When this option is true, the &%-od%&&'x'& command line options override the
15522 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15523 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15524 to override; they are accepted, but ignored.
15525
15526
15527 .option queue_run_in_order main boolean false
15528 .cindex "queue runner" "processing messages in order"
15529 If this option is set, queue runs happen in order of message arrival instead of
15530 in an arbitrary order. For this to happen, a complete list of the entire queue
15531 must be set up before the deliveries start. When the queue is all held in a
15532 single directory (the default), a single list is created for both the ordered
15533 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15534 single list is not created when &%queue_run_in_order%& is false. In this case,
15535 the sub-directories are processed one at a time (in a random order), and this
15536 avoids setting up one huge list for the whole queue. Thus, setting
15537 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15538 when the queue is large, because of the extra work in setting up the single,
15539 large list. In most situations, &%queue_run_in_order%& should not be set.
15540
15541
15542
15543 .option queue_run_max main integer 5
15544 .cindex "queue runner" "maximum number of"
15545 This controls the maximum number of queue runner processes that an Exim daemon
15546 can run simultaneously. This does not mean that it starts them all at once,
15547 but rather that if the maximum number are still running when the time comes to
15548 start another one, it refrains from starting another one. This can happen with
15549 very large queues and/or very sluggish deliveries. This option does not,
15550 however, interlock with other processes, so additional queue runners can be
15551 started by other means, or by killing and restarting the daemon.
15552
15553 Setting this option to zero does not suppress queue runs; rather, it disables
15554 the limit, allowing any number of simultaneous queue runner processes to be
15555 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15556 the daemon's command line.
15557
15558 .option queue_smtp_domains main "domain list&!!" unset
15559 .cindex "queueing incoming messages"
15560 .cindex "message" "queueing remote deliveries"
15561 When this option is set, a delivery process is started whenever a message is
15562 received, routing is performed, and local deliveries take place.
15563 However, if any SMTP deliveries are required for domains that match
15564 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15565 message waits on the queue for the next queue run. Since routing of the message
15566 has taken place, Exim knows to which remote hosts it must be delivered, and so
15567 when the queue run happens, multiple messages for the same host are delivered
15568 over a single SMTP connection. The &%-odqs%& command line option causes all
15569 SMTP deliveries to be queued in this way, and is equivalent to setting
15570 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15571 &%queue_domains%&.
15572
15573
15574 .option receive_timeout main time 0s
15575 .cindex "timeout" "for non-SMTP input"
15576 This option sets the timeout for accepting a non-SMTP message, that is, the
15577 maximum time that Exim waits when reading a message on the standard input. If
15578 the value is zero, it will wait for ever. This setting is overridden by the
15579 &%-or%& command line option. The timeout for incoming SMTP messages is
15580 controlled by &%smtp_receive_timeout%&.
15581
15582 .option received_header_text main string&!! "see below"
15583 .cindex "customizing" "&'Received:'& header"
15584 .cindex "&'Received:'& header line" "customizing"
15585 This string defines the contents of the &'Received:'& message header that is
15586 added to each message, except for the timestamp, which is automatically added
15587 on at the end (preceded by a semicolon). The string is expanded each time it is
15588 used. If the expansion yields an empty string, no &'Received:'& header line is
15589 added to the message. Otherwise, the string should start with the text
15590 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15591 header lines. The default setting is:
15592
15593 .code
15594 received_header_text = Received: \
15595   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15596   {${if def:sender_ident \
15597   {from ${quote_local_part:$sender_ident} }}\
15598   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15599   by $primary_hostname \
15600   ${if def:received_protocol {with $received_protocol}} \
15601   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15602   (Exim $version_number)\n\t\
15603   ${if def:sender_address \
15604   {(envelope-from <$sender_address>)\n\t}}\
15605   id $message_exim_id\
15606   ${if def:received_for {\n\tfor $received_for}}
15607 .endd
15608
15609 The reference to the TLS cipher is omitted when Exim is built without TLS
15610 support. The use of conditional expansions ensures that this works for both
15611 locally generated messages and messages received from remote hosts, giving
15612 header lines such as the following:
15613 .code
15614 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15615 by marley.carol.example with esmtp (Exim 4.00)
15616 (envelope-from <bob@carol.example>)
15617 id 16IOWa-00019l-00
15618 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15619 Received: by scrooge.carol.example with local (Exim 4.00)
15620 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15621 .endd
15622 Until the body of the message has been received, the timestamp is the time when
15623 the message started to be received. Once the body has arrived, and all policy
15624 checks have taken place, the timestamp is updated to the time at which the
15625 message was accepted.
15626
15627
15628 .option received_headers_max main integer 30
15629 .cindex "loop" "prevention"
15630 .cindex "mail loop prevention"
15631 .cindex "&'Received:'& header line" "counting"
15632 When a message is to be delivered, the number of &'Received:'& headers is
15633 counted, and if it is greater than this parameter, a mail loop is assumed to
15634 have occurred, the delivery is abandoned, and an error message is generated.
15635 This applies to both local and remote deliveries.
15636
15637
15638 .option recipient_unqualified_hosts main "host list&!!" unset
15639 .cindex "unqualified addresses"
15640 .cindex "host" "unqualified addresses from"
15641 This option lists those hosts from which Exim is prepared to accept unqualified
15642 recipient addresses in message envelopes. The addresses are made fully
15643 qualified by the addition of the &%qualify_recipient%& value. This option also
15644 affects message header lines. Exim does not reject unqualified recipient
15645 addresses in headers, but it qualifies them only if the message came from a
15646 host that matches &%recipient_unqualified_hosts%&,
15647 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15648 option was not set.
15649
15650
15651 .option recipients_max main integer 0
15652 .cindex "limit" "number of recipients"
15653 .cindex "recipient" "maximum number"
15654 If this option is set greater than zero, it specifies the maximum number of
15655 original recipients for any message. Additional recipients that are generated
15656 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15657 all recipients over the limit; earlier recipients are delivered as normal.
15658 Non-SMTP messages with too many recipients are failed, and no deliveries are
15659 done.
15660
15661 .cindex "RCPT" "maximum number of incoming"
15662 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15663 RCPT commands in a single message.
15664
15665
15666 .option recipients_max_reject main boolean false
15667 If this option is set true, Exim rejects SMTP messages containing too many
15668 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15669 error to the eventual DATA command. Otherwise (the default) it gives a 452
15670 error to the surplus RCPT commands and accepts the message on behalf of the
15671 initial set of recipients. The remote server should then re-send the message
15672 for the remaining recipients at a later time.
15673
15674
15675 .option remote_max_parallel main integer 2
15676 .cindex "delivery" "parallelism for remote"
15677 This option controls parallel delivery of one message to a number of remote
15678 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15679 does all the remote deliveries for a message one by one. Otherwise, if a single
15680 message has to be delivered to more than one remote host, or if several copies
15681 have to be sent to the same remote host, up to &%remote_max_parallel%&
15682 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15683 deliveries are required, the maximum number of processes are started, and as
15684 each one finishes, another is begun. The order of starting processes is the
15685 same as if sequential delivery were being done, and can be controlled by the
15686 &%remote_sort_domains%& option. If parallel delivery takes place while running
15687 with debugging turned on, the debugging output from each delivery process is
15688 tagged with its process id.
15689
15690 This option controls only the maximum number of parallel deliveries for one
15691 message in one Exim delivery process. Because Exim has no central queue
15692 manager, there is no way of controlling the total number of simultaneous
15693 deliveries if the configuration allows a delivery attempt as soon as a message
15694 is received.
15695
15696 .cindex "number of deliveries"
15697 .cindex "delivery" "maximum number of"
15698 If you want to control the total number of deliveries on the system, you
15699 need to set the &%queue_only%& option. This ensures that all incoming messages
15700 are added to the queue without starting a delivery process. Then set up an Exim
15701 daemon to start queue runner processes at appropriate intervals (probably
15702 fairly often, for example, every minute), and limit the total number of queue
15703 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15704 delivers only one message at a time, the maximum number of deliveries that can
15705 then take place at once is &%queue_run_max%& multiplied by
15706 &%remote_max_parallel%&.
15707
15708 If it is purely remote deliveries you want to control, use
15709 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15710 doing the SMTP routing before queueing, so that several messages for the same
15711 host will eventually get delivered down the same connection.
15712
15713
15714 .option remote_sort_domains main "domain list&!!" unset
15715 .cindex "sorting remote deliveries"
15716 .cindex "delivery" "sorting remote"
15717 When there are a number of remote deliveries for a message, they are sorted by
15718 domain into the order given by this list. For example,
15719 .code
15720 remote_sort_domains = *.cam.ac.uk:*.uk
15721 .endd
15722 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15723 then to those in the &%uk%& domain, then to any others.
15724
15725
15726 .option retry_data_expire main time 7d
15727 .cindex "hints database" "data expiry"
15728 This option sets a &"use before"& time on retry information in Exim's hints
15729 database. Any older retry data is ignored. This means that, for example, once a
15730 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15731 past failures.
15732
15733
15734 .option retry_interval_max main time 24h
15735 .cindex "retry" "limit on interval"
15736 .cindex "limit" "on retry interval"
15737 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15738 intervals between delivery attempts for messages that cannot be delivered
15739 straight away. This option sets an overall limit to the length of time between
15740 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15741 the default value.
15742
15743
15744 .option return_path_remove main boolean true
15745 .cindex "&'Return-path:'& header line" "removing"
15746 RFC 2821, section 4.4, states that an SMTP server must insert a
15747 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15748 The &'Return-path:'& header preserves the sender address as received in the
15749 MAIL command. This description implies that this header should not be present
15750 in an incoming message. If &%return_path_remove%& is true, any existing
15751 &'Return-path:'& headers are removed from messages at the time they are
15752 received. Exim's transports have options for adding &'Return-path:'& headers at
15753 the time of delivery. They are normally used only for final local deliveries.
15754
15755
15756 .option return_size_limit main integer 100K
15757 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15758
15759
15760 .new
15761 .option rfc1413_hosts main "host list&!!" @[]
15762 .cindex "RFC 1413"
15763 .cindex "host" "for RFC 1413 calls"
15764 RFC 1413 identification calls are made to any client host which matches
15765 an item in the list.
15766 The default value specifies just this host, being any local interface
15767 for the system.
15768 .wen
15769
15770 .new
15771 .option rfc1413_query_timeout main time 0s
15772 .wen
15773 .cindex "RFC 1413" "query timeout"
15774 .cindex "timeout" "for RFC 1413 call"
15775 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15776 no RFC 1413 calls are ever made.
15777
15778
15779 .option sender_unqualified_hosts main "host list&!!" unset
15780 .cindex "unqualified addresses"
15781 .cindex "host" "unqualified addresses from"
15782 This option lists those hosts from which Exim is prepared to accept unqualified
15783 sender addresses. The addresses are made fully qualified by the addition of
15784 &%qualify_domain%&. This option also affects message header lines. Exim does
15785 not reject unqualified addresses in headers that contain sender addresses, but
15786 it qualifies them only if the message came from a host that matches
15787 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15788 using TCP/IP), and the &%-bnq%& option was not set.
15789
15790
15791 .option slow_lookup_log main integer 0
15792 .cindex "logging" "slow lookups"
15793 .cindex "dns" "logging slow lookups"
15794 This option controls logging of slow lookups.
15795 If the value is nonzero it is taken as a number of milliseconds
15796 and lookups taking longer than this are logged.
15797 Currently this applies only to DNS lookups.
15798
15799
15800
15801 .option smtp_accept_keepalive main boolean true
15802 .cindex "keepalive" "on incoming connection"
15803 This option controls the setting of the SO_KEEPALIVE option on incoming
15804 TCP/IP socket connections. When set, it causes the kernel to probe idle
15805 connections periodically, by sending packets with &"old"& sequence numbers. The
15806 other end of the connection should send an acknowledgment if the connection is
15807 still okay or a reset if the connection has been aborted. The reason for doing
15808 this is that it has the beneficial effect of freeing up certain types of
15809 connection that can get stuck when the remote host is disconnected without
15810 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15811 hours to detect unreachable hosts.
15812
15813
15814
15815 .option smtp_accept_max main integer 20
15816 .cindex "limit" "incoming SMTP connections"
15817 .cindex "SMTP" "incoming connection count"
15818 .cindex "inetd"
15819 This option specifies the maximum number of simultaneous incoming SMTP calls
15820 that Exim will accept. It applies only to the listening daemon; there is no
15821 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15822 value is set to zero, no limit is applied. However, it is required to be
15823 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15824 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15825
15826 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15827 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15828 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15829 and &%smtp_load_reserve%& are then checked before accepting the connection.
15830
15831
15832 .option smtp_accept_max_nonmail main integer 10
15833 .cindex "limit" "non-mail SMTP commands"
15834 .cindex "SMTP" "limiting non-mail commands"
15835 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15836 the connection if there are too many. This option defines &"too many"&. The
15837 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15838 client looping sending EHLO, for example. The check is applied only if the
15839 client host matches &%smtp_accept_max_nonmail_hosts%&.
15840
15841 When a new message is expected, one occurrence of RSET is not counted. This
15842 allows a client to send one RSET between messages (this is not necessary,
15843 but some clients do it). Exim also allows one uncounted occurrence of HELO
15844 or EHLO, and one occurrence of STARTTLS between messages. After
15845 starting up a TLS session, another EHLO is expected, and so it too is not
15846 counted. The first occurrence of AUTH in a connection, or immediately
15847 following STARTTLS is not counted. Otherwise, all commands other than
15848 MAIL, RCPT, DATA, and QUIT are counted.
15849
15850
15851 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15852 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15853 check by setting this option. The default value makes it apply to all hosts. By
15854 changing the value, you can exclude any badly-behaved hosts that you have to
15855 live with.
15856
15857
15858 . Allow this long option name to split; give it unsplit as a fifth argument
15859 . for the automatic .oindex that is generated by .option.
15860 . We insert " &~&~" which is both pretty nasty visually and results in
15861 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15862 . zero-width-space, which would be nicer visually and results in (at least)
15863 . html that Firefox will split on when it's forced to reflow (rather than
15864 . inserting a horizontal scrollbar).  However, the text is still not
15865 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15866 . the option name to split.
15867
15868 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15869          smtp_accept_max_per_connection
15870 .cindex "SMTP" "limiting incoming message count"
15871 .cindex "limit" "messages per SMTP connection"
15872 The value of this option limits the number of MAIL commands that Exim is
15873 prepared to accept over a single SMTP connection, whether or not each command
15874 results in the transfer of a message. After the limit is reached, a 421
15875 response is given to subsequent MAIL commands. This limit is a safety
15876 precaution against a client that goes mad (incidents of this type have been
15877 seen).
15878
15879
15880 .option smtp_accept_max_per_host main string&!! unset
15881 .cindex "limit" "SMTP connections from one host"
15882 .cindex "host" "limiting SMTP connections from"
15883 This option restricts the number of simultaneous IP connections from a single
15884 host (strictly, from a single IP address) to the Exim daemon. The option is
15885 expanded, to enable different limits to be applied to different hosts by
15886 reference to &$sender_host_address$&. Once the limit is reached, additional
15887 connection attempts from the same host are rejected with error code 421. This
15888 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15889 of zero imposes no limit. If this option is set greater than zero, it is
15890 required that &%smtp_accept_max%& be non-zero.
15891
15892 &*Warning*&: When setting this option you should not use any expansion
15893 constructions that take an appreciable amount of time. The expansion and test
15894 happen in the main daemon loop, in order to reject additional connections
15895 without forking additional processes (otherwise a denial-of-service attack
15896 could cause a vast number or processes to be created). While the daemon is
15897 doing this processing, it cannot accept any other incoming connections.
15898
15899
15900
15901 .option smtp_accept_queue main integer 0
15902 .cindex "SMTP" "incoming connection count"
15903 .cindex "queueing incoming messages"
15904 .cindex "message" "queueing by SMTP connection count"
15905 If the number of simultaneous incoming SMTP connections being handled via the
15906 listening daemon exceeds this value, messages received by SMTP are just placed
15907 on the queue; no delivery processes are started automatically. The count is
15908 fixed at the start of an SMTP connection. It cannot be updated in the
15909 subprocess that receives messages, and so the queueing or not queueing applies
15910 to all messages received in the same connection.
15911
15912 A value of zero implies no limit, and clearly any non-zero value is useful only
15913 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15914 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15915 various &%-od%&&'x'& command line options.
15916
15917
15918 . See the comment on smtp_accept_max_per_connection
15919
15920 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15921          smtp_accept_queue_per_connection
15922 .cindex "queueing incoming messages"
15923 .cindex "message" "queueing by message count"
15924 This option limits the number of delivery processes that Exim starts
15925 automatically when receiving messages via SMTP, whether via the daemon or by
15926 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15927 and the number of messages received in a single SMTP session exceeds this
15928 number, subsequent messages are placed on the queue, but no delivery processes
15929 are started. This helps to limit the number of Exim processes when a server
15930 restarts after downtime and there is a lot of mail waiting for it on other
15931 systems. On large systems, the default should probably be increased, and on
15932 dial-in client systems it should probably be set to zero (that is, disabled).
15933
15934
15935 .option smtp_accept_reserve main integer 0
15936 .cindex "SMTP" "incoming call count"
15937 .cindex "host" "reserved"
15938 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15939 number of SMTP connections that are reserved for connections from the hosts
15940 that are specified in &%smtp_reserve_hosts%&. The value set in
15941 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15942 restricted to this number of connections; the option specifies a minimum number
15943 of connection slots for them, not a maximum. It is a guarantee that this group
15944 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15945 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15946 individual host.
15947
15948 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15949 set to 5, once there are 45 active connections (from any hosts), new
15950 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15951 provided the other criteria for acceptance are met.
15952
15953
15954 .option smtp_active_hostname main string&!! unset
15955 .cindex "host" "name in SMTP responses"
15956 .cindex "SMTP" "host name in responses"
15957 .vindex "&$primary_hostname$&"
15958 This option is provided for multi-homed servers that want to masquerade as
15959 several different hosts. At the start of an incoming SMTP connection, its value
15960 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15961 responses. For example, it is used as domain name in the response to an
15962 incoming HELO or EHLO command.
15963
15964 .vindex "&$smtp_active_hostname$&"
15965 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15966 is saved with any messages that are received. It is therefore available for use
15967 in routers and transports when the message is later delivered.
15968
15969 If this option is unset, or if its expansion is forced to fail, or if the
15970 expansion results in an empty string, the value of &$primary_hostname$& is
15971 used. Other expansion failures cause a message to be written to the main and
15972 panic logs, and the SMTP command receives a temporary error. Typically, the
15973 value of &%smtp_active_hostname%& depends on the incoming interface address.
15974 For example:
15975 .code
15976 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15977   {cox.mydomain}{box.mydomain}}
15978 .endd
15979
15980 Although &$smtp_active_hostname$& is primarily concerned with incoming
15981 messages, it is also used as the default for HELO commands in callout
15982 verification if there is no remote transport from which to obtain a
15983 &%helo_data%& value.
15984
15985 .option smtp_banner main string&!! "see below"
15986 .cindex "SMTP" "welcome banner"
15987 .cindex "banner for SMTP"
15988 .cindex "welcome banner for SMTP"
15989 .cindex "customizing" "SMTP banner"
15990 This string, which is expanded every time it is used, is output as the initial
15991 positive response to an SMTP connection. The default setting is:
15992 .code
15993 smtp_banner = $smtp_active_hostname ESMTP Exim \
15994   $version_number $tod_full
15995 .endd
15996 Failure to expand the string causes a panic error. If you want to create a
15997 multiline response to the initial SMTP connection, use &"\n"& in the string at
15998 appropriate points, but not at the end. Note that the 220 code is not included
15999 in this string. Exim adds it automatically (several times in the case of a
16000 multiline response).
16001
16002
16003 .option smtp_check_spool_space main boolean true
16004 .cindex "checking disk space"
16005 .cindex "disk space, checking"
16006 .cindex "spool directory" "checking space"
16007 When this option is set, if an incoming SMTP session encounters the SIZE
16008 option on a MAIL command, it checks that there is enough space in the
16009 spool directory's partition to accept a message of that size, while still
16010 leaving free the amount specified by &%check_spool_space%& (even if that value
16011 is zero). If there isn't enough space, a temporary error code is returned.
16012
16013
16014 .option smtp_connect_backlog main integer 20
16015 .cindex "connection backlog"
16016 .cindex "SMTP" "connection backlog"
16017 .cindex "backlog of connections"
16018 This option specifies a maximum number of waiting SMTP connections. Exim passes
16019 this value to the TCP/IP system when it sets up its listener. Once this number
16020 of connections are waiting for the daemon's attention, subsequent connection
16021 attempts are refused at the TCP/IP level. At least, that is what the manuals
16022 say; in some circumstances such connection attempts have been observed to time
16023 out instead. For large systems it is probably a good idea to increase the
16024 value (to 50, say). It also gives some protection against denial-of-service
16025 attacks by SYN flooding.
16026
16027
16028 .option smtp_enforce_sync main boolean true
16029 .cindex "SMTP" "synchronization checking"
16030 .cindex "synchronization checking in SMTP"
16031 The SMTP protocol specification requires the client to wait for a response from
16032 the server at certain points in the dialogue. Without PIPELINING these
16033 synchronization points are after every command; with PIPELINING they are
16034 fewer, but they still exist.
16035
16036 Some spamming sites send out a complete set of SMTP commands without waiting
16037 for any response. Exim protects against this by rejecting a message if the
16038 client has sent further input when it should not have. The error response &"554
16039 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16040 for this error cannot be perfect because of transmission delays (unexpected
16041 input may be on its way but not yet received when Exim checks). However, it
16042 does detect many instances.
16043
16044 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16045 If you want to disable the check selectively (for example, only for certain
16046 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16047 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16048
16049
16050
16051 .option smtp_etrn_command main string&!! unset
16052 .cindex "ETRN" "command to be run"
16053 .vindex "&$domain$&"
16054 If this option is set, the given command is run whenever an SMTP ETRN
16055 command is received from a host that is permitted to issue such commands (see
16056 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16057 are independently expanded. The expansion variable &$domain$& is set to the
16058 argument of the ETRN command, and no syntax checking is done on it. For
16059 example:
16060 .code
16061 smtp_etrn_command = /etc/etrn_command $domain \
16062                     $sender_host_address
16063 .endd
16064 A new process is created to run the command, but Exim does not wait for it to
16065 complete. Consequently, its status cannot be checked. If the command cannot be
16066 run, a line is written to the panic log, but the ETRN caller still receives
16067 a 250 success response. Exim is normally running under its own uid when
16068 receiving SMTP, so it is not possible for it to change the uid before running
16069 the command.
16070
16071
16072 .option smtp_etrn_serialize main boolean true
16073 .cindex "ETRN" "serializing"
16074 When this option is set, it prevents the simultaneous execution of more than
16075 one identical command as a result of ETRN in an SMTP connection. See
16076 section &<<SECTETRN>>& for details.
16077
16078
16079 .option smtp_load_reserve main fixed-point unset
16080 .cindex "load average"
16081 If the system load average ever gets higher than this, incoming SMTP calls are
16082 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16083 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16084 the load is over the limit. The option has no effect on ancient operating
16085 systems on which Exim cannot determine the load average. See also
16086 &%deliver_queue_load_max%& and &%queue_only_load%&.
16087
16088
16089
16090 .option smtp_max_synprot_errors main integer 3
16091 .cindex "SMTP" "limiting syntax and protocol errors"
16092 .cindex "limit" "SMTP syntax and protocol errors"
16093 Exim rejects SMTP commands that contain syntax or protocol errors. In
16094 particular, a syntactically invalid email address, as in this command:
16095 .code
16096 RCPT TO:<abc xyz@a.b.c>
16097 .endd
16098 causes immediate rejection of the command, before any other tests are done.
16099 (The ACL cannot be run if there is no valid address to set up for it.) An
16100 example of a protocol error is receiving RCPT before MAIL. If there are
16101 too many syntax or protocol errors in one SMTP session, the connection is
16102 dropped. The limit is set by this option.
16103
16104 .cindex "PIPELINING" "expected errors"
16105 When the PIPELINING extension to SMTP is in use, some protocol errors are
16106 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16107 Exim assumes that PIPELINING will be used if it advertises it (see
16108 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16109 not count towards the limit.
16110
16111
16112
16113 .option smtp_max_unknown_commands main integer 3
16114 .cindex "SMTP" "limiting unknown commands"
16115 .cindex "limit" "unknown SMTP commands"
16116 If there are too many unrecognized commands in an incoming SMTP session, an
16117 Exim server drops the connection. This is a defence against some kinds of abuse
16118 that subvert web
16119 clients
16120 into making connections to SMTP ports; in these circumstances, a number of
16121 non-SMTP command lines are sent first.
16122
16123
16124
16125 .option smtp_ratelimit_hosts main "host list&!!" unset
16126 .cindex "SMTP" "rate limiting"
16127 .cindex "limit" "rate of message arrival"
16128 .cindex "RCPT" "rate limiting"
16129 Some sites find it helpful to be able to limit the rate at which certain hosts
16130 can send them messages, and the rate at which an individual message can specify
16131 recipients.
16132
16133 Exim has two rate-limiting facilities. This section describes the older
16134 facility, which can limit rates within a single connection. The newer
16135 &%ratelimit%& ACL condition can limit rates across all connections. See section
16136 &<<SECTratelimiting>>& for details of the newer facility.
16137
16138 When a host matches &%smtp_ratelimit_hosts%&, the values of
16139 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16140 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16141 respectively. Each option, if set, must contain a set of four comma-separated
16142 values:
16143
16144 .ilist
16145 A threshold, before which there is no rate limiting.
16146 .next
16147 An initial time delay. Unlike other times in Exim, numbers with decimal
16148 fractional parts are allowed here.
16149 .next
16150 A factor by which to increase the delay each time.
16151 .next
16152 A maximum value for the delay. This should normally be less than 5 minutes,
16153 because after that time, the client is liable to timeout the SMTP command.
16154 .endlist
16155
16156 For example, these settings have been used successfully at the site which
16157 first suggested this feature, for controlling mail from their customers:
16158 .code
16159 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16160 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16161 .endd
16162 The first setting specifies delays that are applied to MAIL commands after
16163 two have been received over a single connection. The initial delay is 0.5
16164 seconds, increasing by a factor of 1.05 each time. The second setting applies
16165 delays to RCPT commands when more than four occur in a single message.
16166
16167
16168 .option smtp_ratelimit_mail main string unset
16169 See &%smtp_ratelimit_hosts%& above.
16170
16171
16172 .option smtp_ratelimit_rcpt main string unset
16173 See &%smtp_ratelimit_hosts%& above.
16174
16175
16176 .option smtp_receive_timeout main time&!! 5m
16177 .cindex "timeout" "for SMTP input"
16178 .cindex "SMTP" "input timeout"
16179 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16180 input, including batch SMTP. If a line of input (either an SMTP command or a
16181 data line) is not received within this time, the SMTP connection is dropped and
16182 the message is abandoned.
16183 A line is written to the log containing one of the following messages:
16184 .code
16185 SMTP command timeout on connection from...
16186 SMTP data timeout on connection from...
16187 .endd
16188 The former means that Exim was expecting to read an SMTP command; the latter
16189 means that it was in the DATA phase, reading the contents of a message.
16190
16191 If the first character of the option is a &"$"& the option is
16192 expanded before use and may depend on
16193 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16194
16195
16196 .oindex "&%-os%&"
16197 The value set by this option can be overridden by the
16198 &%-os%& command-line option. A setting of zero time disables the timeout, but
16199 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16200 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16201 timeout is controlled by &%receive_timeout%& and &%-or%&.
16202
16203
16204 .option smtp_reserve_hosts main "host list&!!" unset
16205 This option defines hosts for which SMTP connections are reserved; see
16206 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16207
16208
16209 .option smtp_return_error_details main boolean false
16210 .cindex "SMTP" "details policy failures"
16211 .cindex "policy control" "rejection, returning details"
16212 In the default state, Exim uses bland messages such as
16213 &"Administrative prohibition"& when it rejects SMTP commands for policy
16214 reasons. Many sysadmins like this because it gives away little information
16215 to spammers. However, some other sysadmins who are applying strict checking
16216 policies want to give out much fuller information about failures. Setting
16217 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16218 example, instead of &"Administrative prohibition"&, it might give:
16219 .code
16220 550-Rejected after DATA: '>' missing at end of address:
16221 550 failing address in "From" header is: <user@dom.ain
16222 .endd
16223
16224 .option spamd_address main string "see below"
16225 This option is available when Exim is compiled with the content-scanning
16226 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16227 The default value is
16228 .code
16229 127.0.0.1 783
16230 .endd
16231 See section &<<SECTscanspamass>>& for more details.
16232
16233
16234
16235 .option split_spool_directory main boolean false
16236 .cindex "multiple spool directories"
16237 .cindex "spool directory" "split"
16238 .cindex "directories, multiple"
16239 If this option is set, it causes Exim to split its input directory into 62
16240 subdirectories, each with a single alphanumeric character as its name. The
16241 sixth character of the message id is used to allocate messages to
16242 subdirectories; this is the least significant base-62 digit of the time of
16243 arrival of the message.
16244
16245 Splitting up the spool in this way may provide better performance on systems
16246 where there are long mail queues, by reducing the number of files in any one
16247 directory. The msglog directory is also split up in a similar way to the input
16248 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16249 are still placed in the single directory &_msglog.OLD_&.
16250
16251 It is not necessary to take any special action for existing messages when
16252 changing &%split_spool_directory%&. Exim notices messages that are in the
16253 &"wrong"& place, and continues to process them. If the option is turned off
16254 after a period of being on, the subdirectories will eventually empty and be
16255 automatically deleted.
16256
16257 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16258 changes. Instead of creating a list of all messages in the queue, and then
16259 trying to deliver each one in turn, it constructs a list of those in one
16260 sub-directory and tries to deliver them, before moving on to the next
16261 sub-directory. The sub-directories are processed in a random order. This
16262 spreads out the scanning of the input directories, and uses less memory. It is
16263 particularly beneficial when there are lots of messages on the queue. However,
16264 if &%queue_run_in_order%& is set, none of this new processing happens. The
16265 entire queue has to be scanned and sorted before any deliveries can start.
16266
16267
16268 .option spool_directory main string&!! "set at compile time"
16269 .cindex "spool directory" "path to"
16270 This defines the directory in which Exim keeps its spool, that is, the messages
16271 it is waiting to deliver. The default value is taken from the compile-time
16272 configuration setting, if there is one. If not, this option must be set. The
16273 string is expanded, so it can contain, for example, a reference to
16274 &$primary_hostname$&.
16275
16276 If the spool directory name is fixed on your installation, it is recommended
16277 that you set it at build time rather than from this option, particularly if the
16278 log files are being written to the spool directory (see &%log_file_path%&).
16279 Otherwise log files cannot be used for errors that are detected early on, such
16280 as failures in the configuration file.
16281
16282 By using this option to override the compiled-in path, it is possible to run
16283 tests of Exim without using the standard spool.
16284
16285 .option sqlite_lock_timeout main time 5s
16286 .cindex "sqlite lookup type" "lock timeout"
16287 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16288 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16289
16290 .option strict_acl_vars main boolean false
16291 .cindex "&ACL;" "variables, handling unset"
16292 This option controls what happens if a syntactically valid but undefined ACL
16293 variable is referenced. If it is false (the default), an empty string
16294 is substituted; if it is true, an error is generated. See section
16295 &<<SECTaclvariables>>& for details of ACL variables.
16296
16297 .option strip_excess_angle_brackets main boolean false
16298 .cindex "angle brackets, excess"
16299 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16300 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16301 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16302 passed on to another MTA, the excess angle brackets are not passed on. If this
16303 option is not set, multiple pairs of angle brackets cause a syntax error.
16304
16305
16306 .option strip_trailing_dot main boolean false
16307 .cindex "trailing dot on domain"
16308 .cindex "dot" "trailing on domain"
16309 If this option is set, a trailing dot at the end of a domain in an address is
16310 ignored. If this is in the envelope and the message is passed on to another
16311 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16312 domain causes a syntax error.
16313 However, addresses in header lines are checked only when an ACL requests header
16314 syntax checking.
16315
16316
16317 .option syslog_duplication main boolean true
16318 .cindex "syslog" "duplicate log lines; suppressing"
16319 When Exim is logging to syslog, it writes the log lines for its three
16320 separate logs at different syslog priorities so that they can in principle
16321 be separated on the logging hosts. Some installations do not require this
16322 separation, and in those cases, the duplication of certain log lines is a
16323 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16324 particular log line is written to syslog. For lines that normally go to
16325 both the main log and the reject log, the reject log version (possibly
16326 containing message header lines) is written, at LOG_NOTICE priority.
16327 Lines that normally go to both the main and the panic log are written at
16328 the LOG_ALERT priority.
16329
16330
16331 .option syslog_facility main string unset
16332 .cindex "syslog" "facility; setting"
16333 This option sets the syslog &"facility"& name, used when Exim is logging to
16334 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16335 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16336 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16337 details of Exim's logging.
16338
16339
16340
16341 .option syslog_processname main string &`exim`&
16342 .cindex "syslog" "process name; setting"
16343 This option sets the syslog &"ident"& name, used when Exim is logging to
16344 syslog. The value must be no longer than 32 characters. See chapter
16345 &<<CHAPlog>>& for details of Exim's logging.
16346
16347
16348
16349 .option syslog_timestamp main boolean true
16350 .cindex "syslog" "timestamps"
16351 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16352 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16353 details of Exim's logging.
16354
16355
16356 .option system_filter main string&!! unset
16357 .cindex "filter" "system filter"
16358 .cindex "system filter" "specifying"
16359 .cindex "Sieve filter" "not available for system filter"
16360 This option specifies an Exim filter file that is applied to all messages at
16361 the start of each delivery attempt, before any routing is done. System filters
16362 must be Exim filters; they cannot be Sieve filters. If the system filter
16363 generates any deliveries to files or pipes, or any new mail messages, the
16364 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16365 which transports are to be used. Details of this facility are given in chapter
16366 &<<CHAPsystemfilter>>&.
16367
16368
16369 .option system_filter_directory_transport main string&!! unset
16370 .vindex "&$address_file$&"
16371 This sets the name of the transport driver that is to be used when the
16372 &%save%& command in a system message filter specifies a path ending in &"/"&,
16373 implying delivery of each message into a separate file in some directory.
16374 During the delivery, the variable &$address_file$& contains the path name.
16375
16376
16377 .option system_filter_file_transport main string&!! unset
16378 .cindex "file" "transport for system filter"
16379 This sets the name of the transport driver that is to be used when the &%save%&
16380 command in a system message filter specifies a path not ending in &"/"&. During
16381 the delivery, the variable &$address_file$& contains the path name.
16382
16383 .option system_filter_group main string unset
16384 .cindex "gid (group id)" "system filter"
16385 This option is used only when &%system_filter_user%& is also set. It sets the
16386 gid under which the system filter is run, overriding any gid that is associated
16387 with the user. The value may be numerical or symbolic.
16388
16389 .option system_filter_pipe_transport main string&!! unset
16390 .cindex "&(pipe)& transport" "for system filter"
16391 .vindex "&$address_pipe$&"
16392 This specifies the transport driver that is to be used when a &%pipe%& command
16393 is used in a system filter. During the delivery, the variable &$address_pipe$&
16394 contains the pipe command.
16395
16396
16397 .option system_filter_reply_transport main string&!! unset
16398 .cindex "&(autoreply)& transport" "for system filter"
16399 This specifies the transport driver that is to be used when a &%mail%& command
16400 is used in a system filter.
16401
16402
16403 .option system_filter_user main string unset
16404 .cindex "uid (user id)" "system filter"
16405 If this option is set to root, the system filter is run in the main Exim
16406 delivery process, as root.  Otherwise, the system filter runs in a separate
16407 process, as the given user, defaulting to the Exim run-time user.
16408 Unless the string consists entirely of digits, it
16409 is looked up in the password data. Failure to find the named user causes a
16410 configuration error. The gid is either taken from the password data, or
16411 specified by &%system_filter_group%&. When the uid is specified numerically,
16412 &%system_filter_group%& is required to be set.
16413
16414 If the system filter generates any pipe, file, or reply deliveries, the uid
16415 under which the filter is run is used when transporting them, unless a
16416 transport option overrides.
16417
16418
16419 .option tcp_nodelay main boolean true
16420 .cindex "daemon" "TCP_NODELAY on sockets"
16421 .cindex "Nagle algorithm"
16422 .cindex "TCP_NODELAY on listening sockets"
16423 If this option is set false, it stops the Exim daemon setting the
16424 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16425 turns off the &"Nagle algorithm"&, which is a way of improving network
16426 performance in interactive (character-by-character) situations. Turning it off
16427 should improve Exim's performance a bit, so that is what happens by default.
16428 However, it appears that some broken clients cannot cope, and time out. Hence
16429 this option. It affects only those sockets that are set up for listening by the
16430 daemon. Sockets created by the smtp transport for delivering mail always set
16431 TCP_NODELAY.
16432
16433
16434 .option timeout_frozen_after main time 0s
16435 .cindex "frozen messages" "timing out"
16436 .cindex "timeout" "frozen messages"
16437 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16438 message of any kind that has been on the queue for longer than the given time
16439 is automatically cancelled at the next queue run. If the frozen message is a
16440 bounce message, it is just discarded; otherwise, a bounce is sent to the
16441 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16442 If you want to timeout frozen bounce messages earlier than other kinds of
16443 frozen message, see &%ignore_bounce_errors_after%&.
16444
16445 &*Note:*& the default value of zero means no timeouts; with this setting,
16446 frozen messages remain on the queue forever (except for any frozen bounce
16447 messages that are released by &%ignore_bounce_errors_after%&).
16448
16449
16450 .option timezone main string unset
16451 .cindex "timezone, setting"
16452 The value of &%timezone%& is used to set the environment variable TZ while
16453 running Exim (if it is different on entry). This ensures that all timestamps
16454 created by Exim are in the required timezone. If you want all your timestamps
16455 to be in UTC (aka GMT) you should set
16456 .code
16457 timezone = UTC
16458 .endd
16459 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16460 or, if that is not set, from the value of the TZ environment variable when Exim
16461 is built. If &%timezone%& is set to the empty string, either at build or run
16462 time, any existing TZ variable is removed from the environment when Exim
16463 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16464 unfortunately not all, operating systems.
16465
16466
16467 .option tls_advertise_hosts main "host list&!!" unset
16468 .cindex "TLS" "advertising"
16469 .cindex "encryption" "on SMTP connection"
16470 .cindex "SMTP" "encrypted connection"
16471 When Exim is built with support for TLS encrypted connections, the availability
16472 of the STARTTLS command to set up an encrypted session is advertised in
16473 response to EHLO only to those client hosts that match this option. See
16474 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16475
16476
16477 .option tls_certificate main string&!! unset
16478 .cindex "TLS" "server certificate; location of"
16479 .cindex "certificate" "server, location of"
16480 The value of this option is expanded, and must then be the absolute path to a
16481 file which contains the server's certificates. The server's private key is also
16482 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16483 &<<CHAPTLS>>& for further details.
16484
16485 &*Note*&: The certificates defined by this option are used only when Exim is
16486 receiving incoming messages as a server. If you want to supply certificates for
16487 use when sending messages as a client, you must set the &%tls_certificate%&
16488 option in the relevant &(smtp)& transport.
16489
16490 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16491 if the OpenSSL build supports TLS extensions and the TLS client sends the
16492 Server Name Indication extension, then this option and others documented in
16493 &<<SECTtlssni>>& will be re-expanded.
16494
16495 .option tls_crl main string&!! unset
16496 .cindex "TLS" "server certificate revocation list"
16497 .cindex "certificate" "revocation list for server"
16498 This option specifies a certificate revocation list. The expanded value must
16499 be the name of a file that contains a CRL in PEM format.
16500
16501 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16502
16503
16504 .option tls_dh_max_bits main integer 2236
16505 .cindex "TLS" "D-H bit count"
16506 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16507 the chosen TLS library.  That value might prove to be too high for
16508 interoperability.  This option provides a maximum clamp on the value
16509 suggested, trading off security for interoperability.
16510
16511 The value must be at least 1024.
16512
16513 The value 2236 was chosen because, at time of adding the option, it was the
16514 hard-coded maximum value supported by the NSS cryptographic library, as used
16515 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16516
16517 If you prefer more security and are willing to break some clients, raise this
16518 number.
16519
16520 Note that the value passed to GnuTLS for *generating* a new prime may be a
16521 little less than this figure, because GnuTLS is inexact and may produce a
16522 larger prime than requested.
16523
16524
16525 .option tls_dhparam main string&!! unset
16526 .cindex "TLS" "D-H parameters for server"
16527 The value of this option is expanded and indicates the source of DH parameters
16528 to be used by Exim.
16529
16530 If it is a filename starting with a &`/`&, then it names a file from which DH
16531 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16532 PKCS#3 representation of the DH prime.  If the file does not exist, for
16533 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16534 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16535 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16536 and treated as though the &%tls_dhparam%& were set to "none".
16537
16538 If this option expands to the string "none", then no DH parameters will be
16539 loaded by Exim.
16540
16541 If this option expands to the string "historic" and Exim is using GnuTLS, then
16542 Exim will attempt to load a file from inside the spool directory.  If the file
16543 does not exist, Exim will attempt to create it.
16544 See section &<<SECTgnutlsparam>>& for further details.
16545
16546 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16547 a default DH prime; the default is the 2048 bit prime described in section
16548 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16549 in IKE is assigned number 23.
16550
16551 Otherwise, the option must expand to the name used by Exim for any of a number
16552 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16553 "ike" followed by the number used by IKE, of "default" which corresponds to
16554 "ike23".
16555
16556 The available primes are:
16557 &`ike1`&, &`ike2`&, &`ike5`&,
16558 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16559 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16560
16561 Some of these will be too small to be accepted by clients.
16562 Some may be too large to be accepted by clients.
16563
16564 The TLS protocol does not negotiate an acceptable size for this; clients tend
16565 to hard-drop connections if what is offered by the server is unacceptable,
16566 whether too large or too small, and there's no provision for the client to
16567 tell the server what these constraints are.  Thus, as a server operator, you
16568 need to make an educated guess as to what is most likely to work for your
16569 userbase.
16570
16571 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16572 is most likely to maximise interoperability.  The upper bound comes from
16573 applications using the Mozilla Network Security Services (NSS) library, which
16574 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16575 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16576 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16577 acceptable bound from 1024 to 2048.
16578
16579
16580 .option tls_ocsp_file main string&!! unset
16581 This option
16582 must if set expand to the absolute path to a file which contains a current
16583 status proof for the server's certificate, as obtained from the
16584 Certificate Authority.
16585
16586
16587 .option tls_on_connect_ports main "string list" unset
16588 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16589 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16590 set up without waiting for the client to issue a STARTTLS command. For
16591 further details, see section &<<SECTsupobssmt>>&.
16592
16593
16594
16595 .option tls_privatekey main string&!! unset
16596 .cindex "TLS" "server private key; location of"
16597 The value of this option is expanded, and must then be the absolute path to a
16598 file which contains the server's private key. If this option is unset, or if
16599 the expansion is forced to fail, or the result is an empty string, the private
16600 key is assumed to be in the same file as the server's certificates. See chapter
16601 &<<CHAPTLS>>& for further details.
16602
16603 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16604
16605
16606 .option tls_remember_esmtp main boolean false
16607 .cindex "TLS" "esmtp state; remembering"
16608 .cindex "TLS" "broken clients"
16609 If this option is set true, Exim violates the RFCs by remembering that it is in
16610 &"esmtp"& state after successfully negotiating a TLS session. This provides
16611 support for broken clients that fail to send a new EHLO after starting a
16612 TLS session.
16613
16614
16615 .option tls_require_ciphers main string&!! unset
16616 .cindex "TLS" "requiring specific ciphers"
16617 .cindex "cipher" "requiring specific"
16618 This option controls which ciphers can be used for incoming TLS connections.
16619 The &(smtp)& transport has an option of the same name for controlling outgoing
16620 connections. This option is expanded for each connection, so can be varied for
16621 different clients if required. The value of this option must be a list of
16622 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16623 in somewhat different ways. If GnuTLS is being used, the client controls the
16624 preference order of the available ciphers. Details are given in sections
16625 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16626
16627
16628 .option tls_try_verify_hosts main "host list&!!" unset
16629 .cindex "TLS" "client certificate verification"
16630 .cindex "certificate" "verification of client"
16631 See &%tls_verify_hosts%& below.
16632
16633
16634 .new
16635 .option tls_verify_certificates main string&!! system
16636 .cindex "TLS" "client certificate verification"
16637 .cindex "certificate" "verification of client"
16638 The value of this option is expanded, and must then be either the
16639 word "system"
16640 or the absolute path to
16641 a file or directory containing permitted certificates for clients that
16642 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16643
16644 The "system" value for the option will use a
16645 system default location compiled into the SSL library.
16646 This is not available for GnuTLS versions preceding 3.0.20,
16647 and will be taken as empty; an explicit location
16648 must be specified.
16649
16650 The use of a directory for the option value is not avilable for GnuTLS versions
16651 preceding 3.3.6 and a single file must be used.
16652
16653 With OpenSSL the certificates specified
16654 explicitly
16655 either by file or directory
16656 are added to those given by the system default location.
16657 .wen
16658
16659 These certificates should be for the certificate authorities trusted, rather
16660 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16661 the value is a file then the certificates are sent by Exim as a server to
16662 connecting clients, defining the list of accepted certificate authorities.
16663 Thus the values defined should be considered public data.  To avoid this,
16664 use the explicit directory version.
16665
16666 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16667
16668 A forced expansion failure or setting to an empty string is equivalent to
16669 being unset.
16670
16671
16672 .option tls_verify_hosts main "host list&!!" unset
16673 .cindex "TLS" "client certificate verification"
16674 .cindex "certificate" "verification of client"
16675 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16676 certificates from clients. The expected certificates are defined by
16677 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16678 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16679 &%tls_verify_certificates%& is not set.
16680
16681 Any client that matches &%tls_verify_hosts%& is constrained by
16682 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16683 present one of the listed certificates. If it does not, the connection is
16684 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16685 the host to use TLS. It can still send SMTP commands through unencrypted
16686 connections. Forcing a client to use TLS has to be done separately using an
16687 ACL to reject inappropriate commands when the connection is not encrypted.
16688
16689 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16690 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16691 certificate and checks it against &%tls_verify_certificates%&, but does not
16692 abort the connection if there is no certificate or if it does not match. This
16693 state can be detected in an ACL, which makes it possible to implement policies
16694 such as &"accept for relay only if a verified certificate has been received,
16695 but accept for local delivery if encrypted, even without a verified
16696 certificate"&.
16697
16698 Client hosts that match neither of these lists are not asked to present
16699 certificates.
16700
16701
16702 .option trusted_groups main "string list&!!" unset
16703 .cindex "trusted groups"
16704 .cindex "groups" "trusted"
16705 This option is expanded just once, at the start of Exim's processing. If this
16706 option is set, any process that is running in one of the listed groups, or
16707 which has one of them as a supplementary group, is trusted. The groups can be
16708 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16709 details of what trusted callers are permitted to do. If neither
16710 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16711 are trusted.
16712
16713 .option trusted_users main "string list&!!" unset
16714 .cindex "trusted users"
16715 .cindex "user" "trusted"
16716 This option is expanded just once, at the start of Exim's processing. If this
16717 option is set, any process that is running as one of the listed users is
16718 trusted. The users can be specified numerically or by name. See section
16719 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16720 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16721 Exim user are trusted.
16722
16723 .option unknown_login main string&!! unset
16724 .cindex "uid (user id)" "unknown caller"
16725 .vindex "&$caller_uid$&"
16726 This is a specialized feature for use in unusual configurations. By default, if
16727 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16728 gives up. The &%unknown_login%& option can be used to set a login name to be
16729 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16730 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16731 is used for the user's real name (gecos field), unless this has been set by the
16732 &%-F%& option.
16733
16734 .option unknown_username main string unset
16735 See &%unknown_login%&.
16736
16737 .option untrusted_set_sender main "address list&!!" unset
16738 .cindex "trusted users"
16739 .cindex "sender" "setting by untrusted user"
16740 .cindex "untrusted user setting sender"
16741 .cindex "user" "untrusted setting sender"
16742 .cindex "envelope sender"
16743 When an untrusted user submits a message to Exim using the standard input, Exim
16744 normally creates an envelope sender address from the user's login and the
16745 default qualification domain. Data from the &%-f%& option (for setting envelope
16746 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16747 is used) is ignored.
16748
16749 However, untrusted users are permitted to set an empty envelope sender address,
16750 to declare that a message should never generate any bounces. For example:
16751 .code
16752 exim -f '<>' user@domain.example
16753 .endd
16754 .vindex "&$sender_ident$&"
16755 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16756 other envelope sender addresses in a controlled way. When it is set, untrusted
16757 users are allowed to set envelope sender addresses that match any of the
16758 patterns in the list. Like all address lists, the string is expanded. The
16759 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16760 users to setting senders that start with their login ids
16761 followed by a hyphen
16762 by a setting like this:
16763 .code
16764 untrusted_set_sender = ^$sender_ident-
16765 .endd
16766 If you want to allow untrusted users to set envelope sender addresses without
16767 restriction, you can use
16768 .code
16769 untrusted_set_sender = *
16770 .endd
16771 The &%untrusted_set_sender%& option applies to all forms of local input, but
16772 only to the setting of the envelope sender. It does not permit untrusted users
16773 to use the other options which trusted user can use to override message
16774 parameters. Furthermore, it does not stop Exim from removing an existing
16775 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16776 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16777 overriding these actions. The handling of the &'Sender:'& header is also
16778 described in section &<<SECTthesenhea>>&.
16779
16780 The log line for a message's arrival shows the envelope sender following
16781 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16782 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16783 envelope sender address, the user's login is shown in parentheses after the
16784 sender address.
16785
16786
16787 .option uucp_from_pattern main string "see below"
16788 .cindex "&""From""& line"
16789 .cindex "UUCP" "&""From""& line"
16790 Some applications that pass messages to an MTA via a command line interface use
16791 an initial line starting with &"From&~"& to pass the envelope sender. In
16792 particular, this is used by UUCP software. Exim recognizes such a line by means
16793 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16794 matches, the sender address is constructed by expanding the contents of
16795 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16796 default pattern recognizes lines in the following two forms:
16797 .code
16798 From ph10 Fri Jan  5 12:35 GMT 1996
16799 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16800 .endd
16801 The pattern can be seen by running
16802 .code
16803 exim -bP uucp_from_pattern
16804 .endd
16805 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16806 year in the second case. The first word after &"From&~"& is matched in the
16807 regular expression by a parenthesized subpattern. The default value for
16808 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16809 (&"ph10"& in the example above) as the message's sender. See also
16810 &%ignore_fromline_hosts%&.
16811
16812
16813 .option uucp_from_sender main string&!! &`$1`&
16814 See &%uucp_from_pattern%& above.
16815
16816
16817 .option warn_message_file main string unset
16818 .cindex "warning of delay" "customizing the message"
16819 .cindex "customizing" "warning message"
16820 This option defines a template file containing paragraphs of text to be used
16821 for constructing the warning message which is sent by Exim when a message has
16822 been on the queue for a specified amount of time, as specified by
16823 &%delay_warning%&. Details of the file's contents are given in chapter
16824 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16825
16826
16827 .option write_rejectlog main boolean true
16828 .cindex "reject log" "disabling"
16829 If this option is set false, Exim no longer writes anything to the reject log.
16830 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16831 .ecindex IIDconfima
16832 .ecindex IIDmaiconf
16833
16834
16835
16836
16837 . ////////////////////////////////////////////////////////////////////////////
16838 . ////////////////////////////////////////////////////////////////////////////
16839
16840 .chapter "Generic options for routers" "CHAProutergeneric"
16841 .scindex IIDgenoprou1 "options" "generic; for routers"
16842 .scindex IIDgenoprou2 "generic options" "router"
16843 This chapter describes the generic options that apply to all routers.
16844 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16845
16846 For a general description of how a router operates, see sections
16847 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16848 which the preconditions are tested. The order of expansion of the options that
16849 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16850 &%headers_remove%&, &%transport%&.
16851
16852
16853
16854 .option address_data routers string&!! unset
16855 .cindex "router" "data attached to address"
16856 The string is expanded just before the router is run, that is, after all the
16857 precondition tests have succeeded. If the expansion is forced to fail, the
16858 router declines, the value of &%address_data%& remains unchanged, and the
16859 &%more%& option controls what happens next. Other expansion failures cause
16860 delivery of the address to be deferred.
16861
16862 .vindex "&$address_data$&"
16863 When the expansion succeeds, the value is retained with the address, and can be
16864 accessed using the variable &$address_data$& in the current router, subsequent
16865 routers, and the eventual transport.
16866
16867 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16868 that runs a user's filter file, the contents of &$address_data$& are accessible
16869 in the filter. This is not normally a problem, because such data is usually
16870 either not confidential or it &"belongs"& to the current user, but if you do
16871 put confidential data into &$address_data$& you need to remember this point.
16872
16873 Even if the router declines or passes, the value of &$address_data$& remains
16874 with the address, though it can be changed by another &%address_data%& setting
16875 on a subsequent router. If a router generates child addresses, the value of
16876 &$address_data$& propagates to them. This also applies to the special kind of
16877 &"child"& that is generated by a router with the &%unseen%& option.
16878
16879 The idea of &%address_data%& is that you can use it to look up a lot of data
16880 for the address once, and then pick out parts of the data later. For example,
16881 you could use a single LDAP lookup to return a string of the form
16882 .code
16883 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16884 .endd
16885 In the transport you could pick out the mailbox by a setting such as
16886 .code
16887 file = ${extract{mailbox}{$address_data}}
16888 .endd
16889 This makes the configuration file less messy, and also reduces the number of
16890 lookups (though Exim does cache lookups).
16891
16892 .vindex "&$sender_address_data$&"
16893 .vindex "&$address_data$&"
16894 The &%address_data%& facility is also useful as a means of passing information
16895 from one router to another, and from a router to a transport. In addition, if
16896 &$address_data$& is set by a router when verifying a recipient address from an
16897 ACL, it remains available for use in the rest of the ACL statement. After
16898 verifying a sender, the value is transferred to &$sender_address_data$&.
16899
16900
16901
16902 .option address_test routers&!? boolean true
16903 .oindex "&%-bt%&"
16904 .cindex "router" "skipping when address testing"
16905 If this option is set false, the router is skipped when routing is being tested
16906 by means of the &%-bt%& command line option. This can be a convenience when
16907 your first router sends messages to an external scanner, because it saves you
16908 having to set the &"already scanned"& indicator when testing real address
16909 routing.
16910
16911
16912
16913 .option cannot_route_message routers string&!! unset
16914 .cindex "router" "customizing &""cannot route""& message"
16915 .cindex "customizing" "&""cannot route""& message"
16916 This option specifies a text message that is used when an address cannot be
16917 routed because Exim has run out of routers. The default message is
16918 &"Unrouteable address"&. This option is useful only on routers that have
16919 &%more%& set false, or on the very last router in a configuration, because the
16920 value that is used is taken from the last router that is considered. This
16921 includes a router that is skipped because its preconditions are not met, as
16922 well as a router that declines. For example, using the default configuration,
16923 you could put:
16924 .code
16925 cannot_route_message = Remote domain not found in DNS
16926 .endd
16927 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16928 and
16929 .code
16930 cannot_route_message = Unknown local user
16931 .endd
16932 on the final router that checks for local users. If string expansion fails for
16933 this option, the default message is used. Unless the expansion failure was
16934 explicitly forced, a message about the failure is written to the main and panic
16935 logs, in addition to the normal message about the routing failure.
16936
16937
16938 .option caseful_local_part routers boolean false
16939 .cindex "case of local parts"
16940 .cindex "router" "case of local parts"
16941 By default, routers handle the local parts of addresses in a case-insensitive
16942 manner, though the actual case is preserved for transmission with the message.
16943 If you want the case of letters to be significant in a router, you must set
16944 this option true. For individual router options that contain address or local
16945 part lists (for example, &%local_parts%&), case-sensitive matching can be
16946 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16947 more details.
16948
16949 .vindex "&$local_part$&"
16950 .vindex "&$original_local_part$&"
16951 .vindex "&$parent_local_part$&"
16952 The value of the &$local_part$& variable is forced to lower case while a
16953 router is running unless &%caseful_local_part%& is set. When a router assigns
16954 an address to a transport, the value of &$local_part$& when the transport runs
16955 is the same as it was in the router. Similarly, when a router generates child
16956 addresses by aliasing or forwarding, the values of &$original_local_part$&
16957 and &$parent_local_part$& are those that were used by the redirecting router.
16958
16959 This option applies to the processing of an address by a router. When a
16960 recipient address is being processed in an ACL, there is a separate &%control%&
16961 modifier that can be used to specify case-sensitive processing within the ACL
16962 (see section &<<SECTcontrols>>&).
16963
16964
16965
16966 .option check_local_user routers&!? boolean false
16967 .cindex "local user, checking in router"
16968 .cindex "router" "checking for local user"
16969 .cindex "&_/etc/passwd_&"
16970 .vindex "&$home$&"
16971 When this option is true, Exim checks that the local part of the recipient
16972 address (with affixes removed if relevant) is the name of an account on the
16973 local system. The check is done by calling the &[getpwnam()]& function rather
16974 than trying to read &_/etc/passwd_& directly. This means that other methods of
16975 holding password data (such as NIS) are supported. If the local part is a local
16976 user, &$home$& is set from the password data, and can be tested in other
16977 preconditions that are evaluated after this one (the order of evaluation is
16978 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16979 overridden by &%router_home_directory%&. If the local part is not a local user,
16980 the router is skipped.
16981
16982 If you want to check that the local part is either the name of a local user
16983 or matches something else, you cannot combine &%check_local_user%& with a
16984 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16985 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16986 setting to achieve this. For example:
16987 .code
16988 local_parts = passwd;$local_part : lsearch;/etc/other/users
16989 .endd
16990 Note, however, that the side effects of &%check_local_user%& (such as setting
16991 up a home directory) do not occur when a &(passwd)& lookup is used in a
16992 &%local_parts%& (or any other) precondition.
16993
16994
16995
16996 .option condition routers&!? string&!! unset
16997 .cindex "router" "customized precondition"
16998 This option specifies a general precondition test that has to succeed for the
16999 router to be called. The &%condition%& option is the last precondition to be
17000 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17001 result is a forced failure, or an empty string, or one of the strings &"0"& or
17002 &"no"& or &"false"& (checked without regard to the case of the letters), the
17003 router is skipped, and the address is offered to the next one.
17004
17005 If the result is any other value, the router is run (as this is the last
17006 precondition to be evaluated, all the other preconditions must be true).
17007
17008 This option is unusual in that multiple &%condition%& options may be present.
17009 All &%condition%& options must succeed.
17010
17011 The &%condition%& option provides a means of applying custom conditions to the
17012 running of routers. Note that in the case of a simple conditional expansion,
17013 the default expansion values are exactly what is wanted. For example:
17014 .code
17015 condition = ${if >{$message_age}{600}}
17016 .endd
17017 Because of the default behaviour of the string expansion, this is equivalent to
17018 .code
17019 condition = ${if >{$message_age}{600}{true}{}}
17020 .endd
17021
17022 A multiple condition example, which succeeds:
17023 .code
17024 condition = ${if >{$message_age}{600}}
17025 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17026 condition = foobar
17027 .endd
17028
17029 If the expansion fails (other than forced failure) delivery is deferred. Some
17030 of the other precondition options are common special cases that could in fact
17031 be specified using &%condition%&.
17032
17033 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17034 are far older, and use one set of semantics.  ACLs are newer and when
17035 they were created, the ACL &%condition%& process was given far stricter
17036 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17037 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17038 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17039 Router rules processing behavior.
17040
17041 This is best illustrated in an example:
17042 .code
17043 # If used in an ACL condition will fail with a syntax error, but
17044 # in a router condition any extra characters are treated as a string
17045
17046 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17047 true {yes} {no}}
17048
17049 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17050  {yes} {no}}
17051 .endd
17052 In each example above, the &%if%& statement actually ends after
17053 &"{google.com}}"&.  Since no true or false braces were defined, the
17054 default &%if%& behavior is to return a boolean true or a null answer
17055 (which evaluates to false). The rest of the line is then treated as a
17056 string. So the first example resulted in the boolean answer &"true"&
17057 with the string &" {yes} {no}}"& appended to it. The second example
17058 resulted in the null output (indicating false) with the string
17059 &" {yes} {no}}"& appended to it.
17060
17061 In fact you can put excess forward braces in too.  In the router
17062 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17063 mean something, like after a &"$"& or when required as part of a
17064 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17065 string characters.
17066
17067 Thus, in a Router, the above expansion strings will both always evaluate
17068 true, as the result of expansion is a non-empty string which doesn't
17069 match an explicit false value.  This can be tricky to debug.  By
17070 contrast, in an ACL either of those strings will always result in an
17071 expansion error because the result doesn't look sufficiently boolean.
17072
17073
17074 .option debug_print routers string&!! unset
17075 .cindex "testing" "variables in drivers"
17076 If this option is set and debugging is enabled (see the &%-d%& command line
17077 option) or in address-testing mode (see the &%-bt%& command line option),
17078 the string is expanded and included in the debugging output.
17079 If expansion of the string fails, the error message is written to the debugging
17080 output, and Exim carries on processing.
17081 This option is provided to help with checking out the values of variables and
17082 so on when debugging router configurations. For example, if a &%condition%&
17083 option appears not to be working, &%debug_print%& can be used to output the
17084 variables it references. The output happens after checks for &%domains%&,
17085 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17086 are tested. A newline is added to the text if it does not end with one.
17087 The variable &$router_name$& contains the name of the router.
17088
17089
17090
17091 .option disable_logging routers boolean false
17092 If this option is set true, nothing is logged for any routing errors
17093 or for any deliveries caused by this router. You should not set this option
17094 unless you really, really know what you are doing. See also the generic
17095 transport option of the same name.
17096
17097 .option dnssec_request_domains routers "domain list&!!" unset
17098 .cindex "MX record" "security"
17099 .cindex "DNSSEC" "MX lookup"
17100 .cindex "security" "MX lookup"
17101 .cindex "DNS" "DNSSEC"
17102 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17103 the dnssec request bit set.
17104 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17105
17106 .option dnssec_require_domains routers "domain list&!!" unset
17107 .cindex "MX record" "security"
17108 .cindex "DNSSEC" "MX lookup"
17109 .cindex "security" "MX lookup"
17110 .cindex "DNS" "DNSSEC"
17111 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17112 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17113 (AD bit) set will be ignored and logged as a host-lookup failure.
17114 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17115
17116
17117 .option domains routers&!? "domain list&!!" unset
17118 .cindex "router" "restricting to specific domains"
17119 .vindex "&$domain_data$&"
17120 If this option is set, the router is skipped unless the current domain matches
17121 the list. If the match is achieved by means of a file lookup, the data that the
17122 lookup returned for the domain is placed in &$domain_data$& for use in string
17123 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17124 a list of the order in which preconditions are evaluated.
17125
17126
17127
17128 .option driver routers string unset
17129 This option must always be set. It specifies which of the available routers is
17130 to be used.
17131
17132
17133 .new
17134 .option dsn_lasthop routers boolean false
17135 .cindex "DSN" "success"
17136 .cindex "Delivery Status Notification" "success"
17137 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17138 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17139 instead send a success DSN as if the next hop does not support DSN.
17140 Not effective on redirect routers.
17141 .wen
17142
17143
17144
17145 .option errors_to routers string&!! unset
17146 .cindex "envelope sender"
17147 .cindex "router" "changing address for errors"
17148 If a router successfully handles an address, it may assign the address to a
17149 transport for delivery or it may generate child addresses. In both cases, if
17150 there is a delivery problem during later processing, the resulting bounce
17151 message is sent to the address that results from expanding this string,
17152 provided that the address verifies successfully. The &%errors_to%& option is
17153 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17154
17155 The &%errors_to%& setting associated with an address can be overridden if it
17156 subsequently passes through other routers that have their own &%errors_to%&
17157 settings, or if the message is delivered by a transport with a &%return_path%&
17158 setting.
17159
17160 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17161 the expansion fails to verify, the errors address associated with the incoming
17162 address is used. At top level, this is the envelope sender. A non-forced
17163 expansion failure causes delivery to be deferred.
17164
17165 If an address for which &%errors_to%& has been set ends up being delivered over
17166 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17167 any bounces that are generated by other MTAs on the delivery route are also
17168 sent there. You can set &%errors_to%& to the empty string by either of these
17169 settings:
17170 .code
17171 errors_to =
17172 errors_to = ""
17173 .endd
17174 An expansion item that yields an empty string has the same effect. If you do
17175 this, a locally detected delivery error for addresses processed by this router
17176 no longer gives rise to a bounce message; the error is discarded. If the
17177 address is delivered to a remote host, the return path is set to &`<>`&, unless
17178 overridden by the &%return_path%& option on the transport.
17179
17180 .vindex "&$address_data$&"
17181 If for some reason you want to discard local errors, but use a non-empty
17182 MAIL command for remote delivery, you can preserve the original return
17183 path in &$address_data$& in the router, and reinstate it in the transport by
17184 setting &%return_path%&.
17185
17186 The most common use of &%errors_to%& is to direct mailing list bounces to the
17187 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17188 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17189
17190
17191
17192 .option expn routers&!? boolean true
17193 .cindex "address" "testing"
17194 .cindex "testing" "addresses"
17195 .cindex "EXPN" "router skipping"
17196 .cindex "router" "skipping for EXPN"
17197 If this option is turned off, the router is skipped when testing an address
17198 as a result of processing an SMTP EXPN command. You might, for example,
17199 want to turn it off on a router for users' &_.forward_& files, while leaving it
17200 on for the system alias file.
17201 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17202 are evaluated.
17203
17204 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17205 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17206 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17207
17208
17209
17210 .option fail_verify routers boolean false
17211 .cindex "router" "forcing verification failure"
17212 Setting this option has the effect of setting both &%fail_verify_sender%& and
17213 &%fail_verify_recipient%& to the same value.
17214
17215
17216
17217 .option fail_verify_recipient routers boolean false
17218 If this option is true and an address is accepted by this router when
17219 verifying a recipient, verification fails.
17220
17221
17222
17223 .option fail_verify_sender routers boolean false
17224 If this option is true and an address is accepted by this router when
17225 verifying a sender, verification fails.
17226
17227
17228
17229 .option fallback_hosts routers "string list" unset
17230 .cindex "router" "fallback hosts"
17231 .cindex "fallback" "hosts specified on router"
17232 String expansion is not applied to this option. The argument must be a
17233 colon-separated list of host names or IP addresses. The list separator can be
17234 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17235 each name or address. In fact, the format of each item is exactly the same as
17236 defined for the list of hosts in a &(manualroute)& router (see section
17237 &<<SECTformatonehostitem>>&).
17238
17239 If a router queues an address for a remote transport, this host list is
17240 associated with the address, and used instead of the transport's fallback host
17241 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17242 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17243 transport for further details.
17244
17245
17246 .option group routers string&!! "see below"
17247 .cindex "gid (group id)" "local delivery"
17248 .cindex "local transports" "uid and gid"
17249 .cindex "transport" "local"
17250 .cindex "router" "setting group"
17251 When a router queues an address for a transport, and the transport does not
17252 specify a group, the group given here is used when running the delivery
17253 process.
17254 The group may be specified numerically or by name. If expansion fails, the
17255 error is logged and delivery is deferred.
17256 The default is unset, unless &%check_local_user%& is set, when the default
17257 is taken from the password information. See also &%initgroups%& and &%user%&
17258 and the discussion in chapter &<<CHAPenvironment>>&.
17259
17260
17261
17262 .option headers_add routers list&!! unset
17263 .cindex "header lines" "adding"
17264 .cindex "router" "adding header lines"
17265 This option specifies a list of text headers,
17266 .new
17267 newline-separated (by default, changeable in the usual way),
17268 .wen
17269 that is associated with any addresses that are accepted by the router.
17270 Each item is separately expanded, at routing time.  However, this
17271 option has no effect when an address is just being verified. The way in which
17272 the text is used to add header lines at transport time is described in section
17273 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17274 message is in the process of being transported. This means that references to
17275 header lines in string expansions in the transport's configuration do not
17276 &"see"& the added header lines.
17277
17278 The &%headers_add%& option is expanded after &%errors_to%&, but before
17279 &%headers_remove%& and &%transport%&. If an item is empty, or if
17280 an item expansion is forced to fail, the item has no effect. Other expansion
17281 failures are treated as configuration errors.
17282
17283 Unlike most options, &%headers_add%& can be specified multiple times
17284 for a router; all listed headers are added.
17285
17286 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17287 router that has the &%one_time%& option set.
17288
17289 .cindex "duplicate addresses"
17290 .oindex "&%unseen%&"
17291 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17292 additions are deleted when the address is passed on to subsequent routers.
17293 For a &%redirect%& router, if a generated address is the same as the incoming
17294 address, this can lead to duplicate addresses with different header
17295 modifications. Exim does not do duplicate deliveries (except, in certain
17296 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17297 which of the duplicates is discarded, so this ambiguous situation should be
17298 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17299
17300
17301
17302 .option headers_remove routers list&!! unset
17303 .cindex "header lines" "removing"
17304 .cindex "router" "removing header lines"
17305 This option specifies a list of text headers,
17306 .new
17307 colon-separated (by default, changeable in the usual way),
17308 .wen
17309 that is associated with any addresses that are accepted by the router.
17310 Each item is separately expanded, at routing time.  However, this
17311 option has no effect when an address is just being verified. The way in which
17312 the text is used to remove header lines at transport time is described in
17313 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17314 the message is in the process of being transported. This means that references
17315 to header lines in string expansions in the transport's configuration still
17316 &"see"& the original header lines.
17317
17318 The &%headers_remove%& option is expanded after &%errors_to%& and
17319 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17320 the item has no effect. Other expansion failures are treated as configuration
17321 errors.
17322
17323 Unlike most options, &%headers_remove%& can be specified multiple times
17324 for a router; all listed headers are removed.
17325
17326 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17327 router that has the &%one_time%& option set.
17328
17329 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17330 removal requests are deleted when the address is passed on to subsequent
17331 routers, and this can lead to problems with duplicates -- see the similar
17332 warning for &%headers_add%& above.
17333
17334
17335 .option ignore_target_hosts routers "host list&!!" unset
17336 .cindex "IP address" "discarding"
17337 .cindex "router" "discarding IP addresses"
17338 Although this option is a host list, it should normally contain IP address
17339 entries rather than names. If any host that is looked up by the router has an
17340 IP address that matches an item in this list, Exim behaves as if that IP
17341 address did not exist. This option allows you to cope with rogue DNS entries
17342 like
17343 .code
17344 remote.domain.example.  A  127.0.0.1
17345 .endd
17346 by setting
17347 .code
17348 ignore_target_hosts = 127.0.0.1
17349 .endd
17350 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17351 discarded in this way, the router declines. In a conventional configuration, an
17352 attempt to mail to such a domain would normally provoke the &"unrouteable
17353 domain"& error, and an attempt to verify an address in the domain would fail.
17354 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17355 router declines if presented with one of the listed addresses.
17356
17357 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17358 means of the first or the second of the following settings, respectively:
17359 .code
17360 ignore_target_hosts = 0.0.0.0/0
17361 ignore_target_hosts = <; 0::0/0
17362 .endd
17363 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17364 in the second line matches all IPv6 addresses.
17365
17366 This option may also be useful for ignoring link-local and site-local IPv6
17367 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17368 is expanded before use as a list, it is possible to make it dependent on the
17369 domain that is being routed.
17370
17371 .vindex "&$host_address$&"
17372 During its expansion, &$host_address$& is set to the IP address that is being
17373 checked.
17374
17375 .option initgroups routers boolean false
17376 .cindex "additional groups"
17377 .cindex "groups" "additional"
17378 .cindex "local transports" "uid and gid"
17379 .cindex "transport" "local"
17380 If the router queues an address for a transport, and this option is true, and
17381 the uid supplied by the router is not overridden by the transport, the
17382 &[initgroups()]& function is called when running the transport to ensure that
17383 any additional groups associated with the uid are set up. See also &%group%&
17384 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17385
17386
17387
17388 .option local_part_prefix routers&!? "string list" unset
17389 .cindex "router" "prefix for local part"
17390 .cindex "prefix" "for local part, used in router"
17391 If this option is set, the router is skipped unless the local part starts with
17392 one of the given strings, or &%local_part_prefix_optional%& is true. See
17393 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17394 evaluated.
17395
17396 The list is scanned from left to right, and the first prefix that matches is
17397 used. A limited form of wildcard is available; if the prefix begins with an
17398 asterisk, it matches the longest possible sequence of arbitrary characters at
17399 the start of the local part. An asterisk should therefore always be followed by
17400 some character that does not occur in normal local parts.
17401 .cindex "multiple mailboxes"
17402 .cindex "mailbox" "multiple"
17403 Wildcarding can be used to set up multiple user mailboxes, as described in
17404 section &<<SECTmulbox>>&.
17405
17406 .vindex "&$local_part$&"
17407 .vindex "&$local_part_prefix$&"
17408 During the testing of the &%local_parts%& option, and while the router is
17409 running, the prefix is removed from the local part, and is available in the
17410 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17411 the router accepts the address, this remains true during subsequent delivery by
17412 a transport. In particular, the local part that is transmitted in the RCPT
17413 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17414 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17415 the relevant transport.
17416
17417 When an address is being verified, &%local_part_prefix%& affects only the
17418 behaviour of the router. If the callout feature of verification is in use, this
17419 means that the full address, including the prefix, will be used during the
17420 callout.
17421
17422 The prefix facility is commonly used to handle local parts of the form
17423 &%owner-something%&. Another common use is to support local parts of the form
17424 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17425 to tell a user their forwarding is broken &-- by placing a router like this one
17426 immediately before the router that handles &_.forward_& files:
17427 .code
17428 real_localuser:
17429   driver = accept
17430   local_part_prefix = real-
17431   check_local_user
17432   transport = local_delivery
17433 .endd
17434 For security, it would probably be a good idea to restrict the use of this
17435 router to locally-generated messages, using a condition such as this:
17436 .code
17437   condition = ${if match {$sender_host_address}\
17438                          {\N^(|127\.0\.0\.1)$\N}}
17439 .endd
17440
17441 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17442 both conditions must be met if not optional. Care must be taken if wildcards
17443 are used in both a prefix and a suffix on the same router. Different
17444 separator characters must be used to avoid ambiguity.
17445
17446
17447 .option local_part_prefix_optional routers boolean false
17448 See &%local_part_prefix%& above.
17449
17450
17451
17452 .option local_part_suffix routers&!? "string list" unset
17453 .cindex "router" "suffix for local part"
17454 .cindex "suffix for local part" "used in router"
17455 This option operates in the same way as &%local_part_prefix%&, except that the
17456 local part must end (rather than start) with the given string, the
17457 &%local_part_suffix_optional%& option determines whether the suffix is
17458 mandatory, and the wildcard * character, if present, must be the last
17459 character of the suffix. This option facility is commonly used to handle local
17460 parts of the form &%something-request%& and multiple user mailboxes of the form
17461 &%username-foo%&.
17462
17463
17464 .option local_part_suffix_optional routers boolean false
17465 See &%local_part_suffix%& above.
17466
17467
17468
17469 .option local_parts routers&!? "local part list&!!" unset
17470 .cindex "router" "restricting to specific local parts"
17471 .cindex "local part" "checking in router"
17472 The router is run only if the local part of the address matches the list.
17473 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17474 are evaluated, and
17475 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17476 string is expanded, it is possible to make it depend on the domain, for
17477 example:
17478 .code
17479 local_parts = dbm;/usr/local/specials/$domain
17480 .endd
17481 .vindex "&$local_part_data$&"
17482 If the match is achieved by a lookup, the data that the lookup returned
17483 for the local part is placed in the variable &$local_part_data$& for use in
17484 expansions of the router's private options. You might use this option, for
17485 example, if you have a large number of local virtual domains, and you want to
17486 send all postmaster mail to the same place without having to set up an alias in
17487 each virtual domain:
17488 .code
17489 postmaster:
17490   driver = redirect
17491   local_parts = postmaster
17492   data = postmaster@real.domain.example
17493 .endd
17494
17495
17496 .option log_as_local routers boolean "see below"
17497 .cindex "log" "delivery line"
17498 .cindex "delivery" "log line format"
17499 Exim has two logging styles for delivery, the idea being to make local
17500 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17501 recipient address is given just as the local part, without a domain. The use of
17502 this style is controlled by this option. It defaults to true for the &(accept)&
17503 router, and false for all the others. This option applies only when a
17504 router assigns an address to a transport. It has no effect on routers that
17505 redirect addresses.
17506
17507
17508
17509 .option more routers boolean&!! true
17510 The result of string expansion for this option must be a valid boolean value,
17511 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17512 result causes an error, and delivery is deferred. If the expansion is forced to
17513 fail, the default value for the option (true) is used. Other failures cause
17514 delivery to be deferred.
17515
17516 If this option is set false, and the router declines to handle the address, no
17517 further routers are tried, routing fails, and the address is bounced.
17518 .oindex "&%self%&"
17519 However, if the router explicitly passes an address to the following router by
17520 means of the setting
17521 .code
17522 self = pass
17523 .endd
17524 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17525 does not affect the behaviour if one of the precondition tests fails. In that
17526 case, the address is always passed to the next router.
17527
17528 Note that &%address_data%& is not considered to be a precondition. If its
17529 expansion is forced to fail, the router declines, and the value of &%more%&
17530 controls what happens next.
17531
17532
17533 .option pass_on_timeout routers boolean false
17534 .cindex "timeout" "of router"
17535 .cindex "router" "timeout"
17536 If a router times out during a host lookup, it normally causes deferral of the
17537 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17538 router, overriding &%no_more%&. This may be helpful for systems that are
17539 intermittently connected to the Internet, or those that want to pass to a smart
17540 host any messages that cannot immediately be delivered.
17541
17542 There are occasional other temporary errors that can occur while doing DNS
17543 lookups. They are treated in the same way as a timeout, and this option
17544 applies to all of them.
17545
17546
17547
17548 .option pass_router routers string unset
17549 .cindex "router" "go to after &""pass""&"
17550 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17551 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17552 routing to continue, and overriding a false setting of &%more%&. When one of
17553 these routers returns &"pass"&, the address is normally handed on to the next
17554 router in sequence. This can be changed by setting &%pass_router%& to the name
17555 of another router. However (unlike &%redirect_router%&) the named router must
17556 be below the current router, to avoid loops. Note that this option applies only
17557 to the special case of &"pass"&. It does not apply when a router returns
17558 &"decline"& because it cannot handle an address.
17559
17560
17561
17562 .option redirect_router routers string unset
17563 .cindex "router" "start at after redirection"
17564 Sometimes an administrator knows that it is pointless to reprocess addresses
17565 generated from alias or forward files with the same router again. For
17566 example, if an alias file translates real names into login ids there is no
17567 point searching the alias file a second time, especially if it is a large file.
17568
17569 The &%redirect_router%& option can be set to the name of any router instance.
17570 It causes the routing of any generated addresses to start at the named router
17571 instead of at the first router. This option has no effect if the router in
17572 which it is set does not generate new addresses.
17573
17574
17575
17576 .option require_files routers&!? "string list&!!" unset
17577 .cindex "file" "requiring for router"
17578 .cindex "router" "requiring file existence"
17579 This option provides a general mechanism for predicating the running of a
17580 router on the existence or non-existence of certain files or directories.
17581 Before running a router, as one of its precondition tests, Exim works its way
17582 through the &%require_files%& list, expanding each item separately.
17583
17584 Because the list is split before expansion, any colons in expansion items must
17585 be doubled, or the facility for using a different list separator must be used.
17586 If any expansion is forced to fail, the item is ignored. Other expansion
17587 failures cause routing of the address to be deferred.
17588
17589 If any expanded string is empty, it is ignored. Otherwise, except as described
17590 below, each string must be a fully qualified file path, optionally preceded by
17591 &"!"&. The paths are passed to the &[stat()]& function to test for the
17592 existence of the files or directories. The router is skipped if any paths not
17593 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17594
17595 .cindex "NFS"
17596 If &[stat()]& cannot determine whether a file exists or not, delivery of
17597 the message is deferred. This can happen when NFS-mounted filesystems are
17598 unavailable.
17599
17600 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17601 options, so you cannot use it to check for the existence of a file in which to
17602 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17603 full list of the order in which preconditions are evaluated.) However, as
17604 these options are all expanded, you can use the &%exists%& expansion condition
17605 to make such tests. The &%require_files%& option is intended for checking files
17606 that the router may be going to use internally, or which are needed by a
17607 transport (for example &_.procmailrc_&).
17608
17609 During delivery, the &[stat()]& function is run as root, but there is a
17610 facility for some checking of the accessibility of a file by another user.
17611 This is not a proper permissions check, but just a &"rough"& check that
17612 operates as follows:
17613
17614 If an item in a &%require_files%& list does not contain any forward slash
17615 characters, it is taken to be the user (and optional group, separated by a
17616 comma) to be checked for subsequent files in the list. If no group is specified
17617 but the user is specified symbolically, the gid associated with the uid is
17618 used. For example:
17619 .code
17620 require_files = mail:/some/file
17621 require_files = $local_part:$home/.procmailrc
17622 .endd
17623 If a user or group name in a &%require_files%& list does not exist, the
17624 &%require_files%& condition fails.
17625
17626 Exim performs the check by scanning along the components of the file path, and
17627 checking the access for the given uid and gid. It checks for &"x"& access on
17628 directories, and &"r"& access on the final file. Note that this means that file
17629 access control lists, if the operating system has them, are ignored.
17630
17631 &*Warning 1*&: When the router is being run to verify addresses for an
17632 incoming SMTP message, Exim is not running as root, but under its own uid. This
17633 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17634 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17635 user is not permitted to read one of the directories on the file's path.
17636
17637 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17638 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17639 without root access. In this case, if a check for access by a particular user
17640 is requested, Exim creates a subprocess that runs as that user, and tries the
17641 check again in that process.
17642
17643 The default action for handling an unresolved EACCES is to consider it to
17644 be caused by a configuration error, and routing is deferred because the
17645 existence or non-existence of the file cannot be determined. However, in some
17646 circumstances it may be desirable to treat this condition as if the file did
17647 not exist. If the file name (or the exclamation mark that precedes the file
17648 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17649 as if the file did not exist. For example:
17650 .code
17651 require_files = +/some/file
17652 .endd
17653 If the router is not an essential part of verification (for example, it
17654 handles users' &_.forward_& files), another solution is to set the &%verify%&
17655 option false so that the router is skipped when verifying.
17656
17657
17658
17659 .option retry_use_local_part routers boolean "see below"
17660 .cindex "hints database" "retry keys"
17661 .cindex "local part" "in retry keys"
17662 When a delivery suffers a temporary routing failure, a retry record is created
17663 in Exim's hints database. For addresses whose routing depends only on the
17664 domain, the key for the retry record should not involve the local part, but for
17665 other addresses, both the domain and the local part should be included.
17666 Usually, remote routing is of the former kind, and local routing is of the
17667 latter kind.
17668
17669 This option controls whether the local part is used to form the key for retry
17670 hints for addresses that suffer temporary errors while being handled by this
17671 router. The default value is true for any router that has &%check_local_user%&
17672 set, and false otherwise. Note that this option does not apply to hints keys
17673 for transport delays; they are controlled by a generic transport option of the
17674 same name.
17675
17676 The setting of &%retry_use_local_part%& applies only to the router on which it
17677 appears. If the router generates child addresses, they are routed
17678 independently; this setting does not become attached to them.
17679
17680
17681
17682 .option router_home_directory routers string&!! unset
17683 .cindex "router" "home directory for"
17684 .cindex "home directory" "for router"
17685 .vindex "&$home$&"
17686 This option sets a home directory for use while the router is running. (Compare
17687 &%transport_home_directory%&, which sets a home directory for later
17688 transporting.) In particular, if used on a &(redirect)& router, this option
17689 sets a value for &$home$& while a filter is running. The value is expanded;
17690 forced expansion failure causes the option to be ignored &-- other failures
17691 cause the router to defer.
17692
17693 Expansion of &%router_home_directory%& happens immediately after the
17694 &%check_local_user%& test (if configured), before any further expansions take
17695 place.
17696 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17697 are evaluated.)
17698 While the router is running, &%router_home_directory%& overrides the value of
17699 &$home$& that came from &%check_local_user%&.
17700
17701 When a router accepts an address and assigns it to a local transport (including
17702 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17703 delivery), the home directory setting for the transport is taken from the first
17704 of these values that is set:
17705
17706 .ilist
17707 The &%home_directory%& option on the transport;
17708 .next
17709 The &%transport_home_directory%& option on the router;
17710 .next
17711 The password data if &%check_local_user%& is set on the router;
17712 .next
17713 The &%router_home_directory%& option on the router.
17714 .endlist
17715
17716 In other words, &%router_home_directory%& overrides the password data for the
17717 router, but not for the transport.
17718
17719
17720
17721 .option self routers string freeze
17722 .cindex "MX record" "pointing to local host"
17723 .cindex "local host" "MX pointing to"
17724 This option applies to those routers that use a recipient address to find a
17725 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17726 and &(manualroute)& routers.
17727 Certain configurations of the &(queryprogram)& router can also specify a list
17728 of remote hosts.
17729 Usually such routers are configured to send the message to a remote host via an
17730 &(smtp)& transport. The &%self%& option specifies what happens when the first
17731 host on the list turns out to be the local host.
17732 The way in which Exim checks for the local host is described in section
17733 &<<SECTreclocipadd>>&.
17734
17735 Normally this situation indicates either an error in Exim's configuration (for
17736 example, the router should be configured not to process this domain), or an
17737 error in the DNS (for example, the MX should not point to this host). For this
17738 reason, the default action is to log the incident, defer the address, and
17739 freeze the message. The following alternatives are provided for use in special
17740 cases:
17741
17742 .vlist
17743 .vitem &%defer%&
17744 Delivery of the message is tried again later, but the message is not frozen.
17745
17746 .vitem "&%reroute%&: <&'domain'&>"
17747 The domain is changed to the given domain, and the address is passed back to
17748 be reprocessed by the routers. No rewriting of headers takes place. This
17749 behaviour is essentially a redirection.
17750
17751 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17752 The domain is changed to the given domain, and the address is passed back to be
17753 reprocessed by the routers. Any headers that contain the original domain are
17754 rewritten.
17755
17756 .vitem &%pass%&
17757 .oindex "&%more%&"
17758 .vindex "&$self_hostname$&"
17759 The router passes the address to the next router, or to the router named in the
17760 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17761 subsequent routing and delivery, the variable &$self_hostname$& contains the
17762 name of the local host that the router encountered. This can be used to
17763 distinguish between different cases for hosts with multiple names. The
17764 combination
17765 .code
17766 self = pass
17767 no_more
17768 .endd
17769 ensures that only those addresses that routed to the local host are passed on.
17770 Without &%no_more%&, addresses that were declined for other reasons would also
17771 be passed to the next router.
17772
17773 .vitem &%fail%&
17774 Delivery fails and an error report is generated.
17775
17776 .vitem &%send%&
17777 .cindex "local host" "sending to"
17778 The anomaly is ignored and the address is queued for the transport. This
17779 setting should be used with extreme caution. For an &(smtp)& transport, it
17780 makes sense only in cases where the program that is listening on the SMTP port
17781 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17782 different configuration file that handles the domain in another way.
17783 .endlist
17784
17785
17786
17787 .option senders routers&!? "address list&!!" unset
17788 .cindex "router" "checking senders"
17789 If this option is set, the router is skipped unless the message's sender
17790 address matches something on the list.
17791 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17792 are evaluated.
17793
17794 There are issues concerning verification when the running of routers is
17795 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17796 setting, it sets the sender to the null string. When using the &%-bt%& option
17797 to check a configuration file, it is necessary also to use the &%-f%& option to
17798 set an appropriate sender. For incoming mail, the sender is unset when
17799 verifying the sender, but is available when verifying any recipients. If the
17800 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17801 matters.
17802
17803
17804 .option translate_ip_address routers string&!! unset
17805 .cindex "IP address" "translating"
17806 .cindex "packet radio"
17807 .cindex "router" "IP address translation"
17808 There exist some rare networking situations (for example, packet radio) where
17809 it is helpful to be able to translate IP addresses generated by normal routing
17810 mechanisms into other IP addresses, thus performing a kind of manual IP
17811 routing. This should be done only if the normal IP routing of the TCP/IP stack
17812 is inadequate or broken. Because this is an extremely uncommon requirement, the
17813 code to support this option is not included in the Exim binary unless
17814 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17815
17816 .vindex "&$host_address$&"
17817 The &%translate_ip_address%& string is expanded for every IP address generated
17818 by the router, with the generated address set in &$host_address$&. If the
17819 expansion is forced to fail, no action is taken.
17820 For any other expansion error, delivery of the message is deferred.
17821 If the result of the expansion is an IP address, that replaces the original
17822 address; otherwise the result is assumed to be a host name &-- this is looked
17823 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17824 produce one or more replacement IP addresses. For example, to subvert all IP
17825 addresses in some specific networks, this could be added to a router:
17826 .code
17827 translate_ip_address = \
17828   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17829     {$value}fail}}
17830 .endd
17831 The file would contain lines like
17832 .code
17833 10.2.3.128/26    some.host
17834 10.8.4.34/26     10.44.8.15
17835 .endd
17836 You should not make use of this facility unless you really understand what you
17837 are doing.
17838
17839
17840
17841 .option transport routers string&!! unset
17842 This option specifies the transport to be used when a router accepts an address
17843 and sets it up for delivery. A transport is never needed if a router is used
17844 only for verification. The value of the option is expanded at routing time,
17845 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17846 and result must be the name of one of the configured transports. If it is not,
17847 delivery is deferred.
17848
17849 The &%transport%& option is not used by the &(redirect)& router, but it does
17850 have some private options that set up transports for pipe and file deliveries
17851 (see chapter &<<CHAPredirect>>&).
17852
17853
17854
17855 .option transport_current_directory routers string&!! unset
17856 .cindex "current directory for local transport"
17857 This option associates a current directory with any address that is routed
17858 to a local transport. This can happen either because a transport is
17859 explicitly configured for the router, or because it generates a delivery to a
17860 file or a pipe. During the delivery process (that is, at transport time), this
17861 option string is expanded and is set as the current directory, unless
17862 overridden by a setting on the transport.
17863 If the expansion fails for any reason, including forced failure, an error is
17864 logged, and delivery is deferred.
17865 See chapter &<<CHAPenvironment>>& for details of the local delivery
17866 environment.
17867
17868
17869
17870
17871 .option transport_home_directory routers string&!! "see below"
17872 .cindex "home directory" "for local transport"
17873 This option associates a home directory with any address that is routed to a
17874 local transport. This can happen either because a transport is explicitly
17875 configured for the router, or because it generates a delivery to a file or a
17876 pipe. During the delivery process (that is, at transport time), the option
17877 string is expanded and is set as the home directory, unless overridden by a
17878 setting of &%home_directory%& on the transport.
17879 If the expansion fails for any reason, including forced failure, an error is
17880 logged, and delivery is deferred.
17881
17882 If the transport does not specify a home directory, and
17883 &%transport_home_directory%& is not set for the router, the home directory for
17884 the transport is taken from the password data if &%check_local_user%& is set for
17885 the router. Otherwise it is taken from &%router_home_directory%& if that option
17886 is set; if not, no home directory is set for the transport.
17887
17888 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17889 environment.
17890
17891
17892
17893
17894 .option unseen routers boolean&!! false
17895 .cindex "router" "carrying on after success"
17896 The result of string expansion for this option must be a valid boolean value,
17897 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17898 result causes an error, and delivery is deferred. If the expansion is forced to
17899 fail, the default value for the option (false) is used. Other failures cause
17900 delivery to be deferred.
17901
17902 When this option is set true, routing does not cease if the router accepts the
17903 address. Instead, a copy of the incoming address is passed to the next router,
17904 overriding a false setting of &%more%&. There is little point in setting
17905 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17906 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17907 sometimes true and sometimes false).
17908
17909 .cindex "copy of message (&%unseen%& option)"
17910 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17911 qualifier in filter files. It can be used to cause copies of messages to be
17912 delivered to some other destination, while also carrying out a normal delivery.
17913 In effect, the current address is made into a &"parent"& that has two children
17914 &-- one that is delivered as specified by this router, and a clone that goes on
17915 to be routed further. For this reason, &%unseen%& may not be combined with the
17916 &%one_time%& option in a &(redirect)& router.
17917
17918 &*Warning*&: Header lines added to the address (or specified for removal) by
17919 this router or by previous routers affect the &"unseen"& copy of the message
17920 only. The clone that continues to be processed by further routers starts with
17921 no added headers and none specified for removal. For a &%redirect%& router, if
17922 a generated address is the same as the incoming address, this can lead to
17923 duplicate addresses with different header modifications. Exim does not do
17924 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17925 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17926 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17927 &%redirect%& router may be of help.
17928
17929 Unlike the handling of header modifications, any data that was set by the
17930 &%address_data%& option in the current or previous routers &'is'& passed on to
17931 subsequent routers.
17932
17933
17934 .option user routers string&!! "see below"
17935 .cindex "uid (user id)" "local delivery"
17936 .cindex "local transports" "uid and gid"
17937 .cindex "transport" "local"
17938 .cindex "router" "user for filter processing"
17939 .cindex "filter" "user for processing"
17940 When a router queues an address for a transport, and the transport does not
17941 specify a user, the user given here is used when running the delivery process.
17942 The user may be specified numerically or by name. If expansion fails, the
17943 error is logged and delivery is deferred.
17944 This user is also used by the &(redirect)& router when running a filter file.
17945 The default is unset, except when &%check_local_user%& is set. In this case,
17946 the default is taken from the password information. If the user is specified as
17947 a name, and &%group%& is not set, the group associated with the user is used.
17948 See also &%initgroups%& and &%group%& and the discussion in chapter
17949 &<<CHAPenvironment>>&.
17950
17951
17952
17953 .option verify routers&!? boolean true
17954 Setting this option has the effect of setting &%verify_sender%& and
17955 &%verify_recipient%& to the same value.
17956
17957
17958 .option verify_only routers&!? boolean false
17959 .cindex "EXPN" "with &%verify_only%&"
17960 .oindex "&%-bv%&"
17961 .cindex "router" "used only when verifying"
17962 If this option is set, the router is used only when verifying an address,
17963 delivering in cutthrough mode or
17964 testing with the &%-bv%& option, not when actually doing a delivery, testing
17965 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17966 restricted to verifying only senders or recipients by means of
17967 &%verify_sender%& and &%verify_recipient%&.
17968
17969 &*Warning*&: When the router is being run to verify addresses for an incoming
17970 SMTP message, Exim is not running as root, but under its own uid. If the router
17971 accesses any files, you need to make sure that they are accessible to the Exim
17972 user or group.
17973
17974
17975 .option verify_recipient routers&!? boolean true
17976 If this option is false, the router is skipped when verifying recipient
17977 addresses,
17978 delivering in cutthrough mode
17979 or testing recipient verification using &%-bv%&.
17980 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17981 are evaluated.
17982 See also the &$verify_mode$& variable.
17983
17984
17985 .option verify_sender routers&!? boolean true
17986 If this option is false, the router is skipped when verifying sender addresses
17987 or testing sender verification using &%-bvs%&.
17988 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17989 are evaluated.
17990 See also the &$verify_mode$& variable.
17991 .ecindex IIDgenoprou1
17992 .ecindex IIDgenoprou2
17993
17994
17995
17996
17997
17998
17999 . ////////////////////////////////////////////////////////////////////////////
18000 . ////////////////////////////////////////////////////////////////////////////
18001
18002 .chapter "The accept router" "CHID4"
18003 .cindex "&(accept)& router"
18004 .cindex "routers" "&(accept)&"
18005 The &(accept)& router has no private options of its own. Unless it is being
18006 used purely for verification (see &%verify_only%&) a transport is required to
18007 be defined by the generic &%transport%& option. If the preconditions that are
18008 specified by generic options are met, the router accepts the address and queues
18009 it for the given transport. The most common use of this router is for setting
18010 up deliveries to local mailboxes. For example:
18011 .code
18012 localusers:
18013   driver = accept
18014   domains = mydomain.example
18015   check_local_user
18016   transport = local_delivery
18017 .endd
18018 The &%domains%& condition in this example checks the domain of the address, and
18019 &%check_local_user%& checks that the local part is the login of a local user.
18020 When both preconditions are met, the &(accept)& router runs, and queues the
18021 address for the &(local_delivery)& transport.
18022
18023
18024
18025
18026
18027
18028 . ////////////////////////////////////////////////////////////////////////////
18029 . ////////////////////////////////////////////////////////////////////////////
18030
18031 .chapter "The dnslookup router" "CHAPdnslookup"
18032 .scindex IIDdnsrou1 "&(dnslookup)& router"
18033 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18034 The &(dnslookup)& router looks up the hosts that handle mail for the
18035 recipient's domain in the DNS. A transport must always be set for this router,
18036 unless &%verify_only%& is set.
18037
18038 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18039 SRV records. If none are found, or if SRV support is not configured,
18040 MX records are looked up. If no MX records exist, address records are sought.
18041 However, &%mx_domains%& can be set to disable the direct use of address
18042 records.
18043
18044 MX records of equal priority are sorted by Exim into a random order. Exim then
18045 looks for address records for the host names obtained from MX or SRV records.
18046 When a host has more than one IP address, they are sorted into a random order,
18047 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18048 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18049 generic option, the router declines.
18050
18051 Unless they have the highest priority (lowest MX value), MX records that point
18052 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18053 are discarded, together with any other MX records of equal or lower priority.
18054
18055 .cindex "MX record" "pointing to local host"
18056 .cindex "local host" "MX pointing to"
18057 .oindex "&%self%&" "in &(dnslookup)& router"
18058 If the host pointed to by the highest priority MX record, or looked up as an
18059 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18060 happens is controlled by the generic &%self%& option.
18061
18062
18063 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18064 There have been problems with DNS servers when SRV records are looked up.
18065 Some mis-behaving servers return a DNS error or timeout when a non-existent
18066 SRV record is sought. Similar problems have in the past been reported for
18067 MX records. The global &%dns_again_means_nonexist%& option can help with this
18068 problem, but it is heavy-handed because it is a global option.
18069
18070 For this reason, there are two options, &%srv_fail_domains%& and
18071 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18072 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18073 an attempt to look up an SRV or MX record causes one of these results, and the
18074 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18075 such record"&. In the case of an SRV lookup, this means that the router
18076 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18077 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18078 case routing fails.
18079
18080
18081 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18082 .cindex "&(dnslookup)& router" "declines"
18083 There are a few cases where a &(dnslookup)& router will decline to accept
18084 an address; if such a router is expected to handle "all remaining non-local
18085 domains", then it is important to set &%no_more%&.
18086
18087 The router will defer rather than decline if the domain
18088 is found in the &%fail_defer_domains%& router option.
18089
18090 Reasons for a &(dnslookup)& router to decline currently include:
18091 .ilist
18092 The domain does not exist in DNS
18093 .next
18094 The domain exists but the MX record's host part is just "."; this is a common
18095 convention (borrowed from SRV) used to indicate that there is no such service
18096 for this domain and to not fall back to trying A/AAAA records.
18097 .next
18098 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18099 .next
18100 MX record points to a non-existent host.
18101 .next
18102 MX record points to an IP address and the main section option
18103 &%allow_mx_to_ip%& is not set.
18104 .next
18105 MX records exist and point to valid hosts, but all hosts resolve only to
18106 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18107 .next
18108 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18109 &%dns_check_names_pattern%& for handling one variant of this)
18110 .next
18111 &%check_secondary_mx%& is set on this router but the local host can
18112 not be found in the MX records (see below)
18113 .endlist
18114
18115
18116
18117
18118 .section "Private options for dnslookup" "SECID118"
18119 .cindex "options" "&(dnslookup)& router"
18120 The private options for the &(dnslookup)& router are as follows:
18121
18122 .option check_secondary_mx dnslookup boolean false
18123 .cindex "MX record" "checking for secondary"
18124 If this option is set, the router declines unless the local host is found in
18125 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18126 process domains for which the local host is a secondary mail exchanger
18127 differently to other domains. The way in which Exim decides whether a host is
18128 the local host is described in section &<<SECTreclocipadd>>&.
18129
18130
18131 .option check_srv dnslookup string&!! unset
18132 .cindex "SRV record" "enabling use of"
18133 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18134 addition to MX and address records. The support is disabled by default. To
18135 enable SRV support, set the &%check_srv%& option to the name of the service
18136 required. For example,
18137 .code
18138 check_srv = smtp
18139 .endd
18140 looks for SRV records that refer to the normal smtp service. The option is
18141 expanded, so the service name can vary from message to message or address
18142 to address. This might be helpful if SRV records are being used for a
18143 submission service. If the expansion is forced to fail, the &%check_srv%&
18144 option is ignored, and the router proceeds to look for MX records in the
18145 normal way.
18146
18147 When the expansion succeeds, the router searches first for SRV records for
18148 the given service (it assumes TCP protocol). A single SRV record with a
18149 host name that consists of just a single dot indicates &"no such service for
18150 this domain"&; if this is encountered, the router declines. If other kinds of
18151 SRV record are found, they are used to construct a host list for delivery
18152 according to the rules of RFC 2782. MX records are not sought in this case.
18153
18154 When no SRV records are found, MX records (and address records) are sought in
18155 the traditional way. In other words, SRV records take precedence over MX
18156 records, just as MX records take precedence over address records. Note that
18157 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18158 defined it. It is apparently believed that MX records are sufficient for email
18159 and that SRV records should not be used for this purpose. However, SRV records
18160 have an additional &"weight"& feature which some people might find useful when
18161 trying to split an SMTP load between hosts of different power.
18162
18163 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18164 when there is a DNS lookup error.
18165
18166
18167
18168
18169 .option fail_defer_domains dnslookup "domain list&!!" unset
18170 .cindex "MX record" "not found"
18171 DNS lookups for domains matching &%fail_defer_domains%&
18172 which find no matching record will cause the router to defer
18173 rather than the default behaviour of decline.
18174 This maybe be useful for queueing messages for a newly created
18175 domain while the DNS configuration is not ready.
18176 However, it will result in any message with mistyped domains
18177 also being queued.
18178
18179
18180 .option mx_domains dnslookup "domain list&!!" unset
18181 .cindex "MX record" "required to exist"
18182 .cindex "SRV record" "required to exist"
18183 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18184 record in order to be recognized. (The name of this option could be improved.)
18185 For example, if all the mail hosts in &'fict.example'& are known to have MX
18186 records, except for those in &'discworld.fict.example'&, you could use this
18187 setting:
18188 .code
18189 mx_domains = ! *.discworld.fict.example : *.fict.example
18190 .endd
18191 This specifies that messages addressed to a domain that matches the list but
18192 has no MX record should be bounced immediately instead of being routed using
18193 the address record.
18194
18195
18196 .option mx_fail_domains dnslookup "domain list&!!" unset
18197 If the DNS lookup for MX records for one of the domains in this list causes a
18198 DNS lookup error, Exim behaves as if no MX records were found. See section
18199 &<<SECTprowitdnsloo>>& for more discussion.
18200
18201
18202
18203
18204 .option qualify_single dnslookup boolean true
18205 .cindex "DNS" "resolver options"
18206 .cindex "DNS" "qualifying single-component names"
18207 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18208 lookups. Typically, but not standardly, this causes the resolver to qualify
18209 single-component names with the default domain. For example, on a machine
18210 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18211 &'thesaurus.ref.example'& inside the resolver. For details of what your
18212 resolver actually does, consult your man pages for &'resolver'& and
18213 &'resolv.conf'&.
18214
18215
18216
18217 .option rewrite_headers dnslookup boolean true
18218 .cindex "rewriting" "header lines"
18219 .cindex "header lines" "rewriting"
18220 If the domain name in the address that is being processed is not fully
18221 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18222 an address is specified as &'dormouse@teaparty'&, the domain might be
18223 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18224 occur as a result of setting the &%widen_domains%& option. If
18225 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18226 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18227 header lines of the message are rewritten with the full domain name.
18228
18229 This option should be turned off only when it is known that no message is
18230 ever going to be sent outside an environment where the abbreviation makes
18231 sense.
18232
18233 When an MX record is looked up in the DNS and matches a wildcard record, name
18234 servers normally return a record containing the name that has been looked up,
18235 making it impossible to detect whether a wildcard was present or not. However,
18236 some name servers have recently been seen to return the wildcard entry. If the
18237 name returned by a DNS lookup begins with an asterisk, it is not used for
18238 header rewriting.
18239
18240
18241 .option same_domain_copy_routing dnslookup boolean false
18242 .cindex "address" "copying routing"
18243 Addresses with the same domain are normally routed by the &(dnslookup)& router
18244 to the same list of hosts. However, this cannot be presumed, because the router
18245 options and preconditions may refer to the local part of the address. By
18246 default, therefore, Exim routes each address in a message independently. DNS
18247 servers run caches, so repeated DNS lookups are not normally expensive, and in
18248 any case, personal messages rarely have more than a few recipients.
18249
18250 If you are running mailing lists with large numbers of subscribers at the same
18251 domain, and you are using a &(dnslookup)& router which is independent of the
18252 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18253 lookups for identical domains in one message. In this case, when &(dnslookup)&
18254 routes an address to a remote transport, any other unrouted addresses in the
18255 message that have the same domain are automatically given the same routing
18256 without processing them independently,
18257 provided the following conditions are met:
18258
18259 .ilist
18260 No router that processed the address specified &%headers_add%& or
18261 &%headers_remove%&.
18262 .next
18263 The router did not change the address in any way, for example, by &"widening"&
18264 the domain.
18265 .endlist
18266
18267
18268
18269
18270 .option search_parents dnslookup boolean false
18271 .cindex "DNS" "resolver options"
18272 When this option is true, the resolver option RES_DNSRCH is set for DNS
18273 lookups. This is different from the &%qualify_single%& option in that it
18274 applies to domains containing dots. Typically, but not standardly, it causes
18275 the resolver to search for the name in the current domain and in parent
18276 domains. For example, on a machine in the &'fict.example'& domain, if looking
18277 up &'teaparty.wonderland'& failed, the resolver would try
18278 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18279 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18280
18281 Setting this option true can cause problems in domains that have a wildcard MX
18282 record, because any domain that does not have its own MX record matches the
18283 local wildcard.
18284
18285
18286
18287 .option srv_fail_domains dnslookup "domain list&!!" unset
18288 If the DNS lookup for SRV records for one of the domains in this list causes a
18289 DNS lookup error, Exim behaves as if no SRV records were found. See section
18290 &<<SECTprowitdnsloo>>& for more discussion.
18291
18292
18293
18294
18295 .option widen_domains dnslookup "string list" unset
18296 .cindex "domain" "partial; widening"
18297 If a DNS lookup fails and this option is set, each of its strings in turn is
18298 added onto the end of the domain, and the lookup is tried again. For example,
18299 if
18300 .code
18301 widen_domains = fict.example:ref.example
18302 .endd
18303 is set and a lookup of &'klingon.dictionary'& fails,
18304 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18305 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18306 and &%search_parents%& options can cause some widening to be undertaken inside
18307 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18308 when verifying, unless &%rewrite_headers%& is false (not the default).
18309
18310
18311 .section "Effect of qualify_single and search_parents" "SECID119"
18312 When a domain from an envelope recipient is changed by the resolver as a result
18313 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18314 corresponding address in the message's header lines unless &%rewrite_headers%&
18315 is set false. Exim then re-routes the address, using the full domain.
18316
18317 These two options affect only the DNS lookup that takes place inside the router
18318 for the domain of the address that is being routed. They do not affect lookups
18319 such as that implied by
18320 .code
18321 domains = @mx_any
18322 .endd
18323 that may happen while processing a router precondition before the router is
18324 entered. No widening ever takes place for these lookups.
18325 .ecindex IIDdnsrou1
18326 .ecindex IIDdnsrou2
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336 . ////////////////////////////////////////////////////////////////////////////
18337 . ////////////////////////////////////////////////////////////////////////////
18338
18339 .chapter "The ipliteral router" "CHID5"
18340 .cindex "&(ipliteral)& router"
18341 .cindex "domain literal" "routing"
18342 .cindex "routers" "&(ipliteral)&"
18343 This router has no private options. Unless it is being used purely for
18344 verification (see &%verify_only%&) a transport is required to be defined by the
18345 generic &%transport%& option. The router accepts the address if its domain part
18346 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18347 router handles the address
18348 .code
18349 root@[192.168.1.1]
18350 .endd
18351 by setting up delivery to the host with that IP address. IPv4 domain literals
18352 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18353 are similar, but the address is preceded by &`ipv6:`&. For example:
18354 .code
18355 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18356 .endd
18357 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18358 grounds that sooner or later somebody will try it.
18359
18360 .oindex "&%self%&" "in &(ipliteral)& router"
18361 If the IP address matches something in &%ignore_target_hosts%&, the router
18362 declines. If an IP literal turns out to refer to the local host, the generic
18363 &%self%& option determines what happens.
18364
18365 The RFCs require support for domain literals; however, their use is
18366 controversial in today's Internet. If you want to use this router, you must
18367 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18368 Exim will not recognize the domain literal syntax in addresses.
18369
18370
18371
18372 . ////////////////////////////////////////////////////////////////////////////
18373 . ////////////////////////////////////////////////////////////////////////////
18374
18375 .chapter "The iplookup router" "CHID6"
18376 .cindex "&(iplookup)& router"
18377 .cindex "routers" "&(iplookup)&"
18378 The &(iplookup)& router was written to fulfil a specific requirement in
18379 Cambridge University (which in fact no longer exists). For this reason, it is
18380 not included in the binary of Exim by default. If you want to include it, you
18381 must set
18382 .code
18383 ROUTER_IPLOOKUP=yes
18384 .endd
18385 in your &_Local/Makefile_& configuration file.
18386
18387 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18388 connection to one or more specific hosts. The host can then return the same or
18389 a different address &-- in effect rewriting the recipient address in the
18390 message's envelope. The new address is then passed on to subsequent routers. If
18391 this process fails, the address can be passed on to other routers, or delivery
18392 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18393 must not be specified for it.
18394
18395 .cindex "options" "&(iplookup)& router"
18396 .option hosts iplookup string unset
18397 This option must be supplied. Its value is a colon-separated list of host
18398 names. The hosts are looked up using &[gethostbyname()]&
18399 (or &[getipnodebyname()]& when available)
18400 and are tried in order until one responds to the query. If none respond, what
18401 happens is controlled by &%optional%&.
18402
18403
18404 .option optional iplookup boolean false
18405 If &%optional%& is true, if no response is obtained from any host, the address
18406 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18407 delivery to the address is deferred.
18408
18409
18410 .option port iplookup integer 0
18411 .cindex "port" "&(iplookup)& router"
18412 This option must be supplied. It specifies the port number for the TCP or UDP
18413 call.
18414
18415
18416 .option protocol iplookup string udp
18417 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18418 protocols is to be used.
18419
18420
18421 .option query iplookup string&!! "see below"
18422 This defines the content of the query that is sent to the remote hosts. The
18423 default value is:
18424 .code
18425 $local_part@$domain $local_part@$domain
18426 .endd
18427 The repetition serves as a way of checking that a response is to the correct
18428 query in the default case (see &%response_pattern%& below).
18429
18430
18431 .option reroute iplookup string&!! unset
18432 If this option is not set, the rerouted address is precisely the byte string
18433 returned by the remote host, up to the first white space, if any. If set, the
18434 string is expanded to form the rerouted address. It can include parts matched
18435 in the response by &%response_pattern%& by means of numeric variables such as
18436 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18437 whether or not a pattern is in use. In all cases, the rerouted address must end
18438 up in the form &'local_part@domain'&.
18439
18440
18441 .option response_pattern iplookup string unset
18442 This option can be set to a regular expression that is applied to the string
18443 returned from the remote host. If the pattern does not match the response, the
18444 router declines. If &%response_pattern%& is not set, no checking of the
18445 response is done, unless the query was defaulted, in which case there is a
18446 check that the text returned after the first white space is the original
18447 address. This checks that the answer that has been received is in response to
18448 the correct question. For example, if the response is just a new domain, the
18449 following could be used:
18450 .code
18451 response_pattern = ^([^@]+)$
18452 reroute = $local_part@$1
18453 .endd
18454
18455 .option timeout iplookup time 5s
18456 This specifies the amount of time to wait for a response from the remote
18457 machine. The same timeout is used for the &[connect()]& function for a TCP
18458 call. It does not apply to UDP.
18459
18460
18461
18462
18463 . ////////////////////////////////////////////////////////////////////////////
18464 . ////////////////////////////////////////////////////////////////////////////
18465
18466 .chapter "The manualroute router" "CHID7"
18467 .scindex IIDmanrou1 "&(manualroute)& router"
18468 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18469 .cindex "domain" "manually routing"
18470 The &(manualroute)& router is so-called because it provides a way of manually
18471 routing an address according to its domain. It is mainly used when you want to
18472 route addresses to remote hosts according to your own rules, bypassing the
18473 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18474 route to local transports, a facility that may be useful if you want to save
18475 messages for dial-in hosts in local files.
18476
18477 The &(manualroute)& router compares a list of domain patterns with the domain
18478 it is trying to route. If there is no match, the router declines. Each pattern
18479 has associated with it a list of hosts and some other optional data, which may
18480 include a transport. The combination of a pattern and its data is called a
18481 &"routing rule"&. For patterns that do not have an associated transport, the
18482 generic &%transport%& option must specify a transport, unless the router is
18483 being used purely for verification (see &%verify_only%&).
18484
18485 .vindex "&$host$&"
18486 In the case of verification, matching the domain pattern is sufficient for the
18487 router to accept the address. When actually routing an address for delivery,
18488 an address that matches a domain pattern is queued for the associated
18489 transport. If the transport is not a local one, a host list must be associated
18490 with the pattern; IP addresses are looked up for the hosts, and these are
18491 passed to the transport along with the mail address. For local transports, a
18492 host list is optional. If it is present, it is passed in &$host$& as a single
18493 text string.
18494
18495 The list of routing rules can be provided as an inline string in
18496 &%route_list%&, or the data can be obtained by looking up the domain in a file
18497 or database by setting &%route_data%&. Only one of these settings may appear in
18498 any one instance of &(manualroute)&. The format of routing rules is described
18499 below, following the list of private options.
18500
18501
18502 .section "Private options for manualroute" "SECTprioptman"
18503
18504 .cindex "options" "&(manualroute)& router"
18505 The private options for the &(manualroute)& router are as follows:
18506
18507 .option host_all_ignored manualroute string defer
18508 See &%host_find_failed%&.
18509
18510 .option host_find_failed manualroute string freeze
18511 This option controls what happens when &(manualroute)& tries to find an IP
18512 address for a host, and the host does not exist. The option can be set to one
18513 of the following values:
18514 .code
18515 decline
18516 defer
18517 fail
18518 freeze
18519 ignore
18520 pass
18521 .endd
18522 The default (&"freeze"&) assumes that this state is a serious configuration
18523 error. The difference between &"pass"& and &"decline"& is that the former
18524 forces the address to be passed to the next router (or the router defined by
18525 &%pass_router%&),
18526 .oindex "&%more%&"
18527 overriding &%no_more%&, whereas the latter passes the address to the next
18528 router only if &%more%& is true.
18529
18530 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18531 cannot be found. If all the hosts in the list are ignored, the behaviour is
18532 controlled by the &%host_all_ignored%& option. This takes the same values
18533 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18534
18535 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18536 state; if a host lookup gets a temporary error, delivery is deferred unless the
18537 generic &%pass_on_timeout%& option is set.
18538
18539
18540 .option hosts_randomize manualroute boolean false
18541 .cindex "randomized host list"
18542 .cindex "host" "list of; randomized"
18543 If this option is set, the order of the items in a host list in a routing rule
18544 is randomized each time the list is used, unless an option in the routing rule
18545 overrides (see below). Randomizing the order of a host list can be used to do
18546 crude load sharing. However, if more than one mail address is routed by the
18547 same router to the same host list, the host lists are considered to be the same
18548 (even though they may be randomized into different orders) for the purpose of
18549 deciding whether to batch the deliveries into a single SMTP transaction.
18550
18551 When &%hosts_randomize%& is true, a host list may be split
18552 into groups whose order is separately randomized. This makes it possible to
18553 set up MX-like behaviour. The boundaries between groups are indicated by an
18554 item that is just &`+`& in the host list. For example:
18555 .code
18556 route_list = * host1:host2:host3:+:host4:host5
18557 .endd
18558 The order of the first three hosts and the order of the last two hosts is
18559 randomized for each use, but the first three always end up before the last two.
18560 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18561 randomized host list is passed to an &(smtp)& transport that also has
18562 &%hosts_randomize set%&, the list is not re-randomized.
18563
18564
18565 .option route_data manualroute string&!! unset
18566 If this option is set, it must expand to yield the data part of a routing rule.
18567 Typically, the expansion string includes a lookup based on the domain. For
18568 example:
18569 .code
18570 route_data = ${lookup{$domain}dbm{/etc/routes}}
18571 .endd
18572 If the expansion is forced to fail, or the result is an empty string, the
18573 router declines. Other kinds of expansion failure cause delivery to be
18574 deferred.
18575
18576
18577 .option route_list manualroute "string list" unset
18578 This string is a list of routing rules, in the form defined below. Note that,
18579 unlike most string lists, the items are separated by semicolons. This is so
18580 that they may contain colon-separated host lists.
18581
18582
18583 .option same_domain_copy_routing manualroute boolean false
18584 .cindex "address" "copying routing"
18585 Addresses with the same domain are normally routed by the &(manualroute)&
18586 router to the same list of hosts. However, this cannot be presumed, because the
18587 router options and preconditions may refer to the local part of the address. By
18588 default, therefore, Exim routes each address in a message independently. DNS
18589 servers run caches, so repeated DNS lookups are not normally expensive, and in
18590 any case, personal messages rarely have more than a few recipients.
18591
18592 If you are running mailing lists with large numbers of subscribers at the same
18593 domain, and you are using a &(manualroute)& router which is independent of the
18594 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18595 lookups for identical domains in one message. In this case, when
18596 &(manualroute)& routes an address to a remote transport, any other unrouted
18597 addresses in the message that have the same domain are automatically given the
18598 same routing without processing them independently. However, this is only done
18599 if &%headers_add%& and &%headers_remove%& are unset.
18600
18601
18602
18603
18604 .section "Routing rules in route_list" "SECID120"
18605 The value of &%route_list%& is a string consisting of a sequence of routing
18606 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18607 entered as two semicolons. Alternatively, the list separator can be changed as
18608 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18609 Empty rules are ignored. The format of each rule is
18610 .display
18611 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18612 .endd
18613 The following example contains two rules, each with a simple domain pattern and
18614 no options:
18615 .code
18616 route_list = \
18617   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18618   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18619 .endd
18620 The three parts of a rule are separated by white space. The pattern and the
18621 list of hosts can be enclosed in quotes if necessary, and if they are, the
18622 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18623 single domain pattern, which is the only mandatory item in the rule. The
18624 pattern is in the same format as one item in a domain list (see section
18625 &<<SECTdomainlist>>&),
18626 except that it may not be the name of an interpolated file.
18627 That is, it may be wildcarded, or a regular expression, or a file or database
18628 lookup (with semicolons doubled, because of the use of semicolon as a separator
18629 in a &%route_list%&).
18630
18631 The rules in &%route_list%& are searched in order until one of the patterns
18632 matches the domain that is being routed. The list of hosts and then options are
18633 then used as described below. If there is no match, the router declines. When
18634 &%route_list%& is set, &%route_data%& must not be set.
18635
18636
18637
18638 .section "Routing rules in route_data" "SECID121"
18639 The use of &%route_list%& is convenient when there are only a small number of
18640 routing rules. For larger numbers, it is easier to use a file or database to
18641 hold the routing information, and use the &%route_data%& option instead.
18642 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18643 Most commonly, &%route_data%& is set as a string that contains an
18644 expansion lookup. For example, suppose we place two routing rules in a file
18645 like this:
18646 .code
18647 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18648 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18649 .endd
18650 This data can be accessed by setting
18651 .code
18652 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18653 .endd
18654 Failure of the lookup results in an empty string, causing the router to
18655 decline. However, you do not have to use a lookup in &%route_data%&. The only
18656 requirement is that the result of expanding the string is a list of hosts,
18657 possibly followed by options, separated by white space. The list of hosts must
18658 be enclosed in quotes if it contains white space.
18659
18660
18661
18662
18663 .section "Format of the list of hosts" "SECID122"
18664 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18665 always separately expanded before use. If the expansion fails, the router
18666 declines. The result of the expansion must be a colon-separated list of names
18667 and/or IP addresses, optionally also including ports. The format of each item
18668 in the list is described in the next section. The list separator can be changed
18669 as described in section &<<SECTlistconstruct>>&.
18670
18671 If the list of hosts was obtained from a &%route_list%& item, the following
18672 variables are set during its expansion:
18673
18674 .ilist
18675 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18676 If the domain was matched against a regular expression, the numeric variables
18677 &$1$&, &$2$&, etc. may be set. For example:
18678 .code
18679 route_list = ^domain(\d+)   host-$1.text.example
18680 .endd
18681 .next
18682 &$0$& is always set to the entire domain.
18683 .next
18684 &$1$& is also set when partial matching is done in a file lookup.
18685
18686 .next
18687 .vindex "&$value$&"
18688 If the pattern that matched the domain was a lookup item, the data that was
18689 looked up is available in the expansion variable &$value$&. For example:
18690 .code
18691 route_list = lsearch;;/some/file.routes  $value
18692 .endd
18693 .endlist
18694
18695 Note the doubling of the semicolon in the pattern that is necessary because
18696 semicolon is the default route list separator.
18697
18698
18699
18700 .section "Format of one host item" "SECTformatonehostitem"
18701 Each item in the list of hosts is either a host name or an IP address,
18702 optionally with an attached port number. When no port is given, an IP address
18703 is not enclosed in brackets. When a port is specified, it overrides the port
18704 specification on the transport. The port is separated from the name or address
18705 by a colon. This leads to some complications:
18706
18707 .ilist
18708 Because colon is the default separator for the list of hosts, either
18709 the colon that specifies a port must be doubled, or the list separator must
18710 be changed. The following two examples have the same effect:
18711 .code
18712 route_list = * "host1.tld::1225 : host2.tld::1226"
18713 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18714 .endd
18715 .next
18716 When IPv6 addresses are involved, it gets worse, because they contain
18717 colons of their own. To make this case easier, it is permitted to
18718 enclose an IP address (either v4 or v6) in square brackets if a port
18719 number follows. For example:
18720 .code
18721 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18722 .endd
18723 .endlist
18724
18725 .section "How the list of hosts is used" "SECThostshowused"
18726 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18727 the hosts is tried, in the order specified, when carrying out the SMTP
18728 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18729 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18730 transport.
18731
18732 Hosts may be listed by name or by IP address. An unadorned name in the list of
18733 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18734 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18735 records in the DNS. For example:
18736 .code
18737 route_list = *  x.y.z:p.q.r/MX:e.f.g
18738 .endd
18739 If this feature is used with a port specifier, the port must come last. For
18740 example:
18741 .code
18742 route_list = *  dom1.tld/mx::1225
18743 .endd
18744 If the &%hosts_randomize%& option is set, the order of the items in the list is
18745 randomized before any lookups are done. Exim then scans the list; for any name
18746 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18747 be an interface on the local host and the item is not the first in the list,
18748 Exim discards it and any subsequent items. If it is the first item, what
18749 happens is controlled by the
18750 .oindex "&%self%&" "in &(manualroute)& router"
18751 &%self%& option of the router.
18752
18753 A name on the list that is followed by &`/MX`& is replaced with the list of
18754 hosts obtained by looking up MX records for the name. This is always a DNS
18755 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18756 below) are not relevant here. The order of these hosts is determined by the
18757 preference values in the MX records, according to the usual rules. Because
18758 randomizing happens before the MX lookup, it does not affect the order that is
18759 defined by MX preferences.
18760
18761 If the local host is present in the sublist obtained from MX records, but is
18762 not the most preferred host in that list, it and any equally or less
18763 preferred hosts are removed before the sublist is inserted into the main list.
18764
18765 If the local host is the most preferred host in the MX list, what happens
18766 depends on where in the original list of hosts the &`/MX`& item appears. If it
18767 is not the first item (that is, there are previous hosts in the main list),
18768 Exim discards this name and any subsequent items in the main list.
18769
18770 If the MX item is first in the list of hosts, and the local host is the
18771 most preferred host, what happens is controlled by the &%self%& option of the
18772 router.
18773
18774 DNS failures when lookup up the MX records are treated in the same way as DNS
18775 failures when looking up IP addresses: &%pass_on_timeout%& and
18776 &%host_find_failed%& are used when relevant.
18777
18778 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18779 whether obtained from an MX lookup or not.
18780
18781
18782
18783 .section "How the options are used" "SECThowoptused"
18784 The options are a sequence of words; in practice no more than three are ever
18785 present. One of the words can be the name of a transport; this overrides the
18786 &%transport%& option on the router for this particular routing rule only. The
18787 other words (if present) control randomization of the list of hosts on a
18788 per-rule basis, and how the IP addresses of the hosts are to be found when
18789 routing to a remote transport. These options are as follows:
18790
18791 .ilist
18792 &%randomize%&: randomize the order of the hosts in this list, overriding the
18793 setting of &%hosts_randomize%& for this routing rule only.
18794 .next
18795 &%no_randomize%&: do not randomize the order of the hosts in this list,
18796 overriding the setting of &%hosts_randomize%& for this routing rule only.
18797 .next
18798 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18799 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18800 also look in &_/etc/hosts_& or other sources of information.
18801 .next
18802 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18803 no address records are found. If there is a temporary DNS error (such as a
18804 timeout), delivery is deferred.
18805 .endlist
18806
18807 For example:
18808 .code
18809 route_list = domain1  host1:host2:host3  randomize bydns;\
18810              domain2  host4:host5
18811 .endd
18812 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18813 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18814 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18815 or &[gethostbyname()]&, and the result of the lookup is the result of that
18816 call.
18817
18818 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18819 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18820 instead of TRY_AGAIN. That is why the default action is to try a DNS
18821 lookup first. Only if that gives a definite &"no such host"& is the local
18822 function called.
18823
18824
18825
18826 If no IP address for a host can be found, what happens is controlled by the
18827 &%host_find_failed%& option.
18828
18829 .vindex "&$host$&"
18830 When an address is routed to a local transport, IP addresses are not looked up.
18831 The host list is passed to the transport in the &$host$& variable.
18832
18833
18834
18835 .section "Manualroute examples" "SECID123"
18836 In some of the examples that follow, the presence of the &%remote_smtp%&
18837 transport, as defined in the default configuration file, is assumed:
18838
18839 .ilist
18840 .cindex "smart host" "example router"
18841 The &(manualroute)& router can be used to forward all external mail to a
18842 &'smart host'&. If you have set up, in the main part of the configuration, a
18843 named domain list that contains your local domains, for example:
18844 .code
18845 domainlist local_domains = my.domain.example
18846 .endd
18847 You can arrange for all other domains to be routed to a smart host by making
18848 your first router something like this:
18849 .code
18850 smart_route:
18851   driver = manualroute
18852   domains = !+local_domains
18853   transport = remote_smtp
18854   route_list = * smarthost.ref.example
18855 .endd
18856 This causes all non-local addresses to be sent to the single host
18857 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18858 they are tried in order
18859 (but you can use &%hosts_randomize%& to vary the order each time).
18860 Another way of configuring the same thing is this:
18861 .code
18862 smart_route:
18863   driver = manualroute
18864   transport = remote_smtp
18865   route_list = !+local_domains  smarthost.ref.example
18866 .endd
18867 There is no difference in behaviour between these two routers as they stand.
18868 However, they behave differently if &%no_more%& is added to them. In the first
18869 example, the router is skipped if the domain does not match the &%domains%&
18870 precondition; the following router is always tried. If the router runs, it
18871 always matches the domain and so can never decline. Therefore, &%no_more%&
18872 would have no effect. In the second case, the router is never skipped; it
18873 always runs. However, if it doesn't match the domain, it declines. In this case
18874 &%no_more%& would prevent subsequent routers from running.
18875
18876 .next
18877 .cindex "mail hub example"
18878 A &'mail hub'& is a host which receives mail for a number of domains via MX
18879 records in the DNS and delivers it via its own private routing mechanism. Often
18880 the final destinations are behind a firewall, with the mail hub being the one
18881 machine that can connect to machines both inside and outside the firewall. The
18882 &(manualroute)& router is usually used on a mail hub to route incoming messages
18883 to the correct hosts. For a small number of domains, the routing can be inline,
18884 using the &%route_list%& option, but for a larger number a file or database
18885 lookup is easier to manage.
18886
18887 If the domain names are in fact the names of the machines to which the mail is
18888 to be sent by the mail hub, the configuration can be quite simple. For
18889 example:
18890 .code
18891 hub_route:
18892   driver = manualroute
18893   transport = remote_smtp
18894   route_list = *.rhodes.tvs.example  $domain
18895 .endd
18896 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18897 whose names are the same as the mail domains. A similar approach can be taken
18898 if the host name can be obtained from the domain name by a string manipulation
18899 that the expansion facilities can handle. Otherwise, a lookup based on the
18900 domain can be used to find the host:
18901 .code
18902 through_firewall:
18903   driver = manualroute
18904   transport = remote_smtp
18905   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18906 .endd
18907 The result of the lookup must be the name or IP address of the host (or
18908 hosts) to which the address is to be routed. If the lookup fails, the route
18909 data is empty, causing the router to decline. The address then passes to the
18910 next router.
18911
18912 .next
18913 .cindex "batched SMTP output example"
18914 .cindex "SMTP" "batched outgoing; example"
18915 You can use &(manualroute)& to deliver messages to pipes or files in batched
18916 SMTP format for onward transportation by some other means. This is one way of
18917 storing mail for a dial-up host when it is not connected. The route list entry
18918 can be as simple as a single domain name in a configuration like this:
18919 .code
18920 save_in_file:
18921   driver = manualroute
18922   transport = batchsmtp_appendfile
18923   route_list = saved.domain.example
18924 .endd
18925 though often a pattern is used to pick up more than one domain. If there are
18926 several domains or groups of domains with different transport requirements,
18927 different transports can be listed in the routing information:
18928 .code
18929 save_in_file:
18930   driver = manualroute
18931   route_list = \
18932     *.saved.domain1.example  $domain  batch_appendfile; \
18933     *.saved.domain2.example  \
18934       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18935       batch_pipe
18936 .endd
18937 .vindex "&$domain$&"
18938 .vindex "&$host$&"
18939 The first of these just passes the domain in the &$host$& variable, which
18940 doesn't achieve much (since it is also in &$domain$&), but the second does a
18941 file lookup to find a value to pass, causing the router to decline to handle
18942 the address if the lookup fails.
18943
18944 .next
18945 .cindex "UUCP" "example of router for"
18946 Routing mail directly to UUCP software is a specific case of the use of
18947 &(manualroute)& in a gateway to another mail environment. This is an example of
18948 one way it can be done:
18949 .code
18950 # Transport
18951 uucp:
18952   driver = pipe
18953   user = nobody
18954   command = /usr/local/bin/uux -r - \
18955     ${substr_-5:$host}!rmail ${local_part}
18956   return_fail_output = true
18957
18958 # Router
18959 uucphost:
18960   transport = uucp
18961   driver = manualroute
18962   route_data = \
18963     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18964 .endd
18965 The file &_/usr/local/exim/uucphosts_& contains entries like
18966 .code
18967 darksite.ethereal.example:           darksite.UUCP
18968 .endd
18969 It can be set up more simply without adding and removing &".UUCP"& but this way
18970 makes clear the distinction between the domain name
18971 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18972 .endlist
18973 .ecindex IIDmanrou1
18974 .ecindex IIDmanrou2
18975
18976
18977
18978
18979
18980
18981
18982
18983 . ////////////////////////////////////////////////////////////////////////////
18984 . ////////////////////////////////////////////////////////////////////////////
18985
18986 .chapter "The queryprogram router" "CHAPdriverlast"
18987 .scindex IIDquerou1 "&(queryprogram)& router"
18988 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18989 .cindex "routing" "by external program"
18990 The &(queryprogram)& router routes an address by running an external command
18991 and acting on its output. This is an expensive way to route, and is intended
18992 mainly for use in lightly-loaded systems, or for performing experiments.
18993 However, if it is possible to use the precondition options (&%domains%&,
18994 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18995 be used in special cases, even on a busy host. There are the following private
18996 options:
18997 .cindex "options" "&(queryprogram)& router"
18998
18999 .option command queryprogram string&!! unset
19000 This option must be set. It specifies the command that is to be run. The
19001 command is split up into a command name and arguments, and then each is
19002 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19003 &<<CHAPpipetransport>>&).
19004
19005
19006 .option command_group queryprogram string unset
19007 .cindex "gid (group id)" "in &(queryprogram)& router"
19008 This option specifies a gid to be set when running the command while routing an
19009 address for deliver. It must be set if &%command_user%& specifies a numerical
19010 uid. If it begins with a digit, it is interpreted as the numerical value of the
19011 gid. Otherwise it is looked up using &[getgrnam()]&.
19012
19013
19014 .option command_user queryprogram string unset
19015 .cindex "uid (user id)" "for &(queryprogram)&"
19016 This option must be set. It specifies the uid which is set when running the
19017 command while routing an address for delivery. If the value begins with a digit,
19018 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19019 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19020 not set, a value for the gid also.
19021
19022 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19023 root, which it does during a normal delivery in a conventional configuration.
19024 However, when an address is being verified during message reception, Exim is
19025 usually running as the Exim user, not as root. If the &(queryprogram)& router
19026 is called from a non-root process, Exim cannot change uid or gid before running
19027 the command. In this circumstance the command runs under the current uid and
19028 gid.
19029
19030
19031 .option current_directory queryprogram string /
19032 This option specifies an absolute path which is made the current directory
19033 before running the command.
19034
19035
19036 .option timeout queryprogram time 1h
19037 If the command does not complete within the timeout period, its process group
19038 is killed and the message is frozen. A value of zero time specifies no
19039 timeout.
19040
19041
19042 The standard output of the command is connected to a pipe, which is read when
19043 the command terminates. It should consist of a single line of output,
19044 containing up to five fields, separated by white space. The maximum length of
19045 the line is 1023 characters. Longer lines are silently truncated. The first
19046 field is one of the following words (case-insensitive):
19047
19048 .ilist
19049 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19050 below).
19051 .next
19052 &'Decline'&: the router declines; pass the address to the next router, unless
19053 &%no_more%& is set.
19054 .next
19055 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19056 subsequent text on the line is an error message. If the router is run as part
19057 of address verification during an incoming SMTP message, the message is
19058 included in the SMTP response.
19059 .next
19060 &'Defer'&: routing could not be completed at this time; try again later. Any
19061 subsequent text on the line is an error message which is logged. It is not
19062 included in any SMTP response.
19063 .next
19064 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19065 .next
19066 &'Pass'&: pass the address to the next router (or the router specified by
19067 &%pass_router%&), overriding &%no_more%&.
19068 .next
19069 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19070 new addresses, which are routed independently, starting with the first router,
19071 or the router specified by &%redirect_router%&, if set.
19072 .endlist
19073
19074 When the first word is &'accept'&, the remainder of the line consists of a
19075 number of keyed data values, as follows (split into two lines here, to fit on
19076 the page):
19077 .code
19078 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19079 LOOKUP=byname|bydns DATA=<text>
19080 .endd
19081 The data items can be given in any order, and all are optional. If no transport
19082 is included, the transport specified by the generic &%transport%& option is
19083 used. The list of hosts and the lookup type are needed only if the transport is
19084 an &(smtp)& transport that does not itself supply a list of hosts.
19085
19086 The format of the list of hosts is the same as for the &(manualroute)& router.
19087 As well as host names and IP addresses with optional port numbers, as described
19088 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19089 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19090 (see section &<<SECThostshowused>>&).
19091
19092 If the lookup type is not specified, Exim behaves as follows when trying to
19093 find an IP address for each host: First, a DNS lookup is done. If this yields
19094 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19095 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19096 result of the lookup is the result of that call.
19097
19098 .vindex "&$address_data$&"
19099 If the DATA field is set, its value is placed in the &$address_data$&
19100 variable. For example, this return line
19101 .code
19102 accept hosts=x1.y.example:x2.y.example data="rule1"
19103 .endd
19104 routes the address to the default transport, passing a list of two hosts. When
19105 the transport runs, the string &"rule1"& is in &$address_data$&.
19106 .ecindex IIDquerou1
19107 .ecindex IIDquerou2
19108
19109
19110
19111
19112 . ////////////////////////////////////////////////////////////////////////////
19113 . ////////////////////////////////////////////////////////////////////////////
19114
19115 .chapter "The redirect router" "CHAPredirect"
19116 .scindex IIDredrou1 "&(redirect)& router"
19117 .scindex IIDredrou2 "routers" "&(redirect)&"
19118 .cindex "alias file" "in a &(redirect)& router"
19119 .cindex "address redirection" "&(redirect)& router"
19120 The &(redirect)& router handles several kinds of address redirection. Its most
19121 common uses are for resolving local part aliases from a central alias file
19122 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19123 files, but it has many other potential uses. The incoming address can be
19124 redirected in several different ways:
19125
19126 .ilist
19127 It can be replaced by one or more new addresses which are themselves routed
19128 independently.
19129 .next
19130 It can be routed to be delivered to a given file or directory.
19131 .next
19132 It can be routed to be delivered to a specified pipe command.
19133 .next
19134 It can cause an automatic reply to be generated.
19135 .next
19136 It can be forced to fail, optionally with a custom error message.
19137 .next
19138 It can be temporarily deferred, optionally with a custom message.
19139 .next
19140 It can be discarded.
19141 .endlist
19142
19143 The generic &%transport%& option must not be set for &(redirect)& routers.
19144 However, there are some private options which define transports for delivery to
19145 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19146 &%pipe_transport%& and &%reply_transport%& descriptions below.
19147
19148 .new
19149 If success DSNs have been requested
19150 .cindex "DSN" "success"
19151 .cindex "Delivery Status Notification" "success"
19152 redirection triggers one and the DSN options are not passed any further.
19153 .wen
19154
19155
19156
19157 .section "Redirection data" "SECID124"
19158 The router operates by interpreting a text string which it obtains either by
19159 expanding the contents of the &%data%& option, or by reading the entire
19160 contents of a file whose name is given in the &%file%& option. These two
19161 options are mutually exclusive. The first is commonly used for handling system
19162 aliases, in a configuration like this:
19163 .code
19164 system_aliases:
19165   driver = redirect
19166   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19167 .endd
19168 If the lookup fails, the expanded string in this example is empty. When the
19169 expansion of &%data%& results in an empty string, the router declines. A forced
19170 expansion failure also causes the router to decline; other expansion failures
19171 cause delivery to be deferred.
19172
19173 A configuration using &%file%& is commonly used for handling users'
19174 &_.forward_& files, like this:
19175 .code
19176 userforward:
19177   driver = redirect
19178   check_local_user
19179   file = $home/.forward
19180   no_verify
19181 .endd
19182 If the file does not exist, or causes no action to be taken (for example, it is
19183 empty or consists only of comments), the router declines. &*Warning*&: This
19184 is not the case when the file contains syntactically valid items that happen to
19185 yield empty addresses, for example, items containing only RFC 2822 address
19186 comments.
19187
19188
19189
19190 .section "Forward files and address verification" "SECID125"
19191 .cindex "address redirection" "while verifying"
19192 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19193 &_.forward_& files, as in the example above. There are two reasons for this:
19194
19195 .ilist
19196 When Exim is receiving an incoming SMTP message from a remote host, it is
19197 running under the Exim uid, not as root. Exim is unable to change uid to read
19198 the file as the user, and it may not be able to read it as the Exim user. So in
19199 practice the router may not be able to operate.
19200 .next
19201 However, even when the router can operate, the existence of a &_.forward_& file
19202 is unimportant when verifying an address. What should be checked is whether the
19203 local part is a valid user name or not. Cutting out the redirection processing
19204 saves some resources.
19205 .endlist
19206
19207
19208
19209
19210
19211
19212 .section "Interpreting redirection data" "SECID126"
19213 .cindex "Sieve filter" "specifying in redirection data"
19214 .cindex "filter" "specifying in redirection data"
19215 The contents of the data string, whether obtained from &%data%& or &%file%&,
19216 can be interpreted in two different ways:
19217
19218 .ilist
19219 If the &%allow_filter%& option is set true, and the data begins with the text
19220 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19221 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19222 respectively. Details of the syntax and semantics of filter files are described
19223 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19224 document is intended for use by end users.
19225 .next
19226 Otherwise, the data must be a comma-separated list of redirection items, as
19227 described in the next section.
19228 .endlist
19229
19230 When a message is redirected to a file (a &"mail folder"&), the file name given
19231 in a non-filter redirection list must always be an absolute path. A filter may
19232 generate a relative path &-- how this is handled depends on the transport's
19233 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19234 for the &(appendfile)& transport.
19235
19236
19237
19238 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19239 .cindex "address redirection" "non-filter list items"
19240 When the redirection data is not an Exim or Sieve filter, for example, if it
19241 comes from a conventional alias or forward file, it consists of a list of
19242 addresses, file names, pipe commands, or certain special items (see section
19243 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19244 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19245 depending on their default values. The items in the list are separated by
19246 commas or newlines.
19247 If a comma is required in an item, the entire item must be enclosed in double
19248 quotes.
19249
19250 Lines starting with a # character are comments, and are ignored, and # may
19251 also appear following a comma, in which case everything between the # and the
19252 next newline character is ignored.
19253
19254 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19255 double quotes are retained because some forms of mail address require their use
19256 (but never to enclose the entire address). In the following description,
19257 &"item"& refers to what remains after any surrounding double quotes have been
19258 removed.
19259
19260 .vindex "&$local_part$&"
19261 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19262 and the expansion contains a reference to &$local_part$&, you should make use
19263 of the &%quote_local_part%& expansion operator, in case the local part contains
19264 special characters. For example, to redirect all mail for the domain
19265 &'obsolete.example'&, retaining the existing local part, you could use this
19266 setting:
19267 .code
19268 data = ${quote_local_part:$local_part}@newdomain.example
19269 .endd
19270
19271
19272 .section "Redirecting to a local mailbox" "SECTredlocmai"
19273 .cindex "routing" "loops in"
19274 .cindex "loop" "while routing, avoidance of"
19275 .cindex "address redirection" "to local mailbox"
19276 A redirection item may safely be the same as the address currently under
19277 consideration. This does not cause a routing loop, because a router is
19278 automatically skipped if any ancestor of the address that is being processed
19279 is the same as the current address and was processed by the current router.
19280 Such an address is therefore passed to the following routers, so it is handled
19281 as if there were no redirection. When making this loop-avoidance test, the
19282 complete local part, including any prefix or suffix, is used.
19283
19284 .cindex "address redirection" "local part without domain"
19285 Specifying the same local part without a domain is a common usage in personal
19286 filter files when the user wants to have messages delivered to the local
19287 mailbox and also forwarded elsewhere. For example, the user whose login is
19288 &'cleo'& might have a &_.forward_& file containing this:
19289 .code
19290 cleo, cleopatra@egypt.example
19291 .endd
19292 .cindex "backslash in alias file"
19293 .cindex "alias file" "backslash in"
19294 For compatibility with other MTAs, such unqualified local parts may be
19295 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19296 it does make a difference if more than one domain is being handled
19297 synonymously.
19298
19299 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19300 2822 address that does not include a domain, the item is qualified using the
19301 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19302 addresses are qualified using the value in &%qualify_recipient%&, but you can
19303 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19304
19305 Care must be taken if there are alias names for local users.
19306 Consider an MTA handling a single local domain where the system alias file
19307 contains:
19308 .code
19309 Sam.Reman: spqr
19310 .endd
19311 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19312 messages in the local mailbox, and also forward copies elsewhere. He creates
19313 this forward file:
19314 .code
19315 Sam.Reman, spqr@reme.elsewhere.example
19316 .endd
19317 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19318 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19319 second time round, because it has previously routed it,
19320 and the following routers presumably cannot handle the alias. The forward file
19321 should really contain
19322 .code
19323 spqr, spqr@reme.elsewhere.example
19324 .endd
19325 but because this is such a common error, the &%check_ancestor%& option (see
19326 below) exists to provide a way to get round it. This is normally set on a
19327 &(redirect)& router that is handling users' &_.forward_& files.
19328
19329
19330
19331 .section "Special items in redirection lists" "SECTspecitredli"
19332 In addition to addresses, the following types of item may appear in redirection
19333 lists (that is, in non-filter redirection data):
19334
19335 .ilist
19336 .cindex "pipe" "in redirection list"
19337 .cindex "address redirection" "to pipe"
19338 An item is treated as a pipe command if it begins with &"|"& and does not parse
19339 as a valid RFC 2822 address that includes a domain. A transport for running the
19340 command must be specified by the &%pipe_transport%& option.
19341 Normally, either the router or the transport specifies a user and a group under
19342 which to run the delivery. The default is to use the Exim user and group.
19343
19344 Single or double quotes can be used for enclosing the individual arguments of
19345 the pipe command; no interpretation of escapes is done for single quotes. If
19346 the command contains a comma character, it is necessary to put the whole item
19347 in double quotes, for example:
19348 .code
19349 "|/some/command ready,steady,go"
19350 .endd
19351 since items in redirection lists are terminated by commas. Do not, however,
19352 quote just the command. An item such as
19353 .code
19354 |"/some/command ready,steady,go"
19355 .endd
19356 is interpreted as a pipe with a rather strange command name, and no arguments.
19357
19358 Note that the above example assumes that the text comes from a lookup source
19359 of some sort, so that the quotes are part of the data.  If composing a
19360 redirect router with a &%data%& option directly specifying this command, the
19361 quotes will be used by the configuration parser to define the extent of one
19362 string, but will not be passed down into the redirect router itself.  There
19363 are two main approaches to get around this: escape quotes to be part of the
19364 data itself, or avoid using this mechanism and instead create a custom
19365 transport with the &%command%& option set and reference that transport from
19366 an &%accept%& router.
19367
19368 .next
19369 .cindex "file" "in redirection list"
19370 .cindex "address redirection" "to file"
19371 An item is interpreted as a path name if it begins with &"/"& and does not
19372 parse as a valid RFC 2822 address that includes a domain. For example,
19373 .code
19374 /home/world/minbari
19375 .endd
19376 is treated as a file name, but
19377 .code
19378 /s=molari/o=babylon/@x400gate.way
19379 .endd
19380 is treated as an address. For a file name, a transport must be specified using
19381 the &%file_transport%& option. However, if the generated path name ends with a
19382 forward slash character, it is interpreted as a directory name rather than a
19383 file name, and &%directory_transport%& is used instead.
19384
19385 Normally, either the router or the transport specifies a user and a group under
19386 which to run the delivery. The default is to use the Exim user and group.
19387
19388 .cindex "&_/dev/null_&"
19389 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19390 bypassed at a high level, and the log entry shows &"**bypassed**"&
19391 instead of a transport name. In this case the user and group are not used.
19392
19393 .next
19394 .cindex "included address list"
19395 .cindex "address redirection" "included external list"
19396 If an item is of the form
19397 .code
19398 :include:<path name>
19399 .endd
19400 a list of further items is taken from the given file and included at that
19401 point. &*Note*&: Such a file can not be a filter file; it is just an
19402 out-of-line addition to the list. The items in the included list are separated
19403 by commas or newlines and are not subject to expansion. If this is the first
19404 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19405 the alias name. This example is incorrect:
19406 .code
19407 list1    :include:/opt/lists/list1
19408 .endd
19409 It must be given as
19410 .code
19411 list1:   :include:/opt/lists/list1
19412 .endd
19413 .next
19414 .cindex "address redirection" "to black hole"
19415 Sometimes you want to throw away mail to a particular local part. Making the
19416 &%data%& option expand to an empty string does not work, because that causes
19417 the router to decline. Instead, the alias item
19418 .cindex "black hole"
19419 .cindex "abandoning mail"
19420 &':blackhole:'& can be used. It does what its name implies. No delivery is
19421 done, and no error message is generated. This has the same effect as specifing
19422 &_/dev/null_& as a destination, but it can be independently disabled.
19423
19424 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19425 delivery is done for the original local part, even if other redirection items
19426 are present. If you are generating a multi-item list (for example, by reading a
19427 database) and need the ability to provide a no-op item, you must use
19428 &_/dev/null_&.
19429
19430 .next
19431 .cindex "delivery" "forcing failure"
19432 .cindex "delivery" "forcing deferral"
19433 .cindex "failing delivery" "forcing"
19434 .cindex "deferred delivery, forcing"
19435 .cindex "customizing" "failure message"
19436 An attempt to deliver a particular address can be deferred or forced to fail by
19437 redirection items of the form
19438 .code
19439 :defer:
19440 :fail:
19441 .endd
19442 respectively. When a redirection list contains such an item, it applies
19443 to the entire redirection; any other items in the list are ignored. Any
19444 text following &':fail:'& or &':defer:'& is placed in the error text
19445 associated with the failure. For example, an alias file might contain:
19446 .code
19447 X.Employee:  :fail: Gone away, no forwarding address
19448 .endd
19449 In the case of an address that is being verified from an ACL or as the subject
19450 of a
19451 .cindex "VRFY" "error text, display of"
19452 VRFY command, the text is included in the SMTP error response by
19453 default.
19454 .cindex "EXPN" "error text, display of"
19455 The text is not included in the response to an EXPN command. In non-SMTP cases
19456 the text is included in the error message that Exim generates.
19457
19458 .cindex "SMTP" "error codes"
19459 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19460 &':fail:'&. However, if the message starts with three digits followed by a
19461 space, optionally followed by an extended code of the form &'n.n.n'&, also
19462 followed by a space, and the very first digit is the same as the default error
19463 code, the code from the message is used instead. If the very first digit is
19464 incorrect, a panic error is logged, and the default code is used. You can
19465 suppress the use of the supplied code in a redirect router by setting the
19466 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19467 ignored.
19468
19469 .vindex "&$acl_verify_message$&"
19470 In an ACL, an explicitly provided message overrides the default, but the
19471 default message is available in the variable &$acl_verify_message$& and can
19472 therefore be included in a custom message if this is desired.
19473
19474 Normally the error text is the rest of the redirection list &-- a comma does
19475 not terminate it &-- but a newline does act as a terminator. Newlines are not
19476 normally present in alias expansions. In &(lsearch)& lookups they are removed
19477 as part of the continuation process, but they may exist in other kinds of
19478 lookup and in &':include:'& files.
19479
19480 During routing for message delivery (as opposed to verification), a redirection
19481 containing &':fail:'& causes an immediate failure of the incoming address,
19482 whereas &':defer:'& causes the message to remain on the queue so that a
19483 subsequent delivery attempt can happen at a later time. If an address is
19484 deferred for too long, it will ultimately fail, because the normal retry
19485 rules still apply.
19486
19487 .next
19488 .cindex "alias file" "exception to default"
19489 Sometimes it is useful to use a single-key search type with a default (see
19490 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19491 for exceptions to the default. These can be handled by aliasing them to
19492 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19493 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19494 results in an empty redirection list has the same effect.
19495 .endlist
19496
19497
19498 .section "Duplicate addresses" "SECTdupaddr"
19499 .cindex "duplicate addresses"
19500 .cindex "address duplicate, discarding"
19501 .cindex "pipe" "duplicated"
19502 Exim removes duplicate addresses from the list to which it is delivering, so as
19503 to deliver just one copy to each address. This does not apply to deliveries
19504 routed to pipes by different immediate parent addresses, but an indirect
19505 aliasing scheme of the type
19506 .code
19507 pipe:       |/some/command $local_part
19508 localpart1: pipe
19509 localpart2: pipe
19510 .endd
19511 does not work with a message that is addressed to both local parts, because
19512 when the second is aliased to the intermediate local part &"pipe"& it gets
19513 discarded as being the same as a previously handled address. However, a scheme
19514 such as
19515 .code
19516 localpart1: |/some/command $local_part
19517 localpart2: |/some/command $local_part
19518 .endd
19519 does result in two different pipe deliveries, because the immediate parents of
19520 the pipes are distinct.
19521
19522
19523
19524 .section "Repeated redirection expansion" "SECID128"
19525 .cindex "repeated redirection expansion"
19526 .cindex "address redirection" "repeated for each delivery attempt"
19527 When a message cannot be delivered to all of its recipients immediately,
19528 leading to two or more delivery attempts, redirection expansion is carried out
19529 afresh each time for those addresses whose children were not all previously
19530 delivered. If redirection is being used as a mailing list, this can lead to new
19531 members of the list receiving copies of old messages. The &%one_time%& option
19532 can be used to avoid this.
19533
19534
19535 .section "Errors in redirection lists" "SECID129"
19536 .cindex "address redirection" "errors"
19537 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19538 error is skipped, and an entry is written to the main log. This may be useful
19539 for mailing lists that are automatically managed. Otherwise, if an error is
19540 detected while generating the list of new addresses, the original address is
19541 deferred. See also &%syntax_errors_to%&.
19542
19543
19544
19545 .section "Private options for the redirect router" "SECID130"
19546
19547 .cindex "options" "&(redirect)& router"
19548 The private options for the &(redirect)& router are as follows:
19549
19550
19551 .option allow_defer redirect boolean false
19552 Setting this option allows the use of &':defer:'& in non-filter redirection
19553 data, or the &%defer%& command in an Exim filter file.
19554
19555
19556 .option allow_fail redirect boolean false
19557 .cindex "failing delivery" "from filter"
19558 If this option is true, the &':fail:'& item can be used in a redirection list,
19559 and the &%fail%& command may be used in an Exim filter file.
19560
19561
19562 .option allow_filter redirect boolean false
19563 .cindex "filter" "enabling use of"
19564 .cindex "Sieve filter" "enabling use of"
19565 Setting this option allows Exim to interpret redirection data that starts with
19566 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19567 are some features of Exim filter files that some administrators may wish to
19568 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19569
19570 It is also possible to lock out Exim filters or Sieve filters while allowing
19571 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19572
19573
19574 The filter is run using the uid and gid set by the generic &%user%& and
19575 &%group%& options. These take their defaults from the password data if
19576 &%check_local_user%& is set, so in the normal case of users' personal filter
19577 files, the filter is run as the relevant user. When &%allow_filter%& is set
19578 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19579
19580
19581
19582 .option allow_freeze redirect boolean false
19583 .cindex "freezing messages" "allowing in filter"
19584 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19585 This command is more normally encountered in system filters, and is disabled by
19586 default for redirection filters because it isn't something you usually want to
19587 let ordinary users do.
19588
19589
19590
19591 .option check_ancestor redirect boolean false
19592 This option is concerned with handling generated addresses that are the same
19593 as some address in the list of redirection ancestors of the current address.
19594 Although it is turned off by default in the code, it is set in the default
19595 configuration file for handling users' &_.forward_& files. It is recommended
19596 for this use of the &(redirect)& router.
19597
19598 When &%check_ancestor%& is set, if a generated address (including the domain)
19599 is the same as any ancestor of the current address, it is replaced by a copy of
19600 the current address. This helps in the case where local part A is aliased to B,
19601 and B has a &_.forward_& file pointing back to A. For example, within a single
19602 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19603 &_&~jb/.forward_& contains:
19604 .code
19605 \Joe.Bloggs, <other item(s)>
19606 .endd
19607 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19608 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19609 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19610 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19611 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19612 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19613 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19614 original address. See also the &%repeat_use%& option below.
19615
19616
19617 .option check_group redirect boolean "see below"
19618 When the &%file%& option is used, the group owner of the file is checked only
19619 when this option is set. The permitted groups are those listed in the
19620 &%owngroups%& option, together with the user's default group if
19621 &%check_local_user%& is set. If the file has the wrong group, routing is
19622 deferred. The default setting for this option is true if &%check_local_user%&
19623 is set and the &%modemask%& option permits the group write bit, or if the
19624 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19625
19626
19627
19628 .option check_owner redirect boolean "see below"
19629 When the &%file%& option is used, the owner of the file is checked only when
19630 this option is set. If &%check_local_user%& is set, the local user is
19631 permitted; otherwise the owner must be one of those listed in the &%owners%&
19632 option. The default value for this option is true if &%check_local_user%& or
19633 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19634
19635
19636 .option data redirect string&!! unset
19637 This option is mutually exclusive with &%file%&. One or other of them must be
19638 set, but not both. The contents of &%data%& are expanded, and then used as the
19639 list of forwarding items, or as a set of filtering instructions. If the
19640 expansion is forced to fail, or the result is an empty string or a string that
19641 has no effect (consists entirely of comments), the router declines.
19642
19643 When filtering instructions are used, the string must begin with &"#Exim
19644 filter"&, and all comments in the string, including this initial one, must be
19645 terminated with newline characters. For example:
19646 .code
19647 data = #Exim filter\n\
19648        if $h_to: contains Exim then save $home/mail/exim endif
19649 .endd
19650 If you are reading the data from a database where newlines cannot be included,
19651 you can use the &${sg}$& expansion item to turn the escape string of your
19652 choice into a newline.
19653
19654
19655 .option directory_transport redirect string&!! unset
19656 A &(redirect)& router sets up a direct delivery to a directory when a path name
19657 ending with a slash is specified as a new &"address"&. The transport used is
19658 specified by this option, which, after expansion, must be the name of a
19659 configured transport. This should normally be an &(appendfile)& transport.
19660
19661
19662 .option file redirect string&!! unset
19663 This option specifies the name of a file that contains the redirection data. It
19664 is mutually exclusive with the &%data%& option. The string is expanded before
19665 use; if the expansion is forced to fail, the router declines. Other expansion
19666 failures cause delivery to be deferred. The result of a successful expansion
19667 must be an absolute path. The entire file is read and used as the redirection
19668 data. If the data is an empty string or a string that has no effect (consists
19669 entirely of comments), the router declines.
19670
19671 .cindex "NFS" "checking for file existence"
19672 If the attempt to open the file fails with a &"does not exist"& error, Exim
19673 runs a check on the containing directory,
19674 unless &%ignore_enotdir%& is true (see below).
19675 If the directory does not appear to exist, delivery is deferred. This can
19676 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19677 is a mount problem. If the containing directory does exist, but the file does
19678 not, the router declines.
19679
19680
19681 .option file_transport redirect string&!! unset
19682 .vindex "&$address_file$&"
19683 A &(redirect)& router sets up a direct delivery to a file when a path name not
19684 ending in a slash is specified as a new &"address"&. The transport used is
19685 specified by this option, which, after expansion, must be the name of a
19686 configured transport. This should normally be an &(appendfile)& transport. When
19687 it is running, the file name is in &$address_file$&.
19688
19689
19690 .option filter_prepend_home redirect boolean true
19691 When this option is true, if a &(save)& command in an Exim filter specifies a
19692 relative path, and &$home$& is defined, it is automatically prepended to the
19693 relative path. If this option is set false, this action does not happen. The
19694 relative path is then passed to the transport unmodified.
19695
19696
19697 .option forbid_blackhole redirect boolean false
19698 If this option is true, the &':blackhole:'& item may not appear in a
19699 redirection list.
19700
19701
19702 .option forbid_exim_filter redirect boolean false
19703 If this option is set true, only Sieve filters are permitted when
19704 &%allow_filter%& is true.
19705
19706
19707
19708
19709 .option forbid_file redirect boolean false
19710 .cindex "delivery" "to file; forbidding"
19711 .cindex "Sieve filter" "forbidding delivery to a file"
19712 .cindex "Sieve filter" "&""keep""& facility; disabling"
19713 If this option is true, this router may not generate a new address that
19714 specifies delivery to a local file or directory, either from a filter or from a
19715 conventional forward file. This option is forced to be true if &%one_time%& is
19716 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19717 locks out the Sieve's &"keep"& facility.
19718
19719
19720 .option forbid_filter_dlfunc redirect boolean false
19721 .cindex "filter" "locking out certain features"
19722 If this option is true, string expansions in Exim filters are not allowed to
19723 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19724 functions.
19725
19726 .option forbid_filter_existstest redirect boolean false
19727 .cindex "expansion" "statting a file"
19728 If this option is true, string expansions in Exim filters are not allowed to
19729 make use of the &%exists%& condition or the &%stat%& expansion item.
19730
19731 .option forbid_filter_logwrite redirect boolean false
19732 If this option is true, use of the logging facility in Exim filters is not
19733 permitted. Logging is in any case available only if the filter is being run
19734 under some unprivileged uid (which is normally the case for ordinary users'
19735 &_.forward_& files).
19736
19737
19738 .option forbid_filter_lookup redirect boolean false
19739 If this option is true, string expansions in Exim filter files are not allowed
19740 to make use of &%lookup%& items.
19741
19742
19743 .option forbid_filter_perl redirect boolean false
19744 This option has an effect only if Exim is built with embedded Perl support. If
19745 it is true, string expansions in Exim filter files are not allowed to make use
19746 of the embedded Perl support.
19747
19748
19749 .option forbid_filter_readfile redirect boolean false
19750 If this option is true, string expansions in Exim filter files are not allowed
19751 to make use of &%readfile%& items.
19752
19753
19754 .option forbid_filter_readsocket redirect boolean false
19755 If this option is true, string expansions in Exim filter files are not allowed
19756 to make use of &%readsocket%& items.
19757
19758
19759 .option forbid_filter_reply redirect boolean false
19760 If this option is true, this router may not generate an automatic reply
19761 message. Automatic replies can be generated only from Exim or Sieve filter
19762 files, not from traditional forward files. This option is forced to be true if
19763 &%one_time%& is set.
19764
19765
19766 .option forbid_filter_run redirect boolean false
19767 If this option is true, string expansions in Exim filter files are not allowed
19768 to make use of &%run%& items.
19769
19770
19771 .option forbid_include redirect boolean false
19772 If this option is true, items of the form
19773 .code
19774 :include:<path name>
19775 .endd
19776 are not permitted in non-filter redirection lists.
19777
19778
19779 .option forbid_pipe redirect boolean false
19780 .cindex "delivery" "to pipe; forbidding"
19781 If this option is true, this router may not generate a new address which
19782 specifies delivery to a pipe, either from an Exim filter or from a conventional
19783 forward file. This option is forced to be true if &%one_time%& is set.
19784
19785
19786 .option forbid_sieve_filter redirect boolean false
19787 If this option is set true, only Exim filters are permitted when
19788 &%allow_filter%& is true.
19789
19790
19791 .cindex "SMTP" "error codes"
19792 .option forbid_smtp_code redirect boolean false
19793 If this option is set true, any SMTP error codes that are present at the start
19794 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19795 the default codes (451 and 550, respectively) are always used.
19796
19797
19798
19799
19800 .option hide_child_in_errmsg redirect boolean false
19801 .cindex "bounce message" "redirection details; suppressing"
19802 If this option is true, it prevents Exim from quoting a child address if it
19803 generates a bounce or delay message for it. Instead it says &"an address
19804 generated from <&'the top level address'&>"&. Of course, this applies only to
19805 bounces generated locally. If a message is forwarded to another host, &'its'&
19806 bounce may well quote the generated address.
19807
19808
19809 .option ignore_eacces redirect boolean false
19810 .cindex "EACCES"
19811 If this option is set and an attempt to open a redirection file yields the
19812 EACCES error (permission denied), the &(redirect)& router behaves as if the
19813 file did not exist.
19814
19815
19816 .option ignore_enotdir redirect boolean false
19817 .cindex "ENOTDIR"
19818 If this option is set and an attempt to open a redirection file yields the
19819 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19820 router behaves as if the file did not exist.
19821
19822 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19823 router that has the &%file%& option set discovers that the file does not exist
19824 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19825 against unmounted NFS directories. If the parent can not be statted, delivery
19826 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19827 is set, because that option tells Exim to ignore &"something on the path is not
19828 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19829 that some operating systems give ENOENT where others give ENOTDIR.
19830
19831
19832
19833 .option include_directory redirect string unset
19834 If this option is set, the path names of any &':include:'& items in a
19835 redirection list must start with this directory.
19836
19837
19838 .option modemask redirect "octal integer" 022
19839 This specifies mode bits which must not be set for a file specified by the
19840 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19841
19842
19843 .option one_time redirect boolean false
19844 .cindex "one-time aliasing/forwarding expansion"
19845 .cindex "alias file" "one-time expansion"
19846 .cindex "forward file" "one-time expansion"
19847 .cindex "mailing lists" "one-time expansion"
19848 .cindex "address redirection" "one-time expansion"
19849 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19850 files each time it tries to deliver a message causes a problem when one or more
19851 of the generated addresses fails be delivered at the first attempt. The problem
19852 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19853 but of what happens when the redirection list changes during the time that the
19854 message is on Exim's queue. This is particularly true in the case of mailing
19855 lists, where new subscribers might receive copies of messages that were posted
19856 before they subscribed.
19857
19858 If &%one_time%& is set and any addresses generated by the router fail to
19859 deliver at the first attempt, the failing addresses are added to the message as
19860 &"top level"& addresses, and the parent address that generated them is marked
19861 &"delivered"&. Thus, redirection does not happen again at the next delivery
19862 attempt.
19863
19864 &*Warning 1*&: Any header line addition or removal that is specified by this
19865 router would be lost if delivery did not succeed at the first attempt. For this
19866 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19867 permitted when &%one_time%& is set.
19868
19869 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19870 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19871 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19872
19873 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19874 &%one_time%&.
19875
19876 The original top-level address is remembered with each of the generated
19877 addresses, and is output in any log messages. However, any intermediate parent
19878 addresses are not recorded. This makes a difference to the log only if
19879 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19880 typically be used for mailing lists, where there is normally just one level of
19881 expansion.
19882
19883
19884 .option owners redirect "string list" unset
19885 .cindex "ownership" "alias file"
19886 .cindex "ownership" "forward file"
19887 .cindex "alias file" "ownership"
19888 .cindex "forward file" "ownership"
19889 This specifies a list of permitted owners for the file specified by &%file%&.
19890 This list is in addition to the local user when &%check_local_user%& is set.
19891 See &%check_owner%& above.
19892
19893
19894 .option owngroups redirect "string list" unset
19895 This specifies a list of permitted groups for the file specified by &%file%&.
19896 The list is in addition to the local user's primary group when
19897 &%check_local_user%& is set. See &%check_group%& above.
19898
19899
19900 .option pipe_transport redirect string&!! unset
19901 .vindex "&$address_pipe$&"
19902 A &(redirect)& router sets up a direct delivery to a pipe when a string
19903 starting with a vertical bar character is specified as a new &"address"&. The
19904 transport used is specified by this option, which, after expansion, must be the
19905 name of a configured transport. This should normally be a &(pipe)& transport.
19906 When the transport is run, the pipe command is in &$address_pipe$&.
19907
19908
19909 .option qualify_domain redirect string&!! unset
19910 .vindex "&$qualify_recipient$&"
19911 If this option is set, and an unqualified address (one without a domain) is
19912 generated, and that address would normally be qualified by the global setting
19913 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19914 expanding this string. If the expansion fails, the router declines. If you want
19915 to revert to the default, you can have the expansion generate
19916 &$qualify_recipient$&.
19917
19918 This option applies to all unqualified addresses generated by Exim filters,
19919 but for traditional &_.forward_& files, it applies only to addresses that are
19920 not preceded by a backslash. Sieve filters cannot generate unqualified
19921 addresses.
19922
19923 .option qualify_preserve_domain redirect boolean false
19924 .cindex "domain" "in redirection; preserving"
19925 .cindex "preserving domain in redirection"
19926 .cindex "address redirection" "domain; preserving"
19927 If this option is set, the router's local &%qualify_domain%& option must not be
19928 set (a configuration error occurs if it is). If an unqualified address (one
19929 without a domain) is generated, it is qualified with the domain of the parent
19930 address (the immediately preceding ancestor) instead of the global
19931 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19932 this applies whether or not the address is preceded by a backslash.
19933
19934
19935 .option repeat_use redirect boolean true
19936 If this option is set false, the router is skipped for a child address that has
19937 any ancestor that was routed by this router. This test happens before any of
19938 the other preconditions are tested. Exim's default anti-looping rules skip
19939 only when the ancestor is the same as the current address. See also
19940 &%check_ancestor%& above and the generic &%redirect_router%& option.
19941
19942
19943 .option reply_transport redirect string&!! unset
19944 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19945 &%vacation%& command is used in a filter file. The transport used is specified
19946 by this option, which, after expansion, must be the name of a configured
19947 transport. This should normally be an &(autoreply)& transport. Other transports
19948 are unlikely to do anything sensible or useful.
19949
19950
19951 .option rewrite redirect boolean true
19952 .cindex "address redirection" "disabling rewriting"
19953 If this option is set false, addresses generated by the router are not
19954 subject to address rewriting. Otherwise, they are treated like new addresses
19955 and are rewritten according to the global rewriting rules.
19956
19957
19958 .option sieve_subaddress redirect string&!! unset
19959 The value of this option is passed to a Sieve filter to specify the
19960 :subaddress part of an address.
19961
19962 .option sieve_useraddress redirect string&!! unset
19963 The value of this option is passed to a Sieve filter to specify the :user part
19964 of an address. However, if it is unset, the entire original local part
19965 (including any prefix or suffix) is used for :user.
19966
19967
19968 .option sieve_vacation_directory redirect string&!! unset
19969 .cindex "Sieve filter" "vacation directory"
19970 To enable the &"vacation"& extension for Sieve filters, you must set
19971 &%sieve_vacation_directory%& to the directory where vacation databases are held
19972 (do not put anything else in that directory), and ensure that the
19973 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19974 needs their own directory; Exim will create it if necessary.
19975
19976
19977
19978 .option skip_syntax_errors redirect boolean false
19979 .cindex "forward file" "broken"
19980 .cindex "address redirection" "broken files"
19981 .cindex "alias file" "broken"
19982 .cindex "broken alias or forward files"
19983 .cindex "ignoring faulty addresses"
19984 .cindex "skipping faulty addresses"
19985 .cindex "error" "skipping bad syntax"
19986 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19987 non-filter redirection data are skipped, and each failing address is logged. If
19988 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19989 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19990 are expanded and placed at the head of the error message generated by
19991 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19992 be the same address as the generic &%errors_to%& option. The
19993 &%skip_syntax_errors%& option is often used when handling mailing lists.
19994
19995 If all the addresses in a redirection list are skipped because of syntax
19996 errors, the router declines to handle the original address, and it is passed to
19997 the following routers.
19998
19999 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20000 error in the filter causes filtering to be abandoned without any action being
20001 taken. The incident is logged, and the router declines to handle the address,
20002 so it is passed to the following routers.
20003
20004 .cindex "Sieve filter" "syntax errors in"
20005 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20006 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20007 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20008
20009 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20010 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20011 option, used with an address that does not get redirected, can be used to
20012 notify users of these errors, by means of a router like this:
20013 .code
20014 userforward:
20015   driver = redirect
20016   allow_filter
20017   check_local_user
20018   file = $home/.forward
20019   file_transport = address_file
20020   pipe_transport = address_pipe
20021   reply_transport = address_reply
20022   no_verify
20023   skip_syntax_errors
20024   syntax_errors_to = real-$local_part@$domain
20025   syntax_errors_text = \
20026    This is an automatically generated message. An error has\n\
20027    been found in your .forward file. Details of the error are\n\
20028    reported below. While this error persists, you will receive\n\
20029    a copy of this message for every message that is addressed\n\
20030    to you. If your .forward file is a filter file, or if it is\n\
20031    a non-filter file containing no valid forwarding addresses,\n\
20032    a copy of each incoming message will be put in your normal\n\
20033    mailbox. If a non-filter file contains at least one valid\n\
20034    forwarding address, forwarding to the valid addresses will\n\
20035    happen, and those will be the only deliveries that occur.
20036 .endd
20037 You also need a router to ensure that local addresses that are prefixed by
20038 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20039 put this immediately before the &(userforward)& router:
20040 .code
20041 real_localuser:
20042   driver = accept
20043   check_local_user
20044   local_part_prefix = real-
20045   transport = local_delivery
20046 .endd
20047 For security, it would probably be a good idea to restrict the use of this
20048 router to locally-generated messages, using a condition such as this:
20049 .code
20050   condition = ${if match {$sender_host_address}\
20051                          {\N^(|127\.0\.0\.1)$\N}}
20052 .endd
20053
20054
20055 .option syntax_errors_text redirect string&!! unset
20056 See &%skip_syntax_errors%& above.
20057
20058
20059 .option syntax_errors_to redirect string unset
20060 See &%skip_syntax_errors%& above.
20061 .ecindex IIDredrou1
20062 .ecindex IIDredrou2
20063
20064
20065
20066
20067
20068
20069 . ////////////////////////////////////////////////////////////////////////////
20070 . ////////////////////////////////////////////////////////////////////////////
20071
20072 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20073          "Environment for local transports"
20074 .scindex IIDenvlotra1 "local transports" "environment for"
20075 .scindex IIDenvlotra2 "environment for local transports"
20076 .scindex IIDenvlotra3 "transport" "local; environment for"
20077 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20078 transport can be thought of as similar to a pipe.) Exim always runs transports
20079 in subprocesses, under specified uids and gids. Typical deliveries to local
20080 mailboxes run under the uid and gid of the local user.
20081
20082 Exim also sets a specific current directory while running the transport; for
20083 some transports a home directory setting is also relevant. The &(pipe)&
20084 transport is the only one that sets up environment variables; see section
20085 &<<SECTpipeenv>>& for details.
20086
20087 The values used for the uid, gid, and the directories may come from several
20088 different places. In many cases, the router that handles the address associates
20089 settings with that address as a result of its &%check_local_user%&, &%group%&,
20090 or &%user%& options. However, values may also be given in the transport's own
20091 configuration, and these override anything that comes from the router.
20092
20093
20094
20095 .section "Concurrent deliveries" "SECID131"
20096 .cindex "concurrent deliveries"
20097 .cindex "simultaneous deliveries"
20098 If two different messages for the same local recipient arrive more or less
20099 simultaneously, the two delivery processes are likely to run concurrently. When
20100 the &(appendfile)& transport is used to write to a file, Exim applies locking
20101 rules to stop concurrent processes from writing to the same file at the same
20102 time.
20103
20104 However, when you use a &(pipe)& transport, it is up to you to arrange any
20105 locking that is needed. Here is a silly example:
20106 .code
20107 my_transport:
20108   driver = pipe
20109   command = /bin/sh -c 'cat >>/some/file'
20110 .endd
20111 This is supposed to write the message at the end of the file. However, if two
20112 messages arrive at the same time, the file will be scrambled. You can use the
20113 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20114 file using the same algorithm that Exim itself uses.
20115
20116
20117
20118
20119 .section "Uids and gids" "SECTenvuidgid"
20120 .cindex "local transports" "uid and gid"
20121 .cindex "transport" "local; uid and gid"
20122 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20123 overrides any group that the router set in the address, even if &%user%& is not
20124 set for the transport. This makes it possible, for example, to run local mail
20125 delivery under the uid of the recipient (set by the router), but in a special
20126 group (set by the transport). For example:
20127 .code
20128 # Routers ...
20129 # User/group are set by check_local_user in this router
20130 local_users:
20131   driver = accept
20132   check_local_user
20133   transport = group_delivery
20134
20135 # Transports ...
20136 # This transport overrides the group
20137 group_delivery:
20138   driver = appendfile
20139   file = /var/spool/mail/$local_part
20140   group = mail
20141 .endd
20142 If &%user%& is set for a transport, its value overrides what is set in the
20143 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20144 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20145 set.
20146
20147 .oindex "&%initgroups%&"
20148 When the uid is taken from the transport's configuration, the &[initgroups()]&
20149 function is called for the groups associated with that uid if the
20150 &%initgroups%& option is set for the transport. When the uid is not specified
20151 by the transport, but is associated with the address by a router, the option
20152 for calling &[initgroups()]& is taken from the router configuration.
20153
20154 .cindex "&(pipe)& transport" "uid for"
20155 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20156 is set and &%user%& is not set, the uid of the process that called Exim to
20157 receive the message is used, and if &%group%& is not set, the corresponding
20158 original gid is also used.
20159
20160 This is the detailed preference order for obtaining a gid; the first of the
20161 following that is set is used:
20162
20163 .ilist
20164 A &%group%& setting of the transport;
20165 .next
20166 A &%group%& setting of the router;
20167 .next
20168 A gid associated with a user setting of the router, either as a result of
20169 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20170 .next
20171 The group associated with a non-numeric &%user%& setting of the transport;
20172 .next
20173 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20174 the uid is the creator's uid;
20175 .next
20176 The Exim gid if the Exim uid is being used as a default.
20177 .endlist
20178
20179 If, for example, the user is specified numerically on the router and there are
20180 no group settings, no gid is available. In this situation, an error occurs.
20181 This is different for the uid, for which there always is an ultimate default.
20182 The first of the following that is set is used:
20183
20184 .ilist
20185 A &%user%& setting of the transport;
20186 .next
20187 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20188 .next
20189 A &%user%& setting of the router;
20190 .next
20191 A &%check_local_user%& setting of the router;
20192 .next
20193 The Exim uid.
20194 .endlist
20195
20196 Of course, an error will still occur if the uid that is chosen is on the
20197 &%never_users%& list.
20198
20199
20200
20201
20202
20203 .section "Current and home directories" "SECID132"
20204 .cindex "current directory for local transport"
20205 .cindex "home directory" "for local transport"
20206 .cindex "transport" "local; home directory for"
20207 .cindex "transport" "local; current directory for"
20208 Routers may set current and home directories for local transports by means of
20209 the &%transport_current_directory%& and &%transport_home_directory%& options.
20210 However, if the transport's &%current_directory%& or &%home_directory%& options
20211 are set, they override the router's values. In detail, the home directory
20212 for a local transport is taken from the first of these values that is set:
20213
20214 .ilist
20215 The &%home_directory%& option on the transport;
20216 .next
20217 The &%transport_home_directory%& option on the router;
20218 .next
20219 The password data if &%check_local_user%& is set on the router;
20220 .next
20221 The &%router_home_directory%& option on the router.
20222 .endlist
20223
20224 The current directory is taken from the first of these values that is set:
20225
20226 .ilist
20227 The &%current_directory%& option on the transport;
20228 .next
20229 The &%transport_current_directory%& option on the router.
20230 .endlist
20231
20232
20233 If neither the router nor the transport sets a current directory, Exim uses the
20234 value of the home directory, if it is set. Otherwise it sets the current
20235 directory to &_/_& before running a local transport.
20236
20237
20238
20239 .section "Expansion variables derived from the address" "SECID133"
20240 .vindex "&$domain$&"
20241 .vindex "&$local_part$&"
20242 .vindex "&$original_domain$&"
20243 Normally a local delivery is handling a single address, and in that case the
20244 variables such as &$domain$& and &$local_part$& are set during local
20245 deliveries. However, in some circumstances more than one address may be handled
20246 at once (for example, while writing batch SMTP for onward transmission by some
20247 other means). In this case, the variables associated with the local part are
20248 never set, &$domain$& is set only if all the addresses have the same domain,
20249 and &$original_domain$& is never set.
20250 .ecindex IIDenvlotra1
20251 .ecindex IIDenvlotra2
20252 .ecindex IIDenvlotra3
20253
20254
20255
20256
20257
20258
20259
20260 . ////////////////////////////////////////////////////////////////////////////
20261 . ////////////////////////////////////////////////////////////////////////////
20262
20263 .chapter "Generic options for transports" "CHAPtransportgeneric"
20264 .scindex IIDgenoptra1 "generic options" "transport"
20265 .scindex IIDgenoptra2 "options" "generic; for transports"
20266 .scindex IIDgenoptra3 "transport" "generic options for"
20267 The following generic options apply to all transports:
20268
20269
20270 .option body_only transports boolean false
20271 .cindex "transport" "body only"
20272 .cindex "message" "transporting body only"
20273 .cindex "body of message" "transporting"
20274 If this option is set, the message's headers are not transported. It is
20275 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20276 or &(pipe)& transports, the settings of &%message_prefix%& and
20277 &%message_suffix%& should be checked, because this option does not
20278 automatically suppress them.
20279
20280
20281 .option current_directory transports string&!! unset
20282 .cindex "transport" "current directory for"
20283 This specifies the current directory that is to be set while running the
20284 transport, overriding any value that may have been set by the router.
20285 If the expansion fails for any reason, including forced failure, an error is
20286 logged, and delivery is deferred.
20287
20288
20289 .option disable_logging transports boolean false
20290 If this option is set true, nothing is logged for any
20291 deliveries by the transport or for any
20292 transport errors. You should not set this option unless you really, really know
20293 what you are doing.
20294
20295
20296 .option debug_print transports string&!! unset
20297 .cindex "testing" "variables in drivers"
20298 If this option is set and debugging is enabled (see the &%-d%& command line
20299 option), the string is expanded and included in the debugging output when the
20300 transport is run.
20301 If expansion of the string fails, the error message is written to the debugging
20302 output, and Exim carries on processing.
20303 This facility is provided to help with checking out the values of variables and
20304 so on when debugging driver configurations. For example, if a &%headers_add%&
20305 option is not working properly, &%debug_print%& could be used to output the
20306 variables it references. A newline is added to the text if it does not end with
20307 one.
20308 The variables &$transport_name$& and &$router_name$& contain the name of the
20309 transport and the router that called it.
20310
20311 .option delivery_date_add transports boolean false
20312 .cindex "&'Delivery-date:'& header line"
20313 If this option is true, a &'Delivery-date:'& header is added to the message.
20314 This gives the actual time the delivery was made. As this is not a standard
20315 header, Exim has a configuration option (&%delivery_date_remove%&) which
20316 requests its removal from incoming messages, so that delivered messages can
20317 safely be resent to other recipients.
20318
20319
20320 .option driver transports string unset
20321 This specifies which of the available transport drivers is to be used.
20322 There is no default, and this option must be set for every transport.
20323
20324
20325 .option envelope_to_add transports boolean false
20326 .cindex "&'Envelope-to:'& header line"
20327 If this option is true, an &'Envelope-to:'& header is added to the message.
20328 This gives the original address(es) in the incoming envelope that caused this
20329 delivery to happen. More than one address may be present if the transport is
20330 configured to handle several addresses at once, or if more than one original
20331 address was redirected to the same final address. As this is not a standard
20332 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20333 its removal from incoming messages, so that delivered messages can safely be
20334 resent to other recipients.
20335
20336
20337 .option group transports string&!! "Exim group"
20338 .cindex "transport" "group; specifying"
20339 This option specifies a gid for running the transport process, overriding any
20340 value that the router supplies, and also overriding any value associated with
20341 &%user%& (see below).
20342
20343
20344 .option headers_add transports list&!! unset
20345 .cindex "header lines" "adding in transport"
20346 .cindex "transport" "header lines; adding"
20347 This option specifies a list of text headers,
20348 .new
20349 newline-separated (by default, changeable in the usual way),
20350 .wen
20351 which are (separately) expanded and added to the header
20352 portion of a message as it is transported, as described in section
20353 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20354 routers. If the result of the expansion is an empty string, or if the expansion
20355 is forced to fail, no action is taken. Other expansion failures are treated as
20356 errors and cause the delivery to be deferred.
20357
20358 Unlike most options, &%headers_add%& can be specified multiple times
20359 for a transport; all listed headers are added.
20360
20361
20362 .option headers_only transports boolean false
20363 .cindex "transport" "header lines only"
20364 .cindex "message" "transporting headers only"
20365 .cindex "header lines" "transporting"
20366 If this option is set, the message's body is not transported. It is mutually
20367 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20368 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20369 checked, since this option does not automatically suppress them.
20370
20371
20372 .option headers_remove transports list&!! unset
20373 .cindex "header lines" "removing"
20374 .cindex "transport" "header lines; removing"
20375 This option specifies a list of header names,
20376 .new
20377 colon-separated (by default, changeable in the usual way);
20378 .wen
20379 these headers are omitted from the message as it is transported, as described
20380 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20381 routers.
20382 Each list item is separately expanded.
20383 If the result of the expansion is an empty string, or if the expansion
20384 is forced to fail, no action is taken. Other expansion failures are treated as
20385 errors and cause the delivery to be deferred.
20386
20387 Unlike most options, &%headers_remove%& can be specified multiple times
20388 for a router; all listed headers are removed.
20389
20390
20391
20392 .option headers_rewrite transports string unset
20393 .cindex "transport" "header lines; rewriting"
20394 .cindex "rewriting" "at transport time"
20395 This option allows addresses in header lines to be rewritten at transport time,
20396 that is, as the message is being copied to its destination. The contents of the
20397 option are a colon-separated list of rewriting rules. Each rule is in exactly
20398 the same form as one of the general rewriting rules that are applied when a
20399 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20400 example,
20401 .code
20402 headers_rewrite = a@b c@d f : \
20403                   x@y w@z
20404 .endd
20405 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20406 &'w@z'& in all address-bearing header lines. The rules are applied to the
20407 header lines just before they are written out at transport time, so they affect
20408 only those copies of the message that pass through the transport. However, only
20409 the message's original header lines, and any that were added by a system
20410 filter, are rewritten. If a router or transport adds header lines, they are not
20411 affected by this option. These rewriting rules are &'not'& applied to the
20412 envelope. You can change the return path using &%return_path%&, but you cannot
20413 change envelope recipients at this time.
20414
20415
20416 .option home_directory transports string&!! unset
20417 .cindex "transport" "home directory for"
20418 .vindex "&$home$&"
20419 This option specifies a home directory setting for a local transport,
20420 overriding any value that may be set by the router. The home directory is
20421 placed in &$home$& while expanding the transport's private options. It is also
20422 used as the current directory if no current directory is set by the
20423 &%current_directory%& option on the transport or the
20424 &%transport_current_directory%& option on the router. If the expansion fails
20425 for any reason, including forced failure, an error is logged, and delivery is
20426 deferred.
20427
20428
20429 .option initgroups transports boolean false
20430 .cindex "additional groups"
20431 .cindex "groups" "additional"
20432 .cindex "transport" "group; additional"
20433 If this option is true and the uid for the delivery process is provided by the
20434 transport, the &[initgroups()]& function is called when running the transport
20435 to ensure that any additional groups associated with the uid are set up.
20436
20437
20438 .option message_size_limit transports string&!! 0
20439 .cindex "limit" "message size per transport"
20440 .cindex "size" "of message, limit"
20441 .cindex "transport" "message size; limiting"
20442 This option controls the size of messages passed through the transport. It is
20443 expanded before use; the result of the expansion must be a sequence of decimal
20444 digits, optionally followed by K or M. If the expansion fails for any reason,
20445 including forced failure, or if the result is not of the required form,
20446 delivery is deferred. If the value is greater than zero and the size of a
20447 message exceeds this limit, the address is failed. If there is any chance that
20448 the resulting bounce message could be routed to the same transport, you should
20449 ensure that &%return_size_limit%& is less than the transport's
20450 &%message_size_limit%&, as otherwise the bounce message will fail to get
20451 delivered.
20452
20453
20454
20455 .option rcpt_include_affixes transports boolean false
20456 .cindex "prefix" "for local part, including in envelope"
20457 .cindex "suffix for local part" "including in envelope"
20458 .cindex "local part" "prefix"
20459 .cindex "local part" "suffix"
20460 When this option is false (the default), and an address that has had any
20461 affixes (prefixes or suffixes) removed from the local part is delivered by any
20462 form of SMTP or LMTP, the affixes are not included. For example, if a router
20463 that contains
20464 .code
20465 local_part_prefix = *-
20466 .endd
20467 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20468 is delivered with
20469 .code
20470 RCPT TO:<xyz@some.domain>
20471 .endd
20472 This is also the case when an ACL-time callout is being used to verify a
20473 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20474 whole local part is included in the RCPT command. This option applies to BSMTP
20475 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20476 &(lmtp)& and &(smtp)& transports.
20477
20478
20479 .option retry_use_local_part transports boolean "see below"
20480 .cindex "hints database" "retry keys"
20481 When a delivery suffers a temporary failure, a retry record is created
20482 in Exim's hints database. For remote deliveries, the key for the retry record
20483 is based on the name and/or IP address of the failing remote host. For local
20484 deliveries, the key is normally the entire address, including both the local
20485 part and the domain. This is suitable for most common cases of local delivery
20486 temporary failure &-- for example, exceeding a mailbox quota should delay only
20487 deliveries to that mailbox, not to the whole domain.
20488
20489 However, in some special cases you may want to treat a temporary local delivery
20490 as a failure associated with the domain, and not with a particular local part.
20491 (For example, if you are storing all mail for some domain in files.) You can do
20492 this by setting &%retry_use_local_part%& false.
20493
20494 For all the local transports, its default value is true. For remote transports,
20495 the default value is false for tidiness, but changing the value has no effect
20496 on a remote transport in the current implementation.
20497
20498
20499 .option return_path transports string&!! unset
20500 .cindex "envelope sender"
20501 .cindex "transport" "return path; changing"
20502 .cindex "return path" "changing in transport"
20503 If this option is set, the string is expanded at transport time and replaces
20504 the existing return path (envelope sender) value in the copy of the message
20505 that is being delivered. An empty return path is permitted. This feature is
20506 designed for remote deliveries, where the value of this option is used in the
20507 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20508 only effect is to change the address that is placed in the &'Return-path:'&
20509 header line, if one is added to the message (see the next option).
20510
20511 &*Note:*& A changed return path is not logged unless you add
20512 &%return_path_on_delivery%& to the log selector.
20513
20514 .vindex "&$return_path$&"
20515 The expansion can refer to the existing value via &$return_path$&. This is
20516 either the message's envelope sender, or an address set by the
20517 &%errors_to%& option on a router. If the expansion is forced to fail, no
20518 replacement occurs; if it fails for another reason, delivery is deferred. This
20519 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20520 section &<<SECTverp>>&.
20521
20522 &*Note*&: If a delivery error is detected locally, including the case when a
20523 remote server rejects a message at SMTP time, the bounce message is not sent to
20524 the value of this option. It is sent to the previously set errors address.
20525 This defaults to the incoming sender address, but can be changed by setting
20526 &%errors_to%& in a router.
20527
20528
20529
20530 .option return_path_add transports boolean false
20531 .cindex "&'Return-path:'& header line"
20532 If this option is true, a &'Return-path:'& header is added to the message.
20533 Although the return path is normally available in the prefix line of BSD
20534 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20535 have easy access to it.
20536
20537 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20538 the delivery SMTP server makes the final delivery"&. This implies that this
20539 header should not be present in incoming messages. Exim has a configuration
20540 option, &%return_path_remove%&, which requests removal of this header from
20541 incoming messages, so that delivered messages can safely be resent to other
20542 recipients.
20543
20544
20545 .option shadow_condition transports string&!! unset
20546 See &%shadow_transport%& below.
20547
20548
20549 .option shadow_transport transports string unset
20550 .cindex "shadow transport"
20551 .cindex "transport" "shadow"
20552 A local transport may set the &%shadow_transport%& option to the name of
20553 another local transport. Shadow remote transports are not supported.
20554
20555 Whenever a delivery to the main transport succeeds, and either
20556 &%shadow_condition%& is unset, or its expansion does not result in the empty
20557 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20558 passed to the shadow transport, with the same delivery address or addresses. If
20559 expansion fails, no action is taken except that non-forced expansion failures
20560 cause a log line to be written.
20561
20562 The result of the shadow transport is discarded and does not affect the
20563 subsequent processing of the message. Only a single level of shadowing is
20564 provided; the &%shadow_transport%& option is ignored on any transport when it
20565 is running as a shadow. Options concerned with output from pipes are also
20566 ignored. The log line for the successful delivery has an item added on the end,
20567 of the form
20568 .code
20569 ST=<shadow transport name>
20570 .endd
20571 If the shadow transport did not succeed, the error message is put in
20572 parentheses afterwards. Shadow transports can be used for a number of different
20573 purposes, including keeping more detailed log information than Exim normally
20574 provides, and implementing automatic acknowledgment policies based on message
20575 headers that some sites insist on.
20576
20577
20578 .option transport_filter transports string&!! unset
20579 .cindex "transport" "filter"
20580 .cindex "filter" "transport filter"
20581 This option sets up a filtering (in the Unix shell sense) process for messages
20582 at transport time. It should not be confused with mail filtering as set up by
20583 individual users or via a system filter.
20584
20585 When the message is about to be written out, the command specified by
20586 &%transport_filter%& is started up in a separate, parallel process, and
20587 the entire message, including the header lines, is passed to it on its standard
20588 input (this in fact is done from a third process, to avoid deadlock). The
20589 command must be specified as an absolute path.
20590
20591 The lines of the message that are written to the transport filter are
20592 terminated by newline (&"\n"&). The message is passed to the filter before any
20593 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20594 lines beginning with a dot, and also before any processing implied by the
20595 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20596 &(pipe)& transports.
20597
20598 The standard error for the filter process is set to the same destination as its
20599 standard output; this is read and written to the message's ultimate
20600 destination. The process that writes the message to the filter, the
20601 filter itself, and the original process that reads the result and delivers it
20602 are all run in parallel, like a shell pipeline.
20603
20604 The filter can perform any transformations it likes, but of course should take
20605 care not to break RFC 2822 syntax. Exim does not check the result, except to
20606 test for a final newline when SMTP is in use. All messages transmitted over
20607 SMTP must end with a newline, so Exim supplies one if it is missing.
20608
20609 .cindex "content scanning" "per user"
20610 A transport filter can be used to provide content-scanning on a per-user basis
20611 at delivery time if the only required effect of the scan is to modify the
20612 message. For example, a content scan could insert a new header line containing
20613 a spam score. This could be interpreted by a filter in the user's MUA. It is
20614 not possible to discard a message at this stage.
20615
20616 .cindex "SMTP" "SIZE"
20617 A problem might arise if the filter increases the size of a message that is
20618 being sent down an SMTP connection. If the receiving SMTP server has indicated
20619 support for the SIZE parameter, Exim will have sent the size of the message
20620 at the start of the SMTP session. If what is actually sent is substantially
20621 more, the server might reject the message. This can be worked round by setting
20622 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20623 additions to the message, or to disable the use of SIZE altogether.
20624
20625 .vindex "&$pipe_addresses$&"
20626 The value of the &%transport_filter%& option is the command string for starting
20627 the filter, which is run directly from Exim, not under a shell. The string is
20628 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20629 Exim breaks it up into arguments and then expands each argument separately (see
20630 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20631 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20632 of arguments, one for each address that applies to this delivery. (This isn't
20633 an ideal name for this feature here, but as it was already implemented for the
20634 &(pipe)& transport, it seemed sensible not to change it.)
20635
20636 .vindex "&$host$&"
20637 .vindex "&$host_address$&"
20638 The expansion variables &$host$& and &$host_address$& are available when the
20639 transport is a remote one. They contain the name and IP address of the host to
20640 which the message is being sent. For example:
20641 .code
20642 transport_filter = /some/directory/transport-filter.pl \
20643   $host $host_address $sender_address $pipe_addresses
20644 .endd
20645
20646 Two problems arise if you want to use more complicated expansion items to
20647 generate transport filter commands, both of which due to the fact that the
20648 command is split up &'before'& expansion.
20649 .ilist
20650 If an expansion item contains white space, you must quote it, so that it is all
20651 part of the same command item. If the entire option setting is one such
20652 expansion item, you have to take care what kind of quoting you use. For
20653 example:
20654 .code
20655 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20656 .endd
20657 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20658 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20659 stripped by Exim when it read the option's value. When the value is used, if
20660 the single quotes were missing, the line would be split into two items,
20661 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20662 Exim tried to expand the first one.
20663 .next
20664 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20665 expansion cannot generate multiple arguments, or a command name followed by
20666 arguments. Consider this example:
20667 .code
20668 transport_filter = ${lookup{$host}lsearch{/a/file}\
20669                     {$value}{/bin/cat}}
20670 .endd
20671 The result of the lookup is interpreted as the name of the command, even
20672 if it contains white space. The simplest way round this is to use a shell:
20673 .code
20674 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20675                                {$value}{/bin/cat}}
20676 .endd
20677 .endlist
20678
20679 The filter process is run under the same uid and gid as the normal delivery.
20680 For remote deliveries this is the Exim uid/gid by default. The command should
20681 normally yield a zero return code. Transport filters are not supposed to fail.
20682 A non-zero code is taken to mean that the transport filter encountered some
20683 serious problem. Delivery of the message is deferred; the message remains on
20684 the queue and is tried again later. It is not possible to cause a message to be
20685 bounced from a transport filter.
20686
20687 If a transport filter is set on an autoreply transport, the original message is
20688 passed through the filter as it is being copied into the newly generated
20689 message, which happens if the &%return_message%& option is set.
20690
20691
20692 .option transport_filter_timeout transports time 5m
20693 .cindex "transport" "filter, timeout"
20694 When Exim is reading the output of a transport filter, it applies a timeout
20695 that can be set by this option. Exceeding the timeout is normally treated as a
20696 temporary delivery failure. However, if a transport filter is used with a
20697 &(pipe)& transport, a timeout in the transport filter is treated in the same
20698 way as a timeout in the pipe command itself. By default, a timeout is a hard
20699 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20700 becomes a temporary error.
20701
20702
20703 .option user transports string&!! "Exim user"
20704 .cindex "uid (user id)" "local delivery"
20705 .cindex "transport" "user, specifying"
20706 This option specifies the user under whose uid the delivery process is to be
20707 run, overriding any uid that may have been set by the router. If the user is
20708 given as a name, the uid is looked up from the password data, and the
20709 associated group is taken as the value of the gid to be used if the &%group%&
20710 option is not set.
20711
20712 For deliveries that use local transports, a user and group are normally
20713 specified explicitly or implicitly (for example, as a result of
20714 &%check_local_user%&) by the router or transport.
20715
20716 .cindex "hints database" "access by remote transport"
20717 For remote transports, you should leave this option unset unless you really are
20718 sure you know what you are doing. When a remote transport is running, it needs
20719 to be able to access Exim's hints databases, because each host may have its own
20720 retry data.
20721 .ecindex IIDgenoptra1
20722 .ecindex IIDgenoptra2
20723 .ecindex IIDgenoptra3
20724
20725
20726
20727
20728
20729
20730 . ////////////////////////////////////////////////////////////////////////////
20731 . ////////////////////////////////////////////////////////////////////////////
20732
20733 .chapter "Address batching in local transports" "CHAPbatching" &&&
20734          "Address batching"
20735 .cindex "transport" "local; address batching in"
20736 The only remote transport (&(smtp)&) is normally configured to handle more than
20737 one address at a time, so that when several addresses are routed to the same
20738 remote host, just one copy of the message is sent. Local transports, however,
20739 normally handle one address at a time. That is, a separate instance of the
20740 transport is run for each address that is routed to the transport. A separate
20741 copy of the message is delivered each time.
20742
20743 .cindex "batched local delivery"
20744 .oindex "&%batch_max%&"
20745 .oindex "&%batch_id%&"
20746 In special cases, it may be desirable to handle several addresses at once in a
20747 local transport, for example:
20748
20749 .ilist
20750 In an &(appendfile)& transport, when storing messages in files for later
20751 delivery by some other means, a single copy of the message with multiple
20752 recipients saves space.
20753 .next
20754 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20755 a single copy saves time, and is the normal way LMTP is expected to work.
20756 .next
20757 In a &(pipe)& transport, when passing the message
20758 to a scanner program or
20759 to some other delivery mechanism such as UUCP, multiple recipients may be
20760 acceptable.
20761 .endlist
20762
20763 These three local transports all have the same options for controlling multiple
20764 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20765 repeating the information for each transport, these options are described here.
20766
20767 The &%batch_max%& option specifies the maximum number of addresses that can be
20768 delivered together in a single run of the transport. Its default value is one
20769 (no batching). When more than one address is routed to a transport that has a
20770 &%batch_max%& value greater than one, the addresses are delivered in a batch
20771 (that is, in a single run of the transport with multiple recipients), subject
20772 to certain conditions:
20773
20774 .ilist
20775 .vindex "&$local_part$&"
20776 If any of the transport's options contain a reference to &$local_part$&, no
20777 batching is possible.
20778 .next
20779 .vindex "&$domain$&"
20780 If any of the transport's options contain a reference to &$domain$&, only
20781 addresses with the same domain are batched.
20782 .next
20783 .cindex "customizing" "batching condition"
20784 If &%batch_id%& is set, it is expanded for each address, and only those
20785 addresses with the same expanded value are batched. This allows you to specify
20786 customized batching conditions. Failure of the expansion for any reason,
20787 including forced failure, disables batching, but it does not stop the delivery
20788 from taking place.
20789 .next
20790 Batched addresses must also have the same errors address (where to send
20791 delivery errors), the same header additions and removals, the same user and
20792 group for the transport, and if a host list is present, the first host must
20793 be the same.
20794 .endlist
20795
20796 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20797 both when the file or pipe command is specified in the transport, and when it
20798 is specified by a &(redirect)& router, but all the batched addresses must of
20799 course be routed to the same file or pipe command. These two transports have an
20800 option called &%use_bsmtp%&, which causes them to deliver the message in
20801 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20802 &%check_string%& and &%escape_string%& options are forced to the values
20803 .code
20804 check_string = "."
20805 escape_string = ".."
20806 .endd
20807 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20808 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20809 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20810
20811 .cindex "&'Envelope-to:'& header line"
20812 If the generic &%envelope_to_add%& option is set for a batching transport, the
20813 &'Envelope-to:'& header that is added to the message contains all the addresses
20814 that are being processed together. If you are using a batching &(appendfile)&
20815 transport without &%use_bsmtp%&, the only way to preserve the recipient
20816 addresses is to set the &%envelope_to_add%& option.
20817
20818 .cindex "&(pipe)& transport" "with multiple addresses"
20819 .vindex "&$pipe_addresses$&"
20820 If you are using a &(pipe)& transport without BSMTP, and setting the
20821 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20822 the command. This is not a true variable; it is a bit of magic that causes each
20823 of the recipient addresses to be inserted into the command as a separate
20824 argument. This provides a way of accessing all the addresses that are being
20825 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20826 are specified by a &(redirect)& router.
20827
20828
20829
20830
20831 . ////////////////////////////////////////////////////////////////////////////
20832 . ////////////////////////////////////////////////////////////////////////////
20833
20834 .chapter "The appendfile transport" "CHAPappendfile"
20835 .scindex IIDapptra1 "&(appendfile)& transport"
20836 .scindex IIDapptra2 "transports" "&(appendfile)&"
20837 .cindex "directory creation"
20838 .cindex "creating directories"
20839 The &(appendfile)& transport delivers a message by appending it to an existing
20840 file, or by creating an entirely new file in a specified directory. Single
20841 files to which messages are appended can be in the traditional Unix mailbox
20842 format, or optionally in the MBX format supported by the Pine MUA and
20843 University of Washington IMAP daemon, &'inter alia'&. When each message is
20844 being delivered as a separate file, &"maildir"& format can optionally be used
20845 to give added protection against failures that happen part-way through the
20846 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20847 supported. For all file formats, Exim attempts to create as many levels of
20848 directory as necessary, provided that &%create_directory%& is set.
20849
20850 The code for the optional formats is not included in the Exim binary by
20851 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20852 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20853 included.
20854
20855 .cindex "quota" "system"
20856 Exim recognizes system quota errors, and generates an appropriate message. Exim
20857 also supports its own quota control within the transport, for use when the
20858 system facility is unavailable or cannot be used for some reason.
20859
20860 If there is an error while appending to a file (for example, quota exceeded or
20861 partition filled), Exim attempts to reset the file's length and last
20862 modification time back to what they were before. If there is an error while
20863 creating an entirely new file, the new file is removed.
20864
20865 Before appending to a file, a number of security checks are made, and the
20866 file is locked. A detailed description is given below, after the list of
20867 private options.
20868
20869 The &(appendfile)& transport is most commonly used for local deliveries to
20870 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20871 putting messages into files for remote delivery by some means other than Exim.
20872 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20873 option).
20874
20875
20876
20877 .section "The file and directory options" "SECTfildiropt"
20878 The &%file%& option specifies a single file, to which the message is appended;
20879 the &%directory%& option specifies a directory, in which a new file containing
20880 the message is created. Only one of these two options can be set, and for
20881 normal deliveries to mailboxes, one of them &'must'& be set.
20882
20883 .vindex "&$address_file$&"
20884 .vindex "&$local_part$&"
20885 However, &(appendfile)& is also used for delivering messages to files or
20886 directories whose names (or parts of names) are obtained from alias,
20887 forwarding, or filtering operations (for example, a &%save%& command in a
20888 user's Exim filter). When such a transport is running, &$local_part$& contains
20889 the local part that was aliased or forwarded, and &$address_file$& contains the
20890 name (or partial name) of the file or directory generated by the redirection
20891 operation. There are two cases:
20892
20893 .ilist
20894 If neither &%file%& nor &%directory%& is set, the redirection operation
20895 must specify an absolute path (one that begins with &`/`&). This is the most
20896 common case when users with local accounts use filtering to sort mail into
20897 different folders. See for example, the &(address_file)& transport in the
20898 default configuration. If the path ends with a slash, it is assumed to be the
20899 name of a directory. A delivery to a directory can also be forced by setting
20900 &%maildir_format%& or &%mailstore_format%&.
20901 .next
20902 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20903 used to determine the file or directory name for the delivery. Normally, the
20904 contents of &$address_file$& are used in some way in the string expansion.
20905 .endlist
20906
20907
20908 .cindex "Sieve filter" "configuring &(appendfile)&"
20909 .cindex "Sieve filter" "relative mailbox path handling"
20910 As an example of the second case, consider an environment where users do not
20911 have home directories. They may be permitted to use Exim filter commands of the
20912 form:
20913 .code
20914 save folder23
20915 .endd
20916 or Sieve filter commands of the form:
20917 .code
20918 require "fileinto";
20919 fileinto "folder23";
20920 .endd
20921 In this situation, the expansion of &%file%& or &%directory%& in the transport
20922 must transform the relative path into an appropriate absolute file name. In the
20923 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20924 is used as a result of a &"keep"& action in the filter. This example shows one
20925 way of handling this requirement:
20926 .code
20927 file = ${if eq{$address_file}{inbox} \
20928             {/var/mail/$local_part} \
20929             {${if eq{${substr_0_1:$address_file}}{/} \
20930                   {$address_file} \
20931                   {$home/mail/$address_file} \
20932             }} \
20933        }
20934 .endd
20935 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20936 location, absolute paths are used without change, and other folders are in the
20937 &_mail_& directory within the home directory.
20938
20939 &*Note 1*&: While processing an Exim filter, a relative path such as
20940 &_folder23_& is turned into an absolute path if a home directory is known to
20941 the router. In particular, this is the case if &%check_local_user%& is set. If
20942 you want to prevent this happening at routing time, you can set
20943 &%router_home_directory%& empty. This forces the router to pass the relative
20944 path to the transport.
20945
20946 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20947 the &%file%& or &%directory%& option is still used if it is set.
20948
20949
20950
20951
20952 .section "Private options for appendfile" "SECID134"
20953 .cindex "options" "&(appendfile)& transport"
20954
20955
20956
20957 .option allow_fifo appendfile boolean false
20958 .cindex "fifo (named pipe)"
20959 .cindex "named pipe (fifo)"
20960 .cindex "pipe" "named (fifo)"
20961 Setting this option permits delivery to named pipes (FIFOs) as well as to
20962 regular files. If no process is reading the named pipe at delivery time, the
20963 delivery is deferred.
20964
20965
20966 .option allow_symlink appendfile boolean false
20967 .cindex "symbolic link" "to mailbox"
20968 .cindex "mailbox" "symbolic link"
20969 By default, &(appendfile)& will not deliver if the path name for the file is
20970 that of a symbolic link. Setting this option relaxes that constraint, but there
20971 are security issues involved in the use of symbolic links. Be sure you know
20972 what you are doing if you set this. Details of exactly what this option affects
20973 are included in the discussion which follows this list of options.
20974
20975
20976 .option batch_id appendfile string&!! unset
20977 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20978 However, batching is automatically disabled for &(appendfile)& deliveries that
20979 happen as a result of forwarding or aliasing or other redirection directly to a
20980 file.
20981
20982
20983 .option batch_max appendfile integer 1
20984 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20985
20986
20987 .option check_group appendfile boolean false
20988 When this option is set, the group owner of the file defined by the &%file%&
20989 option is checked to see that it is the same as the group under which the
20990 delivery process is running. The default setting is false because the default
20991 file mode is 0600, which means that the group is irrelevant.
20992
20993
20994 .option check_owner appendfile boolean true
20995 When this option is set, the owner of the file defined by the &%file%& option
20996 is checked to ensure that it is the same as the user under which the delivery
20997 process is running.
20998
20999
21000 .option check_string appendfile string "see below"
21001 .cindex "&""From""& line"
21002 As &(appendfile)& writes the message, the start of each line is tested for
21003 matching &%check_string%&, and if it does, the initial matching characters are
21004 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21005 a literal string, not a regular expression, and the case of any letters it
21006 contains is significant.
21007
21008 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21009 are forced to &"."& and &".."& respectively, and any settings in the
21010 configuration are ignored. Otherwise, they default to &"From&~"& and
21011 &">From&~"& when the &%file%& option is set, and unset when any of the
21012 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21013
21014 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21015 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21016 &"From&~"& indicates the start of a new message. All four options need changing
21017 if another format is used. For example, to deliver to mailboxes in MMDF format:
21018 .cindex "MMDF format mailbox"
21019 .cindex "mailbox" "MMDF format"
21020 .code
21021 check_string = "\1\1\1\1\n"
21022 escape_string = "\1\1\1\1 \n"
21023 message_prefix = "\1\1\1\1\n"
21024 message_suffix = "\1\1\1\1\n"
21025 .endd
21026 .option create_directory appendfile boolean true
21027 .cindex "directory creation"
21028 When this option is true, Exim attempts to create any missing superior
21029 directories for the file that it is about to write. A created directory's mode
21030 is given by the &%directory_mode%& option.
21031
21032 The group ownership of a newly created directory is highly dependent on the
21033 operating system (and possibly the file system) that is being used. For
21034 example, in Solaris, if the parent directory has the setgid bit set, its group
21035 is propagated to the child; if not, the currently set group is used. However,
21036 in FreeBSD, the parent's group is always used.
21037
21038
21039
21040 .option create_file appendfile string anywhere
21041 This option constrains the location of files and directories that are created
21042 by this transport. It applies to files defined by the &%file%& option and
21043 directories defined by the &%directory%& option. In the case of maildir
21044 delivery, it applies to the top level directory, not the maildir directories
21045 beneath.
21046
21047 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21048 &"belowhome"&. In the second and third cases, a home directory must have been
21049 set for the transport. This option is not useful when an explicit file name is
21050 given for normal mailbox deliveries. It is intended for the case when file
21051 names are generated from users' &_.forward_& files. These are usually handled
21052 by an &(appendfile)& transport called &%address_file%&. See also
21053 &%file_must_exist%&.
21054
21055
21056 .option directory appendfile string&!! unset
21057 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21058 or &%directory%& must be set, unless the delivery is the direct result of a
21059 redirection (see section &<<SECTfildiropt>>&).
21060
21061 When &%directory%& is set, the string is expanded, and the message is delivered
21062 into a new file or files in or below the given directory, instead of being
21063 appended to a single mailbox file. A number of different formats are provided
21064 (see &%maildir_format%& and &%mailstore_format%&), and see section
21065 &<<SECTopdir>>& for further details of this form of delivery.
21066
21067
21068 .option directory_file appendfile string&!! "see below"
21069 .cindex "base62"
21070 .vindex "&$inode$&"
21071 When &%directory%& is set, but neither &%maildir_format%& nor
21072 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21073 whose name is obtained by expanding this string. The default value is:
21074 .code
21075 q${base62:$tod_epoch}-$inode
21076 .endd
21077 This generates a unique name from the current time, in base 62 form, and the
21078 inode of the file. The variable &$inode$& is available only when expanding this
21079 option.
21080
21081
21082 .option directory_mode appendfile "octal integer" 0700
21083 If &(appendfile)& creates any directories as a result of the
21084 &%create_directory%& option, their mode is specified by this option.
21085
21086
21087 .option escape_string appendfile string "see description"
21088 See &%check_string%& above.
21089
21090
21091 .option file appendfile string&!! unset
21092 This option is mutually exclusive with the &%directory%& option, but one of
21093 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21094 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21095 specifies a single file, to which the message is appended. One or more of
21096 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21097 &%file%&.
21098
21099 .cindex "NFS" "lock file"
21100 .cindex "locking files"
21101 .cindex "lock files"
21102 If you are using more than one host to deliver over NFS into the same
21103 mailboxes, you should always use lock files.
21104
21105 The string value is expanded for each delivery, and must yield an absolute
21106 path. The most common settings of this option are variations on one of these
21107 examples:
21108 .code
21109 file = /var/spool/mail/$local_part
21110 file = /home/$local_part/inbox
21111 file = $home/inbox
21112 .endd
21113 .cindex "&""sticky""& bit"
21114 In the first example, all deliveries are done into the same directory. If Exim
21115 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21116 create a file in the directory, so the &"sticky"& bit must be turned on for
21117 deliveries to be possible, or alternatively the &%group%& option can be used to
21118 run the delivery under a group id which has write access to the directory.
21119
21120
21121
21122 .option file_format appendfile string unset
21123 .cindex "file" "mailbox; checking existing format"
21124 This option requests the transport to check the format of an existing file
21125 before adding to it. The check consists of matching a specific string at the
21126 start of the file. The value of the option consists of an even number of
21127 colon-separated strings. The first of each pair is the test string, and the
21128 second is the name of a transport. If the transport associated with a matched
21129 string is not the current transport, control is passed over to the other
21130 transport. For example, suppose the standard &(local_delivery)& transport has
21131 this added to it:
21132 .code
21133 file_format = "From       : local_delivery :\
21134                \1\1\1\1\n : local_mmdf_delivery"
21135 .endd
21136 Mailboxes that begin with &"From"& are still handled by this transport, but if
21137 a mailbox begins with four binary ones followed by a newline, control is passed
21138 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21139 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21140 is assumed to match the current transport. If the start of a mailbox doesn't
21141 match any string, or if the transport named for a given string is not defined,
21142 delivery is deferred.
21143
21144
21145 .option file_must_exist appendfile boolean false
21146 If this option is true, the file specified by the &%file%& option must exist.
21147 A temporary error occurs if it does not, causing delivery to be deferred.
21148 If this option is false, the file is created if it does not exist.
21149
21150
21151 .option lock_fcntl_timeout appendfile time 0s
21152 .cindex "timeout" "mailbox locking"
21153 .cindex "mailbox" "locking, blocking and non-blocking"
21154 .cindex "locking files"
21155 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21156 when locking an open mailbox file. If the call fails, the delivery process
21157 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21158 Non-blocking calls are used so that the file is not kept open during the wait
21159 for the lock; the reason for this is to make it as safe as possible for
21160 deliveries over NFS in the case when processes might be accessing an NFS
21161 mailbox without using a lock file. This should not be done, but
21162 misunderstandings and hence misconfigurations are not unknown.
21163
21164 On a busy system, however, the performance of a non-blocking lock approach is
21165 not as good as using a blocking lock with a timeout. In this case, the waiting
21166 is done inside the system call, and Exim's delivery process acquires the lock
21167 and can proceed as soon as the previous lock holder releases it.
21168
21169 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21170 timeout, are used. There may still be some retrying: the maximum number of
21171 retries is
21172 .code
21173 (lock_retries * lock_interval) / lock_fcntl_timeout
21174 .endd
21175 rounded up to the next whole number. In other words, the total time during
21176 which &(appendfile)& is trying to get a lock is roughly the same, unless
21177 &%lock_fcntl_timeout%& is set very large.
21178
21179 You should consider setting this option if you are getting a lot of delayed
21180 local deliveries because of errors of the form
21181 .code
21182 failed to lock mailbox /some/file (fcntl)
21183 .endd
21184
21185 .option lock_flock_timeout appendfile time 0s
21186 This timeout applies to file locking when using &[flock()]& (see
21187 &%use_flock%&); the timeout operates in a similar manner to
21188 &%lock_fcntl_timeout%&.
21189
21190
21191 .option lock_interval appendfile time 3s
21192 This specifies the time to wait between attempts to lock the file. See below
21193 for details of locking.
21194
21195
21196 .option lock_retries appendfile integer 10
21197 This specifies the maximum number of attempts to lock the file. A value of zero
21198 is treated as 1. See below for details of locking.
21199
21200
21201 .option lockfile_mode appendfile "octal integer" 0600
21202 This specifies the mode of the created lock file, when a lock file is being
21203 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21204
21205
21206 .option lockfile_timeout appendfile time 30m
21207 .cindex "timeout" "mailbox locking"
21208 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21209 exists and is older than this value, it is assumed to have been left behind by
21210 accident, and Exim attempts to remove it.
21211
21212
21213 .option mailbox_filecount appendfile string&!! unset
21214 .cindex "mailbox" "specifying size of"
21215 .cindex "size" "of mailbox"
21216 If this option is set, it is expanded, and the result is taken as the current
21217 number of files in the mailbox. It must be a decimal number, optionally
21218 followed by K or M. This provides a way of obtaining this information from an
21219 external source that maintains the data.
21220
21221
21222 .option mailbox_size appendfile string&!! unset
21223 .cindex "mailbox" "specifying size of"
21224 .cindex "size" "of mailbox"
21225 If this option is set, it is expanded, and the result is taken as the current
21226 size the mailbox. It must be a decimal number, optionally followed by K or M.
21227 This provides a way of obtaining this information from an external source that
21228 maintains the data. This is likely to be helpful for maildir deliveries where
21229 it is computationally expensive to compute the size of a mailbox.
21230
21231
21232
21233 .option maildir_format appendfile boolean false
21234 .cindex "maildir format" "specifying"
21235 If this option is set with the &%directory%& option, the delivery is into a new
21236 file, in the &"maildir"& format that is used by other mail software. When the
21237 transport is activated directly from a &(redirect)& router (for example, the
21238 &(address_file)& transport in the default configuration), setting
21239 &%maildir_format%& causes the path received from the router to be treated as a
21240 directory, whether or not it ends with &`/`&. This option is available only if
21241 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21242 &<<SECTmaildirdelivery>>& below for further details.
21243
21244
21245 .option maildir_quota_directory_regex appendfile string "See below"
21246 .cindex "maildir format" "quota; directories included in"
21247 .cindex "quota" "maildir; directories included in"
21248 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21249 a regular expression for specifying directories, relative to the quota
21250 directory (see &%quota_directory%&), that should be included in the quota
21251 calculation. The default value is:
21252 .code
21253 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21254 .endd
21255 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21256 (directories whose names begin with a dot). If you want to exclude the
21257 &_Trash_&
21258 folder from the count (as some sites do), you need to change this setting to
21259 .code
21260 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21261 .endd
21262 This uses a negative lookahead in the regular expression to exclude the
21263 directory whose name is &_.Trash_&. When a directory is excluded from quota
21264 calculations, quota processing is bypassed for any messages that are delivered
21265 directly into that directory.
21266
21267
21268 .option maildir_retries appendfile integer 10
21269 This option specifies the number of times to retry when writing a file in
21270 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21271
21272
21273 .option maildir_tag appendfile string&!! unset
21274 This option applies only to deliveries in maildir format, and is described in
21275 section &<<SECTmaildirdelivery>>& below.
21276
21277
21278 .option maildir_use_size_file appendfile&!! boolean false
21279 .cindex "maildir format" "&_maildirsize_& file"
21280 The result of string expansion for this option must be a valid boolean value.
21281 If it is true, it enables support for &_maildirsize_& files. Exim
21282 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21283 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21284 value is zero. See &%maildir_quota_directory_regex%& above and section
21285 &<<SECTmaildirdelivery>>& below for further details.
21286
21287 .option maildirfolder_create_regex appendfile string unset
21288 .cindex "maildir format" "&_maildirfolder_& file"
21289 .cindex "&_maildirfolder_&, creating"
21290 The value of this option is a regular expression. If it is unset, it has no
21291 effect. Otherwise, before a maildir delivery takes place, the pattern is
21292 matched against the name of the maildir directory, that is, the directory
21293 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21294 delivery. If there is a match, Exim checks for the existence of a file called
21295 &_maildirfolder_& in the directory, and creates it if it does not exist.
21296 See section &<<SECTmaildirdelivery>>& for more details.
21297
21298
21299 .option mailstore_format appendfile boolean false
21300 .cindex "mailstore format" "specifying"
21301 If this option is set with the &%directory%& option, the delivery is into two
21302 new files in  &"mailstore"& format. The option is available only if
21303 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21304 below for further details.
21305
21306
21307 .option mailstore_prefix appendfile string&!! unset
21308 This option applies only to deliveries in mailstore format, and is described in
21309 section &<<SECTopdir>>& below.
21310
21311
21312 .option mailstore_suffix appendfile string&!! unset
21313 This option applies only to deliveries in mailstore format, and is described in
21314 section &<<SECTopdir>>& below.
21315
21316
21317 .option mbx_format appendfile boolean false
21318 .cindex "locking files"
21319 .cindex "file" "locking"
21320 .cindex "file" "MBX format"
21321 .cindex "MBX format, specifying"
21322 This option is available only if Exim has been compiled with SUPPORT_MBX
21323 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21324 the message is appended to the mailbox file in MBX format instead of
21325 traditional Unix format. This format is supported by Pine4 and its associated
21326 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21327
21328 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21329 automatically changed by the use of &%mbx_format%&. They should normally be set
21330 empty when using MBX format, so this option almost always appears in this
21331 combination:
21332 .code
21333 mbx_format = true
21334 message_prefix =
21335 message_suffix =
21336 .endd
21337 If none of the locking options are mentioned in the configuration,
21338 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21339 is possible to specify the other kinds of locking with &%mbx_format%&, but
21340 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21341 interworks with &'c-client'&, providing for shared access to the mailbox. It
21342 should not be used if any program that does not use this form of locking is
21343 going to access the mailbox, nor should it be used if the mailbox file is NFS
21344 mounted, because it works only when the mailbox is accessed from a single host.
21345
21346 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21347 the standard version of &'c-client'&, because as long as it has a mailbox open
21348 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21349 append messages to it.
21350
21351
21352 .option message_prefix appendfile string&!! "see below"
21353 .cindex "&""From""& line"
21354 The string specified here is expanded and output at the start of every message.
21355 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21356 in which case it is:
21357 .code
21358 message_prefix = "From ${if def:return_path{$return_path}\
21359   {MAILER-DAEMON}} $tod_bsdinbox\n"
21360 .endd
21361 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21362 &`\n`& to &`\r\n`& in &%message_prefix%&.
21363
21364 .option message_suffix appendfile string&!! "see below"
21365 The string specified here is expanded and output at the end of every message.
21366 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21367 in which case it is a single newline character. The suffix can be suppressed by
21368 setting
21369 .code
21370 message_suffix =
21371 .endd
21372 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21373 &`\n`& to &`\r\n`& in &%message_suffix%&.
21374
21375 .option mode appendfile "octal integer" 0600
21376 If the output file is created, it is given this mode. If it already exists and
21377 has wider permissions, they are reduced to this mode. If it has narrower
21378 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21379 if the delivery is the result of a &%save%& command in a filter file specifying
21380 a particular mode, the mode of the output file is always forced to take that
21381 value, and this option is ignored.
21382
21383
21384 .option mode_fail_narrower appendfile boolean true
21385 This option applies in the case when an existing mailbox file has a narrower
21386 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21387 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21388 continues with the delivery attempt, using the existing mode of the file.
21389
21390
21391 .option notify_comsat appendfile boolean false
21392 If this option is true, the &'comsat'& daemon is notified after every
21393 successful delivery to a user mailbox. This is the daemon that notifies logged
21394 on users about incoming mail.
21395
21396
21397 .option quota appendfile string&!! unset
21398 .cindex "quota" "imposed by Exim"
21399 This option imposes a limit on the size of the file to which Exim is appending,
21400 or to the total space used in the directory tree when the &%directory%& option
21401 is set. In the latter case, computation of the space used is expensive, because
21402 all the files in the directory (and any sub-directories) have to be
21403 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21404 &%maildir_use_size_file%& for ways to avoid this in environments where users
21405 have no shell access to their mailboxes).
21406
21407 As there is no interlock against two simultaneous deliveries into a
21408 multi-file mailbox, it is possible for the quota to be overrun in this case.
21409 For single-file mailboxes, of course, an interlock is a necessity.
21410
21411 A file's size is taken as its &'used'& value. Because of blocking effects, this
21412 may be a lot less than the actual amount of disk space allocated to the file.
21413 If the sizes of a number of files are being added up, the rounding effect can
21414 become quite noticeable, especially on systems that have large block sizes.
21415 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21416 the obvious value which users understand most easily.
21417
21418 The value of the option is expanded, and must then be a numerical value
21419 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21420 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21421 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21422 be handled.
21423
21424 &*Note*&: A value of zero is interpreted as &"no quota"&.
21425
21426 The expansion happens while Exim is running as root, before it changes uid for
21427 the delivery. This means that files that are inaccessible to the end user can
21428 be used to hold quota values that are looked up in the expansion. When delivery
21429 fails because this quota is exceeded, the handling of the error is as for
21430 system quota failures.
21431
21432 By default, Exim's quota checking mimics system quotas, and restricts the
21433 mailbox to the specified maximum size, though the value is not accurate to the
21434 last byte, owing to separator lines and additional headers that may get added
21435 during message delivery. When a mailbox is nearly full, large messages may get
21436 refused even though small ones are accepted, because the size of the current
21437 message is added to the quota when the check is made. This behaviour can be
21438 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21439 for exceeding the quota does not include the current message. Thus, deliveries
21440 continue until the quota has been exceeded; thereafter, no further messages are
21441 delivered. See also &%quota_warn_threshold%&.
21442
21443
21444 .option quota_directory appendfile string&!! unset
21445 This option defines the directory to check for quota purposes when delivering
21446 into individual files. The default is the delivery directory, or, if a file
21447 called &_maildirfolder_& exists in a maildir directory, the parent of the
21448 delivery directory.
21449
21450
21451 .option quota_filecount appendfile string&!! 0
21452 This option applies when the &%directory%& option is set. It limits the total
21453 number of files in the directory (compare the inode limit in system quotas). It
21454 can only be used if &%quota%& is also set. The value is expanded; an expansion
21455 failure causes delivery to be deferred. A value of zero is interpreted as
21456 &"no quota"&.
21457
21458
21459 .option quota_is_inclusive appendfile boolean true
21460 See &%quota%& above.
21461
21462
21463 .option quota_size_regex appendfile string unset
21464 This option applies when one of the delivery modes that writes a separate file
21465 for each message is being used. When Exim wants to find the size of one of
21466 these files in order to test the quota, it first checks &%quota_size_regex%&.
21467 If this is set to a regular expression that matches the file name, and it
21468 captures one string, that string is interpreted as a representation of the
21469 file's size. The value of &%quota_size_regex%& is not expanded.
21470
21471 This feature is useful only when users have no shell access to their mailboxes
21472 &-- otherwise they could defeat the quota simply by renaming the files. This
21473 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21474 the file length to the file name. For example:
21475 .code
21476 maildir_tag = ,S=$message_size
21477 quota_size_regex = ,S=(\d+)
21478 .endd
21479 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21480 number of lines in the message.
21481
21482 The regular expression should not assume that the length is at the end of the
21483 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21484 sometimes add other information onto the ends of message file names.
21485
21486 Section &<<SECID136>>& contains further information.
21487
21488
21489 .option quota_warn_message appendfile string&!! "see below"
21490 See below for the use of this option. If it is not set when
21491 &%quota_warn_threshold%& is set, it defaults to
21492 .code
21493 quota_warn_message = "\
21494   To: $local_part@$domain\n\
21495   Subject: Your mailbox\n\n\
21496   This message is automatically created \
21497   by mail delivery software.\n\n\
21498   The size of your mailbox has exceeded \
21499   a warning threshold that is\n\
21500   set by the system administrator.\n"
21501 .endd
21502
21503
21504 .option quota_warn_threshold appendfile string&!! 0
21505 .cindex "quota" "warning threshold"
21506 .cindex "mailbox" "size warning"
21507 .cindex "size" "of mailbox"
21508 This option is expanded in the same way as &%quota%& (see above). If the
21509 resulting value is greater than zero, and delivery of the message causes the
21510 size of the file or total space in the directory tree to cross the given
21511 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21512 may be specified as a percentage of it by following the value with a percent
21513 sign. For example:
21514 .code
21515 quota = 10M
21516 quota_warn_threshold = 75%
21517 .endd
21518 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21519 percent sign is ignored.
21520
21521 The warning message itself is specified by the &%quota_warn_message%& option,
21522 and it must start with a &'To:'& header line containing the recipient(s) of the
21523 warning message. These do not necessarily have to include the recipient(s) of
21524 the original message. A &'Subject:'& line should also normally be supplied. You
21525 can include any other header lines that you want. If you do not include a
21526 &'From:'& line, the default is:
21527 .code
21528 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21529 .endd
21530 .oindex &%errors_reply_to%&
21531 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21532 option.
21533
21534 The &%quota%& option does not have to be set in order to use this option; they
21535 are independent of one another except when the threshold is specified as a
21536 percentage.
21537
21538
21539 .option use_bsmtp appendfile boolean false
21540 .cindex "envelope sender"
21541 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21542 format, with the envelope sender and recipient(s) included as SMTP commands. If
21543 you want to include a leading HELO command with such messages, you can do
21544 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21545 for details of batch SMTP.
21546
21547
21548 .option use_crlf appendfile boolean false
21549 .cindex "carriage return"
21550 .cindex "linefeed"
21551 This option causes lines to be terminated with the two-character CRLF sequence
21552 (carriage return, linefeed) instead of just a linefeed character. In the case
21553 of batched SMTP, the byte sequence written to the file is then an exact image
21554 of what would be sent down a real SMTP connection.
21555
21556 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21557 (which are used to supply the traditional &"From&~"& and blank line separators
21558 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21559 carriage return characters if these are needed. In cases where these options
21560 have non-empty defaults, the values end with a single linefeed, so they must be
21561 changed to end with &`\r\n`& if &%use_crlf%& is set.
21562
21563
21564 .option use_fcntl_lock appendfile boolean "see below"
21565 This option controls the use of the &[fcntl()]& function to lock a file for
21566 exclusive use when a message is being appended. It is set by default unless
21567 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21568 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21569 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21570
21571
21572 .option use_flock_lock appendfile boolean false
21573 This option is provided to support the use of &[flock()]& for file locking, for
21574 the few situations where it is needed. Most modern operating systems support
21575 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21576 each other. Exim uses &[fcntl()]& locking by default.
21577
21578 This option is required only if you are using an operating system where
21579 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21580 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21581 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21582
21583 .cindex "Solaris" "&[flock()]& support"
21584 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21585 have it (and some, I think, provide a not quite right version built on top of
21586 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21587 the ability to use it, and any attempt to do so will cause a configuration
21588 error.
21589
21590 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21591 is just being mapped onto &[fcntl()]& by the OS).
21592
21593
21594 .option use_lockfile appendfile boolean "see below"
21595 If this option is turned off, Exim does not attempt to create a lock file when
21596 appending to a mailbox file. In this situation, the only locking is by
21597 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21598 sure that every MUA that is ever going to look at your users' mailboxes uses
21599 &[fcntl()]& rather than a lock file, and even then only when you are not
21600 delivering over NFS from more than one host.
21601
21602 .cindex "NFS" "lock file"
21603 In order to append to an NFS file safely from more than one host, it is
21604 necessary to take out a lock &'before'& opening the file, and the lock file
21605 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21606 file corruption.
21607
21608 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21609 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21610 except when &%mbx_format%& is set.
21611
21612
21613 .option use_mbx_lock appendfile boolean "see below"
21614 This option is available only if Exim has been compiled with SUPPORT_MBX
21615 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21616 locking rules be used. It is set by default if &%mbx_format%& is set and none
21617 of the locking options are mentioned in the configuration. The locking rules
21618 are the same as are used by the &'c-client'& library that underlies Pine and
21619 the IMAP4 and POP daemons that come with it (see the discussion below). The
21620 rules allow for shared access to the mailbox. However, this kind of locking
21621 does not work when the mailbox is NFS mounted.
21622
21623 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21624 &%use_flock_lock%& to control what kind of locking is used in implementing the
21625 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21626 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21627
21628
21629
21630
21631 .section "Operational details for appending" "SECTopappend"
21632 .cindex "appending to a file"
21633 .cindex "file" "appending"
21634 Before appending to a file, the following preparations are made:
21635
21636 .ilist
21637 If the name of the file is &_/dev/null_&, no action is taken, and a success
21638 return is given.
21639
21640 .next
21641 .cindex "directory creation"
21642 If any directories on the file's path are missing, Exim creates them if the
21643 &%create_directory%& option is set. A created directory's mode is given by the
21644 &%directory_mode%& option.
21645
21646 .next
21647 If &%file_format%& is set, the format of an existing file is checked. If this
21648 indicates that a different transport should be used, control is passed to that
21649 transport.
21650
21651 .next
21652 .cindex "file" "locking"
21653 .cindex "locking files"
21654 .cindex "NFS" "lock file"
21655 If &%use_lockfile%& is set, a lock file is built in a way that will work
21656 reliably over NFS, as follows:
21657
21658 .olist
21659 Create a &"hitching post"& file whose name is that of the lock file with the
21660 current time, primary host name, and process id added, by opening for writing
21661 as a new file. If this fails with an access error, delivery is deferred.
21662 .next
21663 Close the hitching post file, and hard link it to the lock file name.
21664 .next
21665 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21666 Unlink the hitching post name.
21667 .next
21668 Otherwise, use &[stat()]& to get information about the hitching post file, and
21669 then unlink hitching post name. If the number of links is exactly two, creation
21670 of the lock file succeeded but something (for example, an NFS server crash and
21671 restart) caused this fact not to be communicated to the &[link()]& call.
21672 .next
21673 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21674 up to &%lock_retries%& times. However, since any program that writes to a
21675 mailbox should complete its task very quickly, it is reasonable to time out old
21676 lock files that are normally the result of user agent and system crashes. If an
21677 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21678 it before trying again.
21679 .endlist olist
21680
21681 .next
21682 A call is made to &[lstat()]& to discover whether the main file exists, and if
21683 so, what its characteristics are. If &[lstat()]& fails for any reason other
21684 than non-existence, delivery is deferred.
21685
21686 .next
21687 .cindex "symbolic link" "to mailbox"
21688 .cindex "mailbox" "symbolic link"
21689 If the file does exist and is a symbolic link, delivery is deferred, unless the
21690 &%allow_symlink%& option is set, in which case the ownership of the link is
21691 checked, and then &[stat()]& is called to find out about the real file, which
21692 is then subjected to the checks below. The check on the top-level link
21693 ownership prevents one user creating a link for another's mailbox in a sticky
21694 directory, though allowing symbolic links in this case is definitely not a good
21695 idea. If there is a chain of symbolic links, the intermediate ones are not
21696 checked.
21697
21698 .next
21699 If the file already exists but is not a regular file, or if the file's owner
21700 and group (if the group is being checked &-- see &%check_group%& above) are
21701 different from the user and group under which the delivery is running,
21702 delivery is deferred.
21703
21704 .next
21705 If the file's permissions are more generous than specified, they are reduced.
21706 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21707 is set false, in which case the delivery is tried using the existing
21708 permissions.
21709
21710 .next
21711 The file's inode number is saved, and the file is then opened for appending.
21712 If this fails because the file has vanished, &(appendfile)& behaves as if it
21713 hadn't existed (see below). For any other failures, delivery is deferred.
21714
21715 .next
21716 If the file is opened successfully, check that the inode number hasn't
21717 changed, that it is still a regular file, and that the owner and permissions
21718 have not changed. If anything is wrong, defer delivery and freeze the message.
21719
21720 .next
21721 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21722 option is set. Otherwise, check that the file is being created in a permitted
21723 directory if the &%create_file%& option is set (deferring on failure), and then
21724 open for writing as a new file, with the O_EXCL and O_CREAT options,
21725 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21726 set). In this case, which can happen if the link points to a non-existent file,
21727 the file is opened for writing using O_CREAT but not O_EXCL, because
21728 that prevents link following.
21729
21730 .next
21731 .cindex "loop" "while file testing"
21732 If opening fails because the file exists, obey the tests given above for
21733 existing files. However, to avoid looping in a situation where the file is
21734 being continuously created and destroyed, the exists/not-exists loop is broken
21735 after 10 repetitions, and the message is then frozen.
21736
21737 .next
21738 If opening fails with any other error, defer delivery.
21739
21740 .next
21741 .cindex "file" "locking"
21742 .cindex "locking files"
21743 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21744 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21745 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21746 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21747 file, and an exclusive lock on the file whose name is
21748 .code
21749 /tmp/.<device-number>.<inode-number>
21750 .endd
21751 using the device and inode numbers of the open mailbox file, in accordance with
21752 the MBX locking rules. This file is created with a mode that is specified by
21753 the &%lockfile_mode%& option.
21754
21755 If Exim fails to lock the file, there are two possible courses of action,
21756 depending on the value of the locking timeout. This is obtained from
21757 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21758
21759 If the timeout value is zero, the file is closed, Exim waits for
21760 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21761 to lock it again. This happens up to &%lock_retries%& times, after which the
21762 delivery is deferred.
21763
21764 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21765 &[flock()]& are used (with the given timeout), so there has already been some
21766 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21767 immediately. It retries up to
21768 .code
21769 (lock_retries * lock_interval) / <timeout>
21770 .endd
21771 times (rounded up).
21772 .endlist
21773
21774 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21775 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21776
21777
21778 .section "Operational details for delivery to a new file" "SECTopdir"
21779 .cindex "delivery" "to single file"
21780 .cindex "&""From""& line"
21781 When the &%directory%& option is set instead of &%file%&, each message is
21782 delivered into a newly-created file or set of files. When &(appendfile)& is
21783 activated directly from a &(redirect)& router, neither &%file%& nor
21784 &%directory%& is normally set, because the path for delivery is supplied by the
21785 router. (See for example, the &(address_file)& transport in the default
21786 configuration.) In this case, delivery is to a new file if either the path name
21787 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21788
21789 No locking is required while writing the message to a new file, so the various
21790 locking options of the transport are ignored. The &"From"& line that by default
21791 separates messages in a single file is not normally needed, nor is the escaping
21792 of message lines that start with &"From"&, and there is no need to ensure a
21793 newline at the end of each message. Consequently, the default values for
21794 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21795 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21796
21797 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21798 the files in the delivery directory by default. However, you can specify a
21799 different directory by setting &%quota_directory%&. Also, for maildir
21800 deliveries (see below) the &_maildirfolder_& convention is honoured.
21801
21802
21803 .cindex "maildir format"
21804 .cindex "mailstore format"
21805 There are three different ways in which delivery to individual files can be
21806 done, controlled by the settings of the &%maildir_format%& and
21807 &%mailstore_format%& options. Note that code to support maildir or mailstore
21808 formats is not included in the binary unless SUPPORT_MAILDIR or
21809 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21810
21811 .cindex "directory creation"
21812 In all three cases an attempt is made to create the directory and any necessary
21813 sub-directories if they do not exist, provided that the &%create_directory%&
21814 option is set (the default). The location of a created directory can be
21815 constrained by setting &%create_file%&. A created directory's mode is given by
21816 the &%directory_mode%& option. If creation fails, or if the
21817 &%create_directory%& option is not set when creation is required, delivery is
21818 deferred.
21819
21820
21821
21822 .section "Maildir delivery" "SECTmaildirdelivery"
21823 .cindex "maildir format" "description of"
21824 If the &%maildir_format%& option is true, Exim delivers each message by writing
21825 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21826 directory that is defined by the &%directory%& option (the &"delivery
21827 directory"&). If the delivery is successful, the file is renamed into the
21828 &_new_& subdirectory.
21829
21830 In the file name, <&'stime'&> is the current time of day in seconds, and
21831 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21832 Exim checks that the time-of-day clock has moved on by at least one microsecond
21833 before terminating the delivery process. This guarantees uniqueness for the
21834 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21835 opening it. If any response other than ENOENT (does not exist) is given,
21836 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21837
21838 Before Exim carries out a maildir delivery, it ensures that subdirectories
21839 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21840 do not exist, Exim tries to create them and any superior directories in their
21841 path, subject to the &%create_directory%& and &%create_file%& options. If the
21842 &%maildirfolder_create_regex%& option is set, and the regular expression it
21843 contains matches the delivery directory, Exim also ensures that a file called
21844 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21845 &_maildirfolder_& file cannot be created, delivery is deferred.
21846
21847 These features make it possible to use Exim to create all the necessary files
21848 and directories in a maildir mailbox, including subdirectories for maildir++
21849 folders. Consider this example:
21850 .code
21851 maildir_format = true
21852 directory = /var/mail/$local_part\
21853            ${if eq{$local_part_suffix}{}{}\
21854            {/.${substr_1:$local_part_suffix}}}
21855 maildirfolder_create_regex = /\.[^/]+$
21856 .endd
21857 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21858 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21859 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21860 not match this name, so Exim will not look for or create the file
21861 &_/var/mail/pimbo/maildirfolder_&, though it will create
21862 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21863
21864 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21865 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21866 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21867 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21868 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21869
21870 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21871 not inadvertently match the toplevel maildir directory, because a
21872 &_maildirfolder_& file at top level would completely break quota calculations.
21873
21874 .cindex "quota" "in maildir delivery"
21875 .cindex "maildir++"
21876 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21877 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21878 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21879 Exim assumes the directory is a maildir++ folder directory, which is one level
21880 down from the user's top level mailbox directory. This causes it to start at
21881 the parent directory instead of the current directory when calculating the
21882 amount of space used.
21883
21884 One problem with delivering into a multi-file mailbox is that it is
21885 computationally expensive to compute the size of the mailbox for quota
21886 checking. Various approaches have been taken to reduce the amount of work
21887 needed. The next two sections describe two of them. A third alternative is to
21888 use some external process for maintaining the size data, and use the expansion
21889 of the &%mailbox_size%& option as a way of importing it into Exim.
21890
21891
21892
21893
21894 .section "Using tags to record message sizes" "SECID135"
21895 If &%maildir_tag%& is set, the string is expanded for each delivery.
21896 When the maildir file is renamed into the &_new_& sub-directory, the
21897 tag is added to its name. However, if adding the tag takes the length of the
21898 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21899 the tag is dropped and the maildir file is created with no tag.
21900
21901
21902 .vindex "&$message_size$&"
21903 Tags can be used to encode the size of files in their names; see
21904 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21905 happens after the message has been written. The value of the &$message_size$&
21906 variable is set to the number of bytes actually written. If the expansion is
21907 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21908 be deferred. The expanded tag may contain any printing characters except &"/"&.
21909 Non-printing characters in the string are ignored; if the resulting string is
21910 empty, it is ignored. If it starts with an alphanumeric character, a leading
21911 colon is inserted; this default has not proven to be the path that popular
21912 maildir implementations have chosen (but changing it in Exim would break
21913 backwards compatibility).
21914
21915 For one common implementation, you might set:
21916 .code
21917 maildir_tag = ,S=${message_size}
21918 .endd
21919 but you should check the documentation of the other software to be sure.
21920
21921 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21922 as this allows Exim to extract the size from your tag, instead of having to
21923 &[stat()]& each message file.
21924
21925
21926 .section "Using a maildirsize file" "SECID136"
21927 .cindex "quota" "in maildir delivery"
21928 .cindex "maildir format" "&_maildirsize_& file"
21929 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21930 storing quota and message size information in a file called &_maildirsize_&
21931 within the toplevel maildir directory. If this file does not exist, Exim
21932 creates it, setting the quota from the &%quota%& option of the transport. If
21933 the maildir directory itself does not exist, it is created before any attempt
21934 to write a &_maildirsize_& file.
21935
21936 The &_maildirsize_& file is used to hold information about the sizes of
21937 messages in the maildir, thus speeding up quota calculations. The quota value
21938 in the file is just a cache; if the quota is changed in the transport, the new
21939 value overrides the cached value when the next message is delivered. The cache
21940 is maintained for the benefit of other programs that access the maildir and
21941 need to know the quota.
21942
21943 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21944 file is maintained (with a zero quota setting), but no quota is imposed.
21945
21946 A regular expression is available for controlling which directories in the
21947 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21948 See the description of the &%maildir_quota_directory_regex%& option above for
21949 details.
21950
21951
21952 .section "Mailstore delivery" "SECID137"
21953 .cindex "mailstore format" "description of"
21954 If the &%mailstore_format%& option is true, each message is written as two
21955 files in the given directory. A unique base name is constructed from the
21956 message id and the current delivery process, and the files that are written use
21957 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21958 contains the message's envelope, and the &_.msg_& file contains the message
21959 itself. The base name is placed in the variable &$mailstore_basename$&.
21960
21961 During delivery, the envelope is first written to a file with the suffix
21962 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21963 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21964 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21965 file before accessing either of them. An alternative approach is to wait for
21966 the absence of a &_.tmp_& file.
21967
21968 The envelope file starts with any text defined by the &%mailstore_prefix%&
21969 option, expanded and terminated by a newline if there isn't one. Then follows
21970 the sender address on one line, then all the recipient addresses, one per line.
21971 There can be more than one recipient only if the &%batch_max%& option is set
21972 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21973 appended to the file, followed by a newline if it does not end with one.
21974
21975 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21976 failure, it is ignored. Other expansion errors are treated as serious
21977 configuration errors, and delivery is deferred. The variable
21978 &$mailstore_basename$& is available for use during these expansions.
21979
21980
21981 .section "Non-special new file delivery" "SECID138"
21982 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21983 file is created directly in the named directory. For example, when delivering
21984 messages into files in batched SMTP format for later delivery to some host (see
21985 section &<<SECTbatchSMTP>>&), a setting such as
21986 .code
21987 directory = /var/bsmtp/$host
21988 .endd
21989 might be used. A message is written to a file with a temporary name, which is
21990 then renamed when the delivery is complete. The final name is obtained by
21991 expanding the contents of the &%directory_file%& option.
21992 .ecindex IIDapptra1
21993 .ecindex IIDapptra2
21994
21995
21996
21997
21998
21999
22000 . ////////////////////////////////////////////////////////////////////////////
22001 . ////////////////////////////////////////////////////////////////////////////
22002
22003 .chapter "The autoreply transport" "CHID8"
22004 .scindex IIDauttra1 "transports" "&(autoreply)&"
22005 .scindex IIDauttra2 "&(autoreply)& transport"
22006 The &(autoreply)& transport is not a true transport in that it does not cause
22007 the message to be transmitted. Instead, it generates a new mail message as an
22008 automatic reply to the incoming message. &'References:'& and
22009 &'Auto-Submitted:'& header lines are included. These are constructed according
22010 to the rules in RFCs 2822 and 3834, respectively.
22011
22012 If the router that passes the message to this transport does not have the
22013 &%unseen%& option set, the original message (for the current recipient) is not
22014 delivered anywhere. However, when the &%unseen%& option is set on the router
22015 that passes the message to this transport, routing of the address continues, so
22016 another router can set up a normal message delivery.
22017
22018
22019 The &(autoreply)& transport is usually run as the result of mail filtering, a
22020 &"vacation"& message being the standard example. However, it can also be run
22021 directly from a router like any other transport. To reduce the possibility of
22022 message cascades, messages created by the &(autoreply)& transport always have
22023 empty envelope sender addresses, like bounce messages.
22024
22025 The parameters of the message to be sent can be specified in the configuration
22026 by options described below. However, these are used only when the address
22027 passed to the transport does not contain its own reply information. When the
22028 transport is run as a consequence of a
22029 &%mail%&
22030 or &%vacation%& command in a filter file, the parameters of the message are
22031 supplied by the filter, and passed with the address. The transport's options
22032 that define the message are then ignored (so they are not usually set in this
22033 case). The message is specified entirely by the filter or by the transport; it
22034 is never built from a mixture of options. However, the &%file_optional%&,
22035 &%mode%&, and &%return_message%& options apply in all cases.
22036
22037 &(Autoreply)& is implemented as a local transport. When used as a result of a
22038 command in a user's filter file, &(autoreply)& normally runs under the uid and
22039 gid of the user, and with appropriate current and home directories (see chapter
22040 &<<CHAPenvironment>>&).
22041
22042 There is a subtle difference between routing a message to a &(pipe)& transport
22043 that generates some text to be returned to the sender, and routing it to an
22044 &(autoreply)& transport. This difference is noticeable only if more than one
22045 address from the same message is so handled. In the case of a pipe, the
22046 separate outputs from the different addresses are gathered up and returned to
22047 the sender in a single message, whereas if &(autoreply)& is used, a separate
22048 message is generated for each address that is passed to it.
22049
22050 Non-printing characters are not permitted in the header lines generated for the
22051 message that &(autoreply)& creates, with the exception of newlines that are
22052 immediately followed by white space. If any non-printing characters are found,
22053 the transport defers.
22054 Whether characters with the top bit set count as printing characters or not is
22055 controlled by the &%print_topbitchars%& global option.
22056
22057 If any of the generic options for manipulating headers (for example,
22058 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22059 of the original message that is included in the generated message when
22060 &%return_message%& is set. They do not apply to the generated message itself.
22061
22062 .vindex "&$sender_address$&"
22063 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22064 the message, indicating that there were no recipients, it does not treat this
22065 as an error. This means that autoreplies sent to &$sender_address$& when this
22066 is empty (because the incoming message is a bounce message) do not cause
22067 problems. They are just discarded.
22068
22069
22070
22071 .section "Private options for autoreply" "SECID139"
22072 .cindex "options" "&(autoreply)& transport"
22073
22074 .option bcc autoreply string&!! unset
22075 This specifies the addresses that are to receive &"blind carbon copies"& of the
22076 message when the message is specified by the transport.
22077
22078
22079 .option cc autoreply string&!! unset
22080 This specifies recipients of the message and the contents of the &'Cc:'& header
22081 when the message is specified by the transport.
22082
22083
22084 .option file autoreply string&!! unset
22085 The contents of the file are sent as the body of the message when the message
22086 is specified by the transport. If both &%file%& and &%text%& are set, the text
22087 string comes first.
22088
22089
22090 .option file_expand autoreply boolean false
22091 If this is set, the contents of the file named by the &%file%& option are
22092 subjected to string expansion as they are added to the message.
22093
22094
22095 .option file_optional autoreply boolean false
22096 If this option is true, no error is generated if the file named by the &%file%&
22097 option or passed with the address does not exist or cannot be read.
22098
22099
22100 .option from autoreply string&!! unset
22101 This specifies the contents of the &'From:'& header when the message is
22102 specified by the transport.
22103
22104
22105 .option headers autoreply string&!! unset
22106 This specifies additional RFC 2822 headers that are to be added to the message
22107 when the message is specified by the transport. Several can be given by using
22108 &"\n"& to separate them. There is no check on the format.
22109
22110
22111 .option log autoreply string&!! unset
22112 This option names a file in which a record of every message sent is logged when
22113 the message is specified by the transport.
22114
22115
22116 .option mode autoreply "octal integer" 0600
22117 If either the log file or the &"once"& file has to be created, this mode is
22118 used.
22119
22120
22121 .option never_mail autoreply "address list&!!" unset
22122 If any run of the transport creates a message with a recipient that matches any
22123 item in the list, that recipient is quietly discarded. If all recipients are
22124 discarded, no message is created. This applies both when the recipients are
22125 generated by a filter and when they are specified in the transport.
22126
22127
22128
22129 .option once autoreply string&!! unset
22130 This option names a file or DBM database in which a record of each &'To:'&
22131 recipient is kept when the message is specified by the transport. &*Note*&:
22132 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22133
22134 If &%once%& is unset, or is set to an empty string, the message is always sent.
22135 By default, if &%once%& is set to a non-empty file name, the message
22136 is not sent if a potential recipient is already listed in the database.
22137 However, if the &%once_repeat%& option specifies a time greater than zero, the
22138 message is sent if that much time has elapsed since a message was last sent to
22139 this recipient. A setting of zero time for &%once_repeat%& (the default)
22140 prevents a message from being sent a second time &-- in this case, zero means
22141 infinity.
22142
22143 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22144 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22145 greater than zero, it changes the way Exim implements the &%once%& option.
22146 Instead of using a DBM file to record every recipient it sends to, it uses a
22147 regular file, whose size will never get larger than the given value.
22148
22149 In the file, Exim keeps a linear list of recipient addresses and the times at
22150 which they were sent messages. If the file is full when a new address needs to
22151 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22152 means that a given recipient may receive multiple messages, but at
22153 unpredictable intervals that depend on the rate of turnover of addresses in the
22154 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22155
22156
22157 .option once_file_size autoreply integer 0
22158 See &%once%& above.
22159
22160
22161 .option once_repeat autoreply time&!! 0s
22162 See &%once%& above.
22163 After expansion, the value of this option must be a valid time value.
22164
22165
22166 .option reply_to autoreply string&!! unset
22167 This specifies the contents of the &'Reply-To:'& header when the message is
22168 specified by the transport.
22169
22170
22171 .option return_message autoreply boolean false
22172 If this is set, a copy of the original message is returned with the new
22173 message, subject to the maximum size set in the &%return_size_limit%& global
22174 configuration option.
22175
22176
22177 .option subject autoreply string&!! unset
22178 This specifies the contents of the &'Subject:'& header when the message is
22179 specified by the transport. It is tempting to quote the original subject in
22180 automatic responses. For example:
22181 .code
22182 subject = Re: $h_subject:
22183 .endd
22184 There is a danger in doing this, however. It may allow a third party to
22185 subscribe your users to an opt-in mailing list, provided that the list accepts
22186 bounce messages as subscription confirmations. Well-managed lists require a
22187 non-bounce message to confirm a subscription, so the danger is relatively
22188 small.
22189
22190
22191
22192 .option text autoreply string&!! unset
22193 This specifies a single string to be used as the body of the message when the
22194 message is specified by the transport. If both &%text%& and &%file%& are set,
22195 the text comes first.
22196
22197
22198 .option to autoreply string&!! unset
22199 This specifies recipients of the message and the contents of the &'To:'& header
22200 when the message is specified by the transport.
22201 .ecindex IIDauttra1
22202 .ecindex IIDauttra2
22203
22204
22205
22206
22207 . ////////////////////////////////////////////////////////////////////////////
22208 . ////////////////////////////////////////////////////////////////////////////
22209
22210 .chapter "The lmtp transport" "CHAPLMTP"
22211 .cindex "transports" "&(lmtp)&"
22212 .cindex "&(lmtp)& transport"
22213 .cindex "LMTP" "over a pipe"
22214 .cindex "LMTP" "over a socket"
22215 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22216 specified command
22217 or by interacting with a Unix domain socket.
22218 This transport is something of a cross between the &(pipe)& and &(smtp)&
22219 transports. Exim also has support for using LMTP over TCP/IP; this is
22220 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22221 to be of minority interest, the default build-time configure in &_src/EDITME_&
22222 has it commented out. You need to ensure that
22223 .code
22224 TRANSPORT_LMTP=yes
22225 .endd
22226 .cindex "options" "&(lmtp)& transport"
22227 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22228 included in the Exim binary. The private options of the &(lmtp)& transport are
22229 as follows:
22230
22231 .option batch_id lmtp string&!! unset
22232 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22233
22234
22235 .option batch_max lmtp integer 1
22236 This limits the number of addresses that can be handled in a single delivery.
22237 Most LMTP servers can handle several addresses at once, so it is normally a
22238 good idea to increase this value. See the description of local delivery
22239 batching in chapter &<<CHAPbatching>>&.
22240
22241
22242 .option command lmtp string&!! unset
22243 This option must be set if &%socket%& is not set. The string is a command which
22244 is run in a separate process. It is split up into a command name and list of
22245 arguments, each of which is separately expanded (so expansion cannot change the
22246 number of arguments). The command is run directly, not via a shell. The message
22247 is passed to the new process using the standard input and output to operate the
22248 LMTP protocol.
22249
22250 .option ignore_quota lmtp boolean false
22251 .cindex "LMTP" "ignoring quota errors"
22252 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22253 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22254 in its response to the LHLO command.
22255
22256 .option socket lmtp string&!! unset
22257 This option must be set if &%command%& is not set. The result of expansion must
22258 be the name of a Unix domain socket. The transport connects to the socket and
22259 delivers the message to it using the LMTP protocol.
22260
22261
22262 .option timeout lmtp time 5m
22263 The transport is aborted if the created process or Unix domain socket does not
22264 respond to LMTP commands or message input within this timeout. Delivery
22265 is deferred, and will be tried again later. Here is an example of a typical
22266 LMTP transport:
22267 .code
22268 lmtp:
22269   driver = lmtp
22270   command = /some/local/lmtp/delivery/program
22271   batch_max = 20
22272   user = exim
22273 .endd
22274 This delivers up to 20 addresses at a time, in a mixture of domains if
22275 necessary, running as the user &'exim'&.
22276
22277
22278
22279 . ////////////////////////////////////////////////////////////////////////////
22280 . ////////////////////////////////////////////////////////////////////////////
22281
22282 .chapter "The pipe transport" "CHAPpipetransport"
22283 .scindex IIDpiptra1 "transports" "&(pipe)&"
22284 .scindex IIDpiptra2 "&(pipe)& transport"
22285 The &(pipe)& transport is used to deliver messages via a pipe to a command
22286 running in another process. One example is the use of &(pipe)& as a
22287 pseudo-remote transport for passing messages to some other delivery mechanism
22288 (such as UUCP). Another is the use by individual users to automatically process
22289 their incoming messages. The &(pipe)& transport can be used in one of the
22290 following ways:
22291
22292 .ilist
22293 .vindex "&$local_part$&"
22294 A router routes one address to a transport in the normal way, and the
22295 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22296 contains the local part of the address (as usual), and the command that is run
22297 is specified by the &%command%& option on the transport.
22298 .next
22299 .vindex "&$pipe_addresses$&"
22300 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22301 transport can handle more than one address in a single run. In this case, when
22302 more than one address is routed to the transport, &$local_part$& is not set
22303 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22304 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22305 that are routed to the transport.
22306 .next
22307 .vindex "&$address_pipe$&"
22308 A router redirects an address directly to a pipe command (for example, from an
22309 alias or forward file). In this case, &$address_pipe$& contains the text of the
22310 pipe command, and the &%command%& option on the transport is ignored unless
22311 &%force_command%& is set. If only one address is being transported
22312 (&%batch_max%& is not greater than one, or only one address was redirected to
22313 this pipe command), &$local_part$& contains the local part that was redirected.
22314 .endlist
22315
22316
22317 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22318 deliver messages over pipes using the LMTP interactive protocol. This is
22319 implemented by the &(lmtp)& transport.
22320
22321 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22322 &_.forward_& file, the command runs under the uid and gid of that user. In
22323 other cases, the uid and gid have to be specified explicitly, either on the
22324 transport or on the router that handles the address. Current and &"home"&
22325 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22326 details of the local delivery environment and chapter &<<CHAPbatching>>&
22327 for a discussion of local delivery batching.
22328
22329
22330 .section "Concurrent delivery" "SECID140"
22331 If two messages arrive at almost the same time, and both are routed to a pipe
22332 delivery, the two pipe transports may be run concurrently. You must ensure that
22333 any pipe commands you set up are robust against this happening. If the commands
22334 write to a file, the &%exim_lock%& utility might be of use.
22335
22336
22337
22338
22339 .section "Returned status and data" "SECID141"
22340 .cindex "&(pipe)& transport" "returned data"
22341 If the command exits with a non-zero return code, the delivery is deemed to
22342 have failed, unless either the &%ignore_status%& option is set (in which case
22343 the return code is treated as zero), or the return code is one of those listed
22344 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22345 later"&. In this case, delivery is deferred. Details of a permanent failure are
22346 logged, but are not included in the bounce message, which merely contains
22347 &"local delivery failed"&.
22348
22349 If the command exits on a signal and the &%freeze_signal%& option is set then
22350 the message will be frozen in the queue. If that option is not set, a bounce
22351 will be sent as normal.
22352
22353 If the return code is greater than 128 and the command being run is a shell
22354 script, it normally means that the script was terminated by a signal whose
22355 value is the return code minus 128. The &%freeze_signal%& option does not
22356 apply in this case.
22357
22358 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22359 return code is set to 127. This is the value that a shell returns if it is
22360 asked to run a non-existent command. The wording for the log line suggests that
22361 a non-existent command may be the problem.
22362
22363 The &%return_output%& option can affect the result of a pipe delivery. If it is
22364 set and the command produces any output on its standard output or standard
22365 error streams, the command is considered to have failed, even if it gave a zero
22366 return code or if &%ignore_status%& is set. The output from the command is
22367 included as part of the bounce message. The &%return_fail_output%& option is
22368 similar, except that output is returned only when the command exits with a
22369 failure return code, that is, a value other than zero or a code that matches
22370 &%temp_errors%&.
22371
22372
22373
22374 .section "How the command is run" "SECThowcommandrun"
22375 .cindex "&(pipe)& transport" "path for command"
22376 The command line is (by default) broken down into a command name and arguments
22377 by the &(pipe)& transport itself. The &%allow_commands%& and
22378 &%restrict_to_path%& options can be used to restrict the commands that may be
22379 run.
22380
22381 .cindex "quoting" "in pipe command"
22382 Unquoted arguments are delimited by white space. If an argument appears in
22383 double quotes, backslash is interpreted as an escape character in the usual
22384 way. If an argument appears in single quotes, no escaping is done.
22385
22386 String expansion is applied to the command line except when it comes from a
22387 traditional &_.forward_& file (commands from a filter file are expanded). The
22388 expansion is applied to each argument in turn rather than to the whole line.
22389 For this reason, any string expansion item that contains white space must be
22390 quoted so as to be contained within a single argument. A setting such as
22391 .code
22392 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22393 .endd
22394 will not work, because the expansion item gets split between several
22395 arguments. You have to write
22396 .code
22397 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22398 .endd
22399 to ensure that it is all in one argument. The expansion is done in this way,
22400 argument by argument, so that the number of arguments cannot be changed as a
22401 result of expansion, and quotes or backslashes in inserted variables do not
22402 interact with external quoting. However, this leads to problems if you want to
22403 generate multiple arguments (or the command name plus arguments) from a single
22404 expansion. In this situation, the simplest solution is to use a shell. For
22405 example:
22406 .code
22407 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22408 .endd
22409
22410 .cindex "transport" "filter"
22411 .cindex "filter" "transport filter"
22412 .vindex "&$pipe_addresses$&"
22413 Special handling takes place when an argument consists of precisely the text
22414 &`$pipe_addresses`&. This is not a general expansion variable; the only
22415 place this string is recognized is when it appears as an argument for a pipe or
22416 transport filter command. It causes each address that is being handled to be
22417 inserted in the argument list at that point &'as a separate argument'&. This
22418 avoids any problems with spaces or shell metacharacters, and is of use when a
22419 &(pipe)& transport is handling groups of addresses in a batch.
22420
22421 If &%force_command%& is enabled on the transport, Special handling takes place
22422 for an argument that consists of precisely the text &`$address_pipe`&.  It
22423 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22424 argument is inserted in the argument list at that point
22425 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22426 the only item in the argument; in fact, if it were then &%force_command%&
22427 should behave as a no-op.  Rather, it should be used to adjust the command
22428 run while preserving the argument vector separation.
22429
22430 After splitting up into arguments and expansion, the resulting command is run
22431 in a subprocess directly from the transport, &'not'& under a shell. The
22432 message that is being delivered is supplied on the standard input, and the
22433 standard output and standard error are both connected to a single pipe that is
22434 read by Exim. The &%max_output%& option controls how much output the command
22435 may produce, and the &%return_output%& and &%return_fail_output%& options
22436 control what is done with it.
22437
22438 Not running the command under a shell (by default) lessens the security risks
22439 in cases when a command from a user's filter file is built out of data that was
22440 taken from an incoming message. If a shell is required, it can of course be
22441 explicitly specified as the command to be run. However, there are circumstances
22442 where existing commands (for example, in &_.forward_& files) expect to be run
22443 under a shell and cannot easily be modified. To allow for these cases, there is
22444 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22445 works. Instead of breaking up the command line as just described, it expands it
22446 as a single string and passes the result to &_/bin/sh_&. The
22447 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22448 with &%use_shell%&, and the whole mechanism is inherently less secure.
22449
22450
22451
22452 .section "Environment variables" "SECTpipeenv"
22453 .cindex "&(pipe)& transport" "environment for command"
22454 .cindex "environment for pipe transport"
22455 The environment variables listed below are set up when the command is invoked.
22456 This list is a compromise for maximum compatibility with other MTAs. Note that
22457 the &%environment%& option can be used to add additional variables to this
22458 environment.
22459 .display
22460 &`DOMAIN            `&   the domain of the address
22461 &`HOME              `&   the home directory, if set
22462 &`HOST              `&   the host name when called from a router (see below)
22463 &`LOCAL_PART        `&   see below
22464 &`LOCAL_PART_PREFIX `&   see below
22465 &`LOCAL_PART_SUFFIX `&   see below
22466 &`LOGNAME           `&   see below
22467 &`MESSAGE_ID        `&   Exim's local ID for the message
22468 &`PATH              `&   as specified by the &%path%& option below
22469 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22470 &`RECIPIENT         `&   the complete recipient address
22471 &`SENDER            `&   the sender of the message (empty if a bounce)
22472 &`SHELL             `&   &`/bin/sh`&
22473 &`TZ                `&   the value of the &%timezone%& option, if set
22474 &`USER              `&   see below
22475 .endd
22476 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22477 router, LOCAL_PART is set to the local part of the address. When it is
22478 called as a result of a forward or alias expansion, LOCAL_PART is set to
22479 the local part of the address that was expanded. In both cases, any affixes are
22480 removed from the local part, and made available in LOCAL_PART_PREFIX and
22481 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22482 same value as LOCAL_PART for compatibility with other MTAs.
22483
22484 .cindex "HOST"
22485 HOST is set only when a &(pipe)& transport is called from a router that
22486 associates hosts with an address, typically when using &(pipe)& as a
22487 pseudo-remote transport. HOST is set to the first host name specified by
22488 the router.
22489
22490 .cindex "HOME"
22491 If the transport's generic &%home_directory%& option is set, its value is used
22492 for the HOME environment variable. Otherwise, a home directory may be set
22493 by the router's &%transport_home_directory%& option, which defaults to the
22494 user's home directory if &%check_local_user%& is set.
22495
22496
22497 .section "Private options for pipe" "SECID142"
22498 .cindex "options" "&(pipe)& transport"
22499
22500
22501
22502 .option allow_commands pipe "string list&!!" unset
22503 .cindex "&(pipe)& transport" "permitted commands"
22504 The string is expanded, and is then interpreted as a colon-separated list of
22505 permitted commands. If &%restrict_to_path%& is not set, the only commands
22506 permitted are those in the &%allow_commands%& list. They need not be absolute
22507 paths; the &%path%& option is still used for relative paths. If
22508 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22509 in the &%allow_commands%& list, or a name without any slashes that is found on
22510 the path. In other words, if neither &%allow_commands%& nor
22511 &%restrict_to_path%& is set, there is no restriction on the command, but
22512 otherwise only commands that are permitted by one or the other are allowed. For
22513 example, if
22514 .code
22515 allow_commands = /usr/bin/vacation
22516 .endd
22517 and &%restrict_to_path%& is not set, the only permitted command is
22518 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22519 &%use_shell%& is set.
22520
22521
22522 .option batch_id pipe string&!! unset
22523 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22524
22525
22526 .option batch_max pipe integer 1
22527 This limits the number of addresses that can be handled in a single delivery.
22528 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22529
22530
22531 .option check_string pipe string unset
22532 As &(pipe)& writes the message, the start of each line is tested for matching
22533 &%check_string%&, and if it does, the initial matching characters are replaced
22534 by the contents of &%escape_string%&, provided both are set. The value of
22535 &%check_string%& is a literal string, not a regular expression, and the case of
22536 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22537 of &%check_string%& and &%escape_string%& are forced to values that implement
22538 the SMTP escaping protocol. Any settings made in the configuration file are
22539 ignored.
22540
22541
22542 .option command pipe string&!! unset
22543 This option need not be set when &(pipe)& is being used to deliver to pipes
22544 obtained directly from address redirections. In other cases, the option must be
22545 set, to provide a command to be run. It need not yield an absolute path (see
22546 the &%path%& option below). The command is split up into separate arguments by
22547 Exim, and each argument is separately expanded, as described in section
22548 &<<SECThowcommandrun>>& above.
22549
22550
22551 .option environment pipe string&!! unset
22552 .cindex "&(pipe)& transport" "environment for command"
22553 .cindex "environment for &(pipe)& transport"
22554 This option is used to add additional variables to the environment in which the
22555 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22556 a string which is expanded, and then interpreted as a colon-separated list of
22557 environment settings of the form <&'name'&>=<&'value'&>.
22558
22559
22560 .option escape_string pipe string unset
22561 See &%check_string%& above.
22562
22563
22564 .option freeze_exec_fail pipe boolean false
22565 .cindex "exec failure"
22566 .cindex "failure of exec"
22567 .cindex "&(pipe)& transport" "failure of exec"
22568 Failure to exec the command in a pipe transport is by default treated like
22569 any other failure while running the command. However, if &%freeze_exec_fail%&
22570 is set, failure to exec is treated specially, and causes the message to be
22571 frozen, whatever the setting of &%ignore_status%&.
22572
22573
22574 .option freeze_signal pipe boolean false
22575 .cindex "signal exit"
22576 .cindex "&(pipe)& transport", "signal exit"
22577 Normally if the process run by a command in a pipe transport exits on a signal,
22578 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22579 frozen in Exim's queue instead.
22580
22581
22582 .option force_command pipe boolean false
22583 .cindex "force command"
22584 .cindex "&(pipe)& transport", "force command"
22585 Normally when a router redirects an address directly to a pipe command
22586 the &%command%& option on the transport is ignored.  If &%force_command%&
22587 is set, the &%command%& option will used. This is especially
22588 useful for forcing a wrapper or additional argument to be added to the
22589 command. For example:
22590 .code
22591 command = /usr/bin/remote_exec myhost -- $address_pipe
22592 force_command
22593 .endd
22594
22595 Note that &$address_pipe$& is handled specially in &%command%& when
22596 &%force_command%& is set, expanding out to the original argument vector as
22597 separate items, similarly to a Unix shell &`"$@"`& construct.
22598
22599 .option ignore_status pipe boolean false
22600 If this option is true, the status returned by the subprocess that is set up to
22601 run the command is ignored, and Exim behaves as if zero had been returned.
22602 Otherwise, a non-zero status or termination by signal causes an error return
22603 from the transport unless the status value is one of those listed in
22604 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22605
22606 &*Note*&: This option does not apply to timeouts, which do not return a status.
22607 See the &%timeout_defer%& option for how timeouts are handled.
22608
22609 .option log_defer_output pipe boolean false
22610 .cindex "&(pipe)& transport" "logging output"
22611 If this option is set, and the status returned by the command is
22612 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22613 and any output was produced, the first line of it is written to the main log.
22614
22615
22616 .option log_fail_output pipe boolean false
22617 If this option is set, and the command returns any output, and also ends with a
22618 return code that is neither zero nor one of the return codes listed in
22619 &%temp_errors%& (that is, the delivery failed), the first line of output is
22620 written to the main log. This option and &%log_output%& are mutually exclusive.
22621 Only one of them may be set.
22622
22623
22624
22625 .option log_output pipe boolean false
22626 If this option is set and the command returns any output, the first line of
22627 output is written to the main log, whatever the return code. This option and
22628 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22629
22630
22631
22632 .option max_output pipe integer 20K
22633 This specifies the maximum amount of output that the command may produce on its
22634 standard output and standard error file combined. If the limit is exceeded, the
22635 process running the command is killed. This is intended as a safety measure to
22636 catch runaway processes. The limit is applied independently of the settings of
22637 the options that control what is done with such output (for example,
22638 &%return_output%&). Because of buffering effects, the amount of output may
22639 exceed the limit by a small amount before Exim notices.
22640
22641
22642 .option message_prefix pipe string&!! "see below"
22643 The string specified here is expanded and output at the start of every message.
22644 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22645 .code
22646 message_prefix = \
22647   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22648   ${tod_bsdinbox}\n
22649 .endd
22650 .cindex "Cyrus"
22651 .cindex "&%tmail%&"
22652 .cindex "&""From""& line"
22653 This is required by the commonly used &_/usr/bin/vacation_& program.
22654 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22655 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22656 setting
22657 .code
22658 message_prefix =
22659 .endd
22660 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22661 &`\n`& to &`\r\n`& in &%message_prefix%&.
22662
22663
22664 .option message_suffix pipe string&!! "see below"
22665 The string specified here is expanded and output at the end of every message.
22666 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22667 The suffix can be suppressed by setting
22668 .code
22669 message_suffix =
22670 .endd
22671 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22672 &`\n`& to &`\r\n`& in &%message_suffix%&.
22673
22674
22675 .option path pipe string "see below"
22676 This option specifies the string that is set up in the PATH environment
22677 variable of the subprocess. The default is:
22678 .code
22679 /bin:/usr/bin
22680 .endd
22681 If the &%command%& option does not yield an absolute path name, the command is
22682 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22683 apply to a command specified as a transport filter.
22684
22685
22686 .option permit_coredump pipe boolean false
22687 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22688 a core-dump of a pipe command, enable this command.  This enables core-dumps
22689 during delivery and affects both the Exim binary and the pipe command run.
22690 It is recommended that this option remain off unless and until you have a need
22691 for it and that this only be enabled when needed, as the risk of excessive
22692 resource consumption can be quite high.  Note also that Exim is typically
22693 installed as a setuid binary and most operating systems will inhibit coredumps
22694 of these by default, so further OS-specific action may be required.
22695
22696
22697 .option pipe_as_creator pipe boolean false
22698 .cindex "uid (user id)" "local delivery"
22699 If the generic &%user%& option is not set and this option is true, the delivery
22700 process is run under the uid that was in force when Exim was originally called
22701 to accept the message. If the group id is not otherwise set (via the generic
22702 &%group%& option), the gid that was in force when Exim was originally called to
22703 accept the message is used.
22704
22705
22706 .option restrict_to_path pipe boolean false
22707 When this option is set, any command name not listed in &%allow_commands%& must
22708 contain no slashes. The command is searched for only in the directories listed
22709 in the &%path%& option. This option is intended for use in the case when a pipe
22710 command has been generated from a user's &_.forward_& file. This is usually
22711 handled by a &(pipe)& transport called &%address_pipe%&.
22712
22713
22714 .option return_fail_output pipe boolean false
22715 If this option is true, and the command produced any output and ended with a
22716 return code other than zero or one of the codes listed in &%temp_errors%& (that
22717 is, the delivery failed), the output is returned in the bounce message.
22718 However, if the message has a null sender (that is, it is itself a bounce
22719 message), output from the command is discarded. This option and
22720 &%return_output%& are mutually exclusive. Only one of them may be set.
22721
22722
22723
22724 .option return_output pipe boolean false
22725 If this option is true, and the command produced any output, the delivery is
22726 deemed to have failed whatever the return code from the command, and the output
22727 is returned in the bounce message. Otherwise, the output is just discarded.
22728 However, if the message has a null sender (that is, it is a bounce message),
22729 output from the command is always discarded, whatever the setting of this
22730 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22731 of them may be set.
22732
22733
22734
22735 .option temp_errors pipe "string list" "see below"
22736 .cindex "&(pipe)& transport" "temporary failure"
22737 This option contains either a colon-separated list of numbers, or a single
22738 asterisk. If &%ignore_status%& is false
22739 and &%return_output%& is not set,
22740 and the command exits with a non-zero return code, the failure is treated as
22741 temporary and the delivery is deferred if the return code matches one of the
22742 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22743 codes are treated as permanent errors. The default setting contains the codes
22744 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22745 compiled on a system that does not define these macros, it assumes values of 75
22746 and 73, respectively.
22747
22748
22749 .option timeout pipe time 1h
22750 If the command fails to complete within this time, it is killed. This normally
22751 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22752 specifies no timeout. In order to ensure that any subprocesses created by the
22753 command are also killed, Exim makes the initial process a process group leader,
22754 and kills the whole process group on a timeout. However, this can be defeated
22755 if one of the processes starts a new process group.
22756
22757 .option timeout_defer pipe boolean false
22758 A timeout in a &(pipe)& transport, either in the command that the transport
22759 runs, or in a transport filter that is associated with it, is by default
22760 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22761 is set true, both kinds of timeout become temporary errors, causing the
22762 delivery to be deferred.
22763
22764 .option umask pipe "octal integer" 022
22765 This specifies the umask setting for the subprocess that runs the command.
22766
22767
22768 .option use_bsmtp pipe boolean false
22769 .cindex "envelope sender"
22770 If this option is set true, the &(pipe)& transport writes messages in &"batch
22771 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22772 commands. If you want to include a leading HELO command with such messages,
22773 you can do so by setting the &%message_prefix%& option. See section
22774 &<<SECTbatchSMTP>>& for details of batch SMTP.
22775
22776 .option use_classresources pipe boolean false
22777 .cindex "class resources (BSD)"
22778 This option is available only when Exim is running on FreeBSD, NetBSD, or
22779 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22780 resource limits when a &(pipe)& transport is run to perform a delivery. The
22781 limits for the uid under which the pipe is to run are obtained from the login
22782 class database.
22783
22784
22785 .option use_crlf pipe boolean false
22786 .cindex "carriage return"
22787 .cindex "linefeed"
22788 This option causes lines to be terminated with the two-character CRLF sequence
22789 (carriage return, linefeed) instead of just a linefeed character. In the case
22790 of batched SMTP, the byte sequence written to the pipe is then an exact image
22791 of what would be sent down a real SMTP connection.
22792
22793 The contents of the &%message_prefix%& and &%message_suffix%& options are
22794 written verbatim, so must contain their own carriage return characters if these
22795 are needed. When &%use_bsmtp%& is not set, the default values for both
22796 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22797 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22798
22799
22800 .option use_shell pipe boolean false
22801 .vindex "&$pipe_addresses$&"
22802 If this option is set, it causes the command to be passed to &_/bin/sh_&
22803 instead of being run directly from the transport, as described in section
22804 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22805 where the command is expected to be run under a shell and cannot easily be
22806 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22807 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22808 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22809 its &%-c%& option.
22810
22811
22812
22813 .section "Using an external local delivery agent" "SECID143"
22814 .cindex "local delivery" "using an external agent"
22815 .cindex "&'procmail'&"
22816 .cindex "external local delivery"
22817 .cindex "delivery" "&'procmail'&"
22818 .cindex "delivery" "by external agent"
22819 The &(pipe)& transport can be used to pass all messages that require local
22820 delivery to a separate local delivery agent such as &%procmail%&. When doing
22821 this, care must be taken to ensure that the pipe is run under an appropriate
22822 uid and gid. In some configurations one wants this to be a uid that is trusted
22823 by the delivery agent to supply the correct sender of the message. It may be
22824 necessary to recompile or reconfigure the delivery agent so that it trusts an
22825 appropriate user. The following is an example transport and router
22826 configuration for &%procmail%&:
22827 .code
22828 # transport
22829 procmail_pipe:
22830   driver = pipe
22831   command = /usr/local/bin/procmail -d $local_part
22832   return_path_add
22833   delivery_date_add
22834   envelope_to_add
22835   check_string = "From "
22836   escape_string = ">From "
22837   umask = 077
22838   user = $local_part
22839   group = mail
22840
22841 # router
22842 procmail:
22843   driver = accept
22844   check_local_user
22845   transport = procmail_pipe
22846 .endd
22847 In this example, the pipe is run as the local user, but with the group set to
22848 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22849 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22850 user to supply a correct sender address. If you do not specify either a
22851 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22852 home directory is the user's home directory by default.
22853
22854 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22855 .code
22856 IFS=" "
22857 .endd
22858 as shown in some &%procmail%& documentation, because Exim does not by default
22859 use a shell to run pipe commands.
22860
22861 .cindex "Cyrus"
22862 The next example shows a transport and a router for a system where local
22863 deliveries are handled by the Cyrus IMAP server.
22864 .code
22865 # transport
22866 local_delivery_cyrus:
22867   driver = pipe
22868   command = /usr/cyrus/bin/deliver \
22869             -m ${substr_1:$local_part_suffix} -- $local_part
22870   user = cyrus
22871   group = mail
22872   return_output
22873   log_output
22874   message_prefix =
22875   message_suffix =
22876
22877 # router
22878 local_user_cyrus:
22879   driver = accept
22880   check_local_user
22881   local_part_suffix = .*
22882   transport = local_delivery_cyrus
22883 .endd
22884 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22885 &%return_output%& to cause any text written by Cyrus to be returned to the
22886 sender.
22887 .ecindex IIDpiptra1
22888 .ecindex IIDpiptra2
22889
22890
22891 . ////////////////////////////////////////////////////////////////////////////
22892 . ////////////////////////////////////////////////////////////////////////////
22893
22894 .chapter "The smtp transport" "CHAPsmtptrans"
22895 .scindex IIDsmttra1 "transports" "&(smtp)&"
22896 .scindex IIDsmttra2 "&(smtp)& transport"
22897 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22898 or LMTP protocol. The list of hosts to try can either be taken from the address
22899 that is being processed (having been set up by the router), or specified
22900 explicitly for the transport. Timeout and retry processing (see chapter
22901 &<<CHAPretry>>&) is applied to each IP address independently.
22902
22903
22904 .section "Multiple messages on a single connection" "SECID144"
22905 The sending of multiple messages over a single TCP/IP connection can arise in
22906 two ways:
22907
22908 .ilist
22909 If a message contains more than &%max_rcpt%& (see below) addresses that are
22910 routed to the same host, more than one copy of the message has to be sent to
22911 that host. In this situation, multiple copies may be sent in a single run of
22912 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22913 does when it has too many addresses to send in one message also depends on the
22914 value of the global &%remote_max_parallel%& option. Details are given in
22915 section &<<SECToutSMTPTCP>>&.)
22916 .next
22917 .cindex "hints database" "remembering routing"
22918 When a message has been successfully delivered over a TCP/IP connection, Exim
22919 looks in its hints database to see if there are any other messages awaiting a
22920 connection to the same host. If there are, a new delivery process is started
22921 for one of them, and the current TCP/IP connection is passed on to it. The new
22922 process may in turn send multiple copies and possibly create yet another
22923 process.
22924 .endlist
22925
22926
22927 For each copy sent over the same TCP/IP connection, a sequence counter is
22928 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22929 no further messages are sent over that connection.
22930
22931
22932
22933 .section "Use of the $host and $host_address variables" "SECID145"
22934 .vindex "&$host$&"
22935 .vindex "&$host_address$&"
22936 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22937 &$host_address$& are the name and IP address of the first host on the host list
22938 passed by the router. However, when the transport is about to connect to a
22939 specific host, and while it is connected to that host, &$host$& and
22940 &$host_address$& are set to the values for that host. These are the values
22941 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22942 &%serialize_hosts%&, and the various TLS options are expanded.
22943
22944
22945 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22946 .vindex &$tls_bits$&
22947 .vindex &$tls_cipher$&
22948 .vindex &$tls_peerdn$&
22949 .vindex &$tls_sni$&
22950 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22951 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22952 are the values that were set when the message was received.
22953 These are the values that are used for options that are expanded before any
22954 SMTP connections are made. Just before each connection is made, these four
22955 variables are emptied. If TLS is subsequently started, they are set to the
22956 appropriate values for the outgoing connection, and these are the values that
22957 are in force when any authenticators are run and when the
22958 &%authenticated_sender%& option is expanded.
22959
22960 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22961 and will be removed in a future release.
22962
22963
22964 .section "Private options for smtp" "SECID146"
22965 .cindex "options" "&(smtp)& transport"
22966 The private options of the &(smtp)& transport are as follows:
22967
22968
22969 .option address_retry_include_sender smtp boolean true
22970 .cindex "4&'xx'& responses" "retrying after"
22971 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22972 is the combination of sender and recipient that is delayed in subsequent queue
22973 runs until the retry time is reached. You can delay the recipient without
22974 reference to the sender (which is what earlier versions of Exim did), by
22975 setting &%address_retry_include_sender%& false. However, this can lead to
22976 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22977
22978 .option allow_localhost smtp boolean false
22979 .cindex "local host" "sending to"
22980 .cindex "fallback" "hosts specified on transport"
22981 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22982 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22983 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22984 the delivery anyway. This should be used only in special cases when the
22985 configuration ensures that no looping will result (for example, a differently
22986 configured Exim is listening on the port to which the message is sent).
22987
22988
22989 .option authenticated_sender smtp string&!! unset
22990 .cindex "Cyrus"
22991 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22992 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22993 overriding any existing authenticated sender value. If the string expansion is
22994 forced to fail, the option is ignored. Other expansion failures cause delivery
22995 to be deferred. If the result of expansion is an empty string, that is also
22996 ignored.
22997
22998 The expansion happens after the outgoing connection has been made and TLS
22999 started, if required. This means that the &$host$&, &$host_address$&,
23000 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23001 particular connection.
23002
23003 If the SMTP session is not authenticated, the expansion of
23004 &%authenticated_sender%& still happens (and can cause the delivery to be
23005 deferred if it fails), but no AUTH= item is added to MAIL commands
23006 unless &%authenticated_sender_force%& is true.
23007
23008 This option allows you to use the &(smtp)& transport in LMTP mode to
23009 deliver mail to Cyrus IMAP and provide the proper local part as the
23010 &"authenticated sender"&, via a setting such as:
23011 .code
23012 authenticated_sender = $local_part
23013 .endd
23014 This removes the need for IMAP subfolders to be assigned special ACLs to
23015 allow direct delivery to those subfolders.
23016
23017 Because of expected uses such as that just described for Cyrus (when no
23018 domain is involved), there is no checking on the syntax of the provided
23019 value.
23020
23021
23022 .option authenticated_sender_force smtp boolean false
23023 If this option is set true, the &%authenticated_sender%& option's value
23024 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23025 authenticated as a client.
23026
23027
23028 .option command_timeout smtp time 5m
23029 This sets a timeout for receiving a response to an SMTP command that has been
23030 sent out. It is also used when waiting for the initial banner line from the
23031 remote host. Its value must not be zero.
23032
23033
23034 .option connect_timeout smtp time 5m
23035 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23036 to a remote host. A setting of zero allows the system timeout (typically
23037 several minutes) to act. To have any effect, the value of this option must be
23038 less than the system timeout. However, it has been observed that on some
23039 systems there is no system timeout, which is why the default value for this
23040 option is 5 minutes, a value recommended by RFC 1123.
23041
23042
23043 .option connection_max_messages smtp integer 500
23044 .cindex "SMTP" "passed connection"
23045 .cindex "SMTP" "multiple deliveries"
23046 .cindex "multiple SMTP deliveries"
23047 This controls the maximum number of separate message deliveries that are sent
23048 over a single TCP/IP connection. If the value is zero, there is no limit.
23049 For testing purposes, this value can be overridden by the &%-oB%& command line
23050 option.
23051
23052
23053 .option data_timeout smtp time 5m
23054 This sets a timeout for the transmission of each block in the data portion of
23055 the message. As a result, the overall timeout for a message depends on the size
23056 of the message. Its value must not be zero. See also &%final_timeout%&.
23057
23058
23059 .option delay_after_cutoff smtp boolean true
23060 This option controls what happens when all remote IP addresses for a given
23061 domain have been inaccessible for so long that they have passed their retry
23062 cutoff times.
23063
23064 In the default state, if the next retry time has not been reached for any of
23065 them, the address is bounced without trying any deliveries. In other words,
23066 Exim delays retrying an IP address after the final cutoff time until a new
23067 retry time is reached, and can therefore bounce an address without ever trying
23068 a delivery, when machines have been down for a long time. Some people are
23069 unhappy at this prospect, so...
23070
23071 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23072 addresses are past their final cutoff time, Exim tries to deliver to those
23073 IP addresses that have not been tried since the message arrived. If there are
23074 none, of if they all fail, the address is bounced. In other words, it does not
23075 delay when a new message arrives, but immediately tries those expired IP
23076 addresses that haven't been tried since the message arrived. If there is a
23077 continuous stream of messages for the dead hosts, unsetting
23078 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23079 to them.
23080
23081
23082 .option dns_qualify_single smtp boolean true
23083 If the &%hosts%& or &%fallback_hosts%& option is being used,
23084 and the &%gethostbyname%& option is false,
23085 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23086 in chapter &<<CHAPdnslookup>>& for more details.
23087
23088
23089 .option dns_search_parents smtp boolean false
23090 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23091 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23092 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23093 details.
23094
23095
23096 .option dnssec_request_domains smtp "domain list&!!" unset
23097 .cindex "MX record" "security"
23098 .cindex "DNSSEC" "MX lookup"
23099 .cindex "security" "MX lookup"
23100 .cindex "DNS" "DNSSEC"
23101 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23102 the dnssec request bit set.
23103 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23104
23105
23106
23107 .option dnssec_require_domains smtp "domain list&!!" unset
23108 .cindex "MX record" "security"
23109 .cindex "DNSSEC" "MX lookup"
23110 .cindex "security" "MX lookup"
23111 .cindex "DNS" "DNSSEC"
23112 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23113 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23114 (AD bit) set wil be ignored and logged as a host-lookup failure.
23115 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23116
23117
23118
23119 .option dscp smtp string&!! unset
23120 .cindex "DCSP" "outbound"
23121 This option causes the DSCP value associated with a socket to be set to one
23122 of a number of fixed strings or to numeric value.
23123 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23124 Common values include &`throughput`&, &`mincost`&, and on newer systems
23125 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23126
23127 The outbound packets from Exim will be marked with this value in the header
23128 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23129 that these values will have any effect, not be stripped by networking
23130 equipment, or do much of anything without cooperation with your Network
23131 Engineer and those of all network operators between the source and destination.
23132
23133
23134 .option fallback_hosts smtp "string list" unset
23135 .cindex "fallback" "hosts specified on transport"
23136 String expansion is not applied to this option. The argument must be a
23137 colon-separated list of host names or IP addresses, optionally also including
23138 port numbers, though the separator can be changed, as described in section
23139 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23140 item in a &%route_list%& setting for the &(manualroute)& router, as described
23141 in section &<<SECTformatonehostitem>>&.
23142
23143 Fallback hosts can also be specified on routers, which associate them with the
23144 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23145 &%fallback_hosts%& specified on the transport is used only if the address does
23146 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23147 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23148 However, &%hosts_randomize%& does apply to fallback host lists.
23149
23150 If Exim is unable to deliver to any of the hosts for a particular address, and
23151 the errors are not permanent rejections, the address is put on a separate
23152 transport queue with its host list replaced by the fallback hosts, unless the
23153 address was routed via MX records and the current host was in the original MX
23154 list. In that situation, the fallback host list is not used.
23155
23156 Once normal deliveries are complete, the fallback queue is delivered by
23157 re-running the same transports with the new host lists. If several failing
23158 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23159 copy of the message is sent.
23160
23161 The resolution of the host names on the fallback list is controlled by the
23162 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23163 both to cases when the host list comes with the address and when it is taken
23164 from &%hosts%&. This option provides a &"use a smart host only if delivery
23165 fails"& facility.
23166
23167
23168 .option final_timeout smtp time 10m
23169 This is the timeout that applies while waiting for the response to the final
23170 line containing just &"."& that terminates a message. Its value must not be
23171 zero.
23172
23173 .option gethostbyname smtp boolean false
23174 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23175 being used, names are looked up using &[gethostbyname()]&
23176 (or &[getipnodebyname()]& when available)
23177 instead of using the DNS. Of course, that function may in fact use the DNS, but
23178 it may also consult other sources of information such as &_/etc/hosts_&.
23179
23180 .option gnutls_compat_mode smtp boolean unset
23181 This option controls whether GnuTLS is used in compatibility mode in an Exim
23182 server. This reduces security slightly, but improves interworking with older
23183 implementations of TLS.
23184
23185 .option helo_data smtp string&!! "see below"
23186 .cindex "HELO" "argument, setting"
23187 .cindex "EHLO" "argument, setting"
23188 .cindex "LHLO argument setting"
23189 The value of this option is expanded after a connection to a another host has
23190 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23191 command that starts the outgoing SMTP or LMTP session. The default value of the
23192 option is:
23193 .code
23194 $primary_hostname
23195 .endd
23196 During the expansion, the variables &$host$& and &$host_address$& are set to
23197 the identity of the remote host, and the variables &$sending_ip_address$& and
23198 &$sending_port$& are set to the local IP address and port number that are being
23199 used. These variables can be used to generate different values for different
23200 servers or different local IP addresses. For example, if you want the string
23201 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23202 interface address, you could use this:
23203 .code
23204 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23205   {$primary_hostname}}
23206 .endd
23207 The use of &%helo_data%& applies both to sending messages and when doing
23208 callouts.
23209
23210 .option hosts smtp "string list&!!" unset
23211 Hosts are associated with an address by a router such as &(dnslookup)&, which
23212 finds the hosts by looking up the address domain in the DNS, or by
23213 &(manualroute)&, which has lists of hosts in its configuration. However,
23214 email addresses can be passed to the &(smtp)& transport by any router, and not
23215 all of them can provide an associated list of hosts.
23216
23217 The &%hosts%& option specifies a list of hosts to be used if the address being
23218 processed does not have any hosts associated with it. The hosts specified by
23219 &%hosts%& are also used, whether or not the address has its own hosts, if
23220 &%hosts_override%& is set.
23221
23222 The string is first expanded, before being interpreted as a colon-separated
23223 list of host names or IP addresses, possibly including port numbers. The
23224 separator may be changed to something other than colon, as described in section
23225 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23226 item in a &%route_list%& setting for the &(manualroute)& router, as described
23227 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23228 of the &(manualroute)& router is not available here.
23229
23230 If the expansion fails, delivery is deferred. Unless the failure was caused by
23231 the inability to complete a lookup, the error is logged to the panic log as
23232 well as the main log. Host names are looked up either by searching directly for
23233 address records in the DNS or by calling &[gethostbyname()]& (or
23234 &[getipnodebyname()]& when available), depending on the setting of the
23235 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23236 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23237 address are used.
23238
23239 During delivery, the hosts are tried in order, subject to their retry status,
23240 unless &%hosts_randomize%& is set.
23241
23242
23243 .option hosts_avoid_esmtp smtp "host list&!!" unset
23244 .cindex "ESMTP, avoiding use of"
23245 .cindex "HELO" "forcing use of"
23246 .cindex "EHLO" "avoiding use of"
23247 .cindex "PIPELINING" "avoiding the use of"
23248 This option is for use with broken hosts that announce ESMTP facilities (for
23249 example, PIPELINING) and then fail to implement them properly. When a host
23250 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23251 start of the SMTP session. This means that it cannot use any of the ESMTP
23252 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23253
23254
23255 .option hosts_avoid_pipelining smtp "host list&!!" unset
23256 .cindex "PIPELINING" "avoiding the use of"
23257 Exim will not use the SMTP PIPELINING extension when delivering to any host
23258 that matches this list, even if the server host advertises PIPELINING support.
23259
23260
23261 .option hosts_avoid_tls smtp "host list&!!" unset
23262 .cindex "TLS" "avoiding for certain hosts"
23263 Exim will not try to start a TLS session when delivering to any host that
23264 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23265
23266 .new
23267 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23268 .cindex "TLS" "avoiding for certain hosts"
23269 Exim will not try to start a TLS session for a verify callout,
23270 or when delivering in cutthrough mode,
23271 to any host that matches this list.
23272 .wen
23273
23274
23275 .option hosts_max_try smtp integer 5
23276 .cindex "host" "maximum number to try"
23277 .cindex "limit" "number of hosts tried"
23278 .cindex "limit" "number of MX tried"
23279 .cindex "MX record" "maximum tried"
23280 This option limits the number of IP addresses that are tried for any one
23281 delivery in cases where there are temporary delivery errors. Section
23282 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23283
23284
23285 .option hosts_max_try_hardlimit smtp integer 50
23286 This is an additional check on the maximum number of IP addresses that Exim
23287 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23288 why it exists.
23289
23290
23291
23292 .option hosts_nopass_tls smtp "host list&!!" unset
23293 .cindex "TLS" "passing connection"
23294 .cindex "multiple SMTP deliveries"
23295 .cindex "TLS" "multiple message deliveries"
23296 For any host that matches this list, a connection on which a TLS session has
23297 been started will not be passed to a new delivery process for sending another
23298 message on the same connection. See section &<<SECTmulmessam>>& for an
23299 explanation of when this might be needed.
23300
23301
23302 .option hosts_override smtp boolean false
23303 If this option is set and the &%hosts%& option is also set, any hosts that are
23304 attached to the address are ignored, and instead the hosts specified by the
23305 &%hosts%& option are always used. This option does not apply to
23306 &%fallback_hosts%&.
23307
23308
23309 .option hosts_randomize smtp boolean false
23310 .cindex "randomized host list"
23311 .cindex "host" "list of; randomized"
23312 .cindex "fallback" "randomized hosts"
23313 If this option is set, and either the list of hosts is taken from the
23314 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23315 were not obtained from MX records (this includes fallback hosts from the
23316 router), and were not randomized by the router, the order of trying the hosts
23317 is randomized each time the transport runs. Randomizing the order of a host
23318 list can be used to do crude load sharing.
23319
23320 When &%hosts_randomize%& is true, a host list may be split into groups whose
23321 order is separately randomized. This makes it possible to set up MX-like
23322 behaviour. The boundaries between groups are indicated by an item that is just
23323 &`+`& in the host list. For example:
23324 .code
23325 hosts = host1:host2:host3:+:host4:host5
23326 .endd
23327 The order of the first three hosts and the order of the last two hosts is
23328 randomized for each use, but the first three always end up before the last two.
23329 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23330
23331 .option hosts_require_auth smtp "host list&!!" unset
23332 .cindex "authentication" "required by client"
23333 This option provides a list of servers for which authentication must succeed
23334 before Exim will try to transfer a message. If authentication fails for
23335 servers which are not in this list, Exim tries to send unauthenticated. If
23336 authentication fails for one of these servers, delivery is deferred. This
23337 temporary error is detectable in the retry rules, so it can be turned into a
23338 hard failure if required. See also &%hosts_try_auth%&, and chapter
23339 &<<CHAPSMTPAUTH>>& for details of authentication.
23340
23341
23342 .option hosts_request_ocsp smtp "host list&!!" *
23343 .cindex "TLS" "requiring for certain servers"
23344 Exim will request a Certificate Status on a
23345 TLS session for any host that matches this list.
23346 &%tls_verify_certificates%& should also be set for the transport.
23347
23348 .option hosts_require_ocsp smtp "host list&!!" unset
23349 .cindex "TLS" "requiring for certain servers"
23350 Exim will request, and check for a valid Certificate Status being given, on a
23351 TLS session for any host that matches this list.
23352 &%tls_verify_certificates%& should also be set for the transport.
23353
23354 .option hosts_require_tls smtp "host list&!!" unset
23355 .cindex "TLS" "requiring for certain servers"
23356 Exim will insist on using a TLS session when delivering to any host that
23357 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23358 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23359 incoming messages, use an appropriate ACL.
23360
23361 .option hosts_try_auth smtp "host list&!!" unset
23362 .cindex "authentication" "optional in client"
23363 This option provides a list of servers to which, provided they announce
23364 authentication support, Exim will attempt to authenticate as a client when it
23365 connects. If authentication fails, Exim will try to transfer the message
23366 unauthenticated. See also &%hosts_require_auth%&, and chapter
23367 &<<CHAPSMTPAUTH>>& for details of authentication.
23368
23369 .new
23370 .option hosts_try_prdr smtp "host list&!!" *
23371 .cindex "PRDR" "enabling, optional in client"
23372 This option provides a list of servers to which, provided they announce
23373 PRDR support, Exim will attempt to negotiate PRDR
23374 for multi-recipient messages.
23375 The option can usually be left as default.
23376 .wen
23377
23378 .option interface smtp "string list&!!" unset
23379 .cindex "bind IP address"
23380 .cindex "IP address" "binding"
23381 .vindex "&$host$&"
23382 .vindex "&$host_address$&"
23383 This option specifies which interface to bind to when making an outgoing SMTP
23384 call. The value is an IP address, not an interface name such as
23385 &`eth0`&. Do not confuse this with the interface address that was used when a
23386 message was received, which is in &$received_ip_address$&, formerly known as
23387 &$interface_address$&. The name was changed to minimize confusion with the
23388 outgoing interface address. There is no variable that contains an outgoing
23389 interface address because, unless it is set by this option, its value is
23390 unknown.
23391
23392 During the expansion of the &%interface%& option the variables &$host$& and
23393 &$host_address$& refer to the host to which a connection is about to be made
23394 during the expansion of the string. Forced expansion failure, or an empty
23395 string result causes the option to be ignored. Otherwise, after expansion, the
23396 string must be a list of IP addresses, colon-separated by default, but the
23397 separator can be changed in the usual way. For example:
23398 .code
23399 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23400 .endd
23401 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23402 connection. If none of them are the correct type, the option is ignored. If
23403 &%interface%& is not set, or is ignored, the system's IP functions choose which
23404 interface to use if the host has more than one.
23405
23406
23407 .option keepalive smtp boolean true
23408 .cindex "keepalive" "on outgoing connection"
23409 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23410 connections. When set, it causes the kernel to probe idle connections
23411 periodically, by sending packets with &"old"& sequence numbers. The other end
23412 of the connection should send a acknowledgment if the connection is still okay
23413 or a reset if the connection has been aborted. The reason for doing this is
23414 that it has the beneficial effect of freeing up certain types of connection
23415 that can get stuck when the remote host is disconnected without tidying up the
23416 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23417 unreachable hosts.
23418
23419
23420 .option lmtp_ignore_quota smtp boolean false
23421 .cindex "LMTP" "ignoring quota errors"
23422 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23423 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23424 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23425
23426 .option max_rcpt smtp integer 100
23427 .cindex "RCPT" "maximum number of outgoing"
23428 This option limits the number of RCPT commands that are sent in a single
23429 SMTP message transaction. Each set of addresses is treated independently, and
23430 so can cause parallel connections to the same host if &%remote_max_parallel%&
23431 permits this.
23432
23433
23434 .option multi_domain smtp boolean&!! true
23435 .vindex "&$domain$&"
23436 When this option is set, the &(smtp)& transport can handle a number of
23437 addresses containing a mixture of different domains provided they all resolve
23438 to the same list of hosts. Turning the option off restricts the transport to
23439 handling only one domain at a time. This is useful if you want to use
23440 &$domain$& in an expansion for the transport, because it is set only when there
23441 is a single domain involved in a remote delivery.
23442
23443 .new
23444 It is expanded per-address and can depend on any of
23445 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23446 &$host$&, &$host_address$& and &$host_port$&.
23447 .wen
23448
23449 .option port smtp string&!! "see below"
23450 .cindex "port" "sending TCP/IP"
23451 .cindex "TCP/IP" "setting outgoing port"
23452 This option specifies the TCP/IP port on the server to which Exim connects.
23453 &*Note:*& Do not confuse this with the port that was used when a message was
23454 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23455 The name was changed to minimize confusion with the outgoing port. There is no
23456 variable that contains an outgoing port.
23457
23458 If the value of this option begins with a digit it is taken as a port number;
23459 otherwise it is looked up using &[getservbyname()]&. The default value is
23460 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23461 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23462 is deferred.
23463
23464
23465
23466 .option protocol smtp string smtp
23467 .cindex "LMTP" "over TCP/IP"
23468 .cindex "ssmtp protocol" "outbound"
23469 .cindex "TLS" "SSL-on-connect outbound"
23470 .vindex "&$port$&"
23471 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23472 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23473 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23474 deliveries into closed message stores. Exim also has support for running LMTP
23475 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23476
23477 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23478 changes to &"smtps"&, and the transport initiates TLS immediately after
23479 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23480 The Internet standards bodies strongly discourage use of this mode.
23481
23482
23483 .option retry_include_ip_address smtp boolean&!! true
23484 Exim normally includes both the host name and the IP address in the key it
23485 constructs for indexing retry data after a temporary delivery failure. This
23486 means that when one of several IP addresses for a host is failing, it gets
23487 tried periodically (controlled by the retry rules), but use of the other IP
23488 addresses is not affected.
23489
23490 However, in some dialup environments hosts are assigned a different IP address
23491 each time they connect. In this situation the use of the IP address as part of
23492 the retry key leads to undesirable behaviour. Setting this option false causes
23493 Exim to use only the host name.
23494 .new
23495 Since it is expanded it can be made to depend on the host or domain.
23496 .wen
23497
23498
23499 .option serialize_hosts smtp "host list&!!" unset
23500 .cindex "serializing connections"
23501 .cindex "host" "serializing connections"
23502 Because Exim operates in a distributed manner, if several messages for the same
23503 host arrive at around the same time, more than one simultaneous connection to
23504 the remote host can occur. This is not usually a problem except when there is a
23505 slow link between the hosts. In that situation it may be helpful to restrict
23506 Exim to one connection at a time. This can be done by setting
23507 &%serialize_hosts%& to match the relevant hosts.
23508
23509 .cindex "hints database" "serializing deliveries to a host"
23510 Exim implements serialization by means of a hints database in which a record is
23511 written whenever a process connects to one of the restricted hosts. The record
23512 is deleted when the connection is completed. Obviously there is scope for
23513 records to get left lying around if there is a system or program crash. To
23514 guard against this, Exim ignores any records that are more than six hours old.
23515
23516 If you set up this kind of serialization, you should also arrange to delete the
23517 relevant hints database whenever your system reboots. The names of the files
23518 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23519 may be one or two files, depending on the type of DBM in use. The same files
23520 are used for ETRN serialization.
23521
23522
23523 .option size_addition smtp integer 1024
23524 .cindex "SMTP" "SIZE"
23525 .cindex "message" "size issue for transport filter"
23526 .cindex "size" "of message"
23527 .cindex "transport" "filter"
23528 .cindex "filter" "transport filter"
23529 If a remote SMTP server indicates that it supports the SIZE option of the
23530 MAIL command, Exim uses this to pass over the message size at the start of
23531 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23532 sends, to allow for headers and other text that may be added during delivery by
23533 configuration options or in a transport filter. It may be necessary to increase
23534 this if a lot of text is added to messages.
23535
23536 Alternatively, if the value of &%size_addition%& is set negative, it disables
23537 the use of the SIZE option altogether.
23538
23539
23540 .option tls_certificate smtp string&!! unset
23541 .cindex "TLS" "client certificate, location of"
23542 .cindex "certificate" "client, location of"
23543 .vindex "&$host$&"
23544 .vindex "&$host_address$&"
23545 The value of this option must be the absolute path to a file which contains the
23546 client's certificate, for possible use when sending a message over an encrypted
23547 connection. The values of &$host$& and &$host_address$& are set to the name and
23548 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23549 details of TLS.
23550
23551 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23552 certificate when sending messages as a client. The global option of the same
23553 name specifies the certificate for Exim as a server; it is not automatically
23554 assumed that the same certificate should be used when Exim is operating as a
23555 client.
23556
23557
23558 .option tls_crl smtp string&!! unset
23559 .cindex "TLS" "client certificate revocation list"
23560 .cindex "certificate" "revocation list for client"
23561 This option specifies a certificate revocation list. The expanded value must
23562 be the name of a file that contains a CRL in PEM format.
23563
23564
23565 .option tls_dh_min_bits smtp integer 1024
23566 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23567 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23568 key agreement is negotiated, the server will provide a large prime number
23569 for use.  This option establishes the minimum acceptable size of that number.
23570 If the parameter offered by the server is too small, then the TLS handshake
23571 will fail.
23572
23573 Only supported when using GnuTLS.
23574
23575
23576 .option tls_privatekey smtp string&!! unset
23577 .cindex "TLS" "client private key, location of"
23578 .vindex "&$host$&"
23579 .vindex "&$host_address$&"
23580 The value of this option must be the absolute path to a file which contains the
23581 client's private key. This is used when sending a message over an encrypted
23582 connection using a client certificate. The values of &$host$& and
23583 &$host_address$& are set to the name and address of the server during the
23584 expansion. If this option is unset, or the expansion is forced to fail, or the
23585 result is an empty string, the private key is assumed to be in the same file as
23586 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23587
23588
23589 .option tls_require_ciphers smtp string&!! unset
23590 .cindex "TLS" "requiring specific ciphers"
23591 .cindex "cipher" "requiring specific"
23592 .vindex "&$host$&"
23593 .vindex "&$host_address$&"
23594 The value of this option must be a list of permitted cipher suites, for use
23595 when setting up an outgoing encrypted connection. (There is a global option of
23596 the same name for controlling incoming connections.) The values of &$host$& and
23597 &$host_address$& are set to the name and address of the server during the
23598 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23599 is used in different ways by OpenSSL and GnuTLS (see sections
23600 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23601 ciphers is a preference order.
23602
23603
23604
23605 .option tls_sni smtp string&!! unset
23606 .cindex "TLS" "Server Name Indication"
23607 .vindex "&$tls_sni$&"
23608 If this option is set then it sets the $tls_out_sni variable and causes any
23609 TLS session to pass this value as the Server Name Indication extension to
23610 the remote side, which can be used by the remote side to select an appropriate
23611 certificate and private key for the session.
23612
23613 See &<<SECTtlssni>>& for more information.
23614
23615 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23616 TLS extensions.
23617
23618
23619
23620
23621 .option tls_tempfail_tryclear smtp boolean true
23622 .cindex "4&'xx'& responses" "to STARTTLS"
23623 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23624 setting up a TLS session, this option determines whether or not Exim should try
23625 to deliver the message unencrypted. If it is set false, delivery to the
23626 current host is deferred; if there are other hosts, they are tried. If this
23627 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23628 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23629 TLS negotiation fails, Exim closes the current connection (because it is in an
23630 unknown state), opens a new one to the same host, and then tries the delivery
23631 in clear.
23632
23633
23634 .new
23635 .option tls_try_verify_hosts smtp "host list&!!" *
23636 .wen
23637 .cindex "TLS" "server certificate verification"
23638 .cindex "certificate" "verification of server"
23639 This option gives a list of hosts for which, on encrypted connections,
23640 certificate verification will be tried but need not succeed.
23641 The &%tls_verify_certificates%& option must also be set.
23642 Note that unless the host is in this list
23643 TLS connections will be denied to hosts using self-signed certificates
23644 when &%tls_verify_certificates%& is matched.
23645 The &$tls_out_certificate_verified$& variable is set when
23646 certificate verification succeeds.
23647
23648
23649 .new
23650 .option tls_verify_cert_hostnames smtp "host list&!!" *
23651 .cindex "TLS" "server certificate hostname verification"
23652 .cindex "certificate" "verification of server"
23653 This option give a list of hosts for which,
23654 while verifying the server certificate,
23655 checks will be included on the host name
23656 (note that this will generally be the result of a DNS MX lookup)
23657 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23658 limited to being the initial component of a 3-or-more component FQDN.
23659
23660 There is no equivalent checking on client certificates.
23661 .wen
23662
23663
23664 .new
23665 .option tls_verify_certificates smtp string&!! system
23666 .cindex "TLS" "server certificate verification"
23667 .cindex "certificate" "verification of server"
23668 .vindex "&$host$&"
23669 .vindex "&$host_address$&"
23670 The value of this option must be either the
23671 word "system"
23672 or the absolute path to
23673 a file or directory containing permitted certificates for servers,
23674 for use when setting up an encrypted connection.
23675
23676 The "system" value for the option will use a location compiled into the SSL library.
23677 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23678 is taken as empty and an explicit location
23679 must be specified.
23680
23681 The use of a directory for the option value is not avilable for GnuTLS versions
23682 preceding 3.3.6 and a single file must be used.
23683 .wen
23684
23685 With OpenSSL the certificates specified
23686 explicitly
23687 either by file or directory
23688 are added to those given by the system default location.
23689
23690 The values of &$host$& and
23691 &$host_address$& are set to the name and address of the server during the
23692 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23693
23694 For back-compatability,
23695 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23696 (a single-colon empty list counts as being set)
23697 and certificate verification fails the TLS connection is closed.
23698
23699
23700 .option tls_verify_hosts smtp "host list&!!" unset
23701 .cindex "TLS" "server certificate verification"
23702 .cindex "certificate" "verification of server"
23703 This option gives a list of hosts for which. on encrypted connections,
23704 certificate verification must succeed.
23705 The &%tls_verify_certificates%& option must also be set.
23706 If both this option and &%tls_try_verify_hosts%& are unset
23707 operation is as if this option selected all hosts.
23708
23709
23710
23711
23712 .section "How the limits for the number of hosts to try are used" &&&
23713          "SECTvalhosmax"
23714 .cindex "host" "maximum number to try"
23715 .cindex "limit" "hosts; maximum number tried"
23716 There are two options that are concerned with the number of hosts that are
23717 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23718 &%hosts_max_try_hardlimit%&.
23719
23720
23721 The &%hosts_max_try%& option limits the number of hosts that are tried
23722 for a single delivery. However, despite the term &"host"& in its name, the
23723 option actually applies to each IP address independently. In other words, a
23724 multihomed host is treated as several independent hosts, just as it is for
23725 retrying.
23726
23727 Many of the larger ISPs have multiple MX records which often point to
23728 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23729 created as a result of routing one of these domains.
23730
23731 Trying every single IP address on such a long list does not seem sensible; if
23732 several at the top of the list fail, it is reasonable to assume there is some
23733 problem that is likely to affect all of them. Roughly speaking, the value of
23734 &%hosts_max_try%& is the maximum number that are tried before deferring the
23735 delivery. However, the logic cannot be quite that simple.
23736
23737 Firstly, IP addresses that are skipped because their retry times have not
23738 arrived do not count, and in addition, addresses that are past their retry
23739 limits are also not counted, even when they are tried. This means that when
23740 some IP addresses are past their retry limits, more than the value of
23741 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23742 that all IP addresses are considered before timing out an email address (but
23743 see below for an exception).
23744
23745 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23746 list to see if there is a subsequent host with a different (higher valued) MX.
23747 If there is, that host is considered next, and the current IP address is used
23748 but not counted. This behaviour helps in the case of a domain with a retry rule
23749 that hardly ever delays any hosts, as is now explained:
23750
23751 Consider the case of a long list of hosts with one MX value, and a few with a
23752 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23753 hosts at the top of the list are tried at first. With the default retry rule,
23754 which specifies increasing retry times, the higher MX hosts are eventually
23755 tried when those at the top of the list are skipped because they have not
23756 reached their retry times.
23757
23758 However, it is common practice to put a fixed short retry time on domains for
23759 large ISPs, on the grounds that their servers are rarely down for very long.
23760 Unfortunately, these are exactly the domains that tend to resolve to long lists
23761 of hosts. The short retry time means that the lowest MX hosts are tried every
23762 time. The attempts may be in a different order because of random sorting, but
23763 without the special MX check, the higher MX hosts would never be tried until
23764 all the lower MX hosts had timed out (which might be several days), because
23765 there are always some lower MX hosts that have reached their retry times. With
23766 the special check, Exim considers at least one IP address from each MX value at
23767 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23768 reached.
23769
23770 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23771 particular, Exim normally eventually tries all the IP addresses before timing
23772 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23773 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23774 been set up with hundreds of IP addresses for some domains. It can
23775 take a very long time indeed for an address to time out in these cases.
23776
23777 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23778 Exim never tries more than this number of IP addresses; if it hits this limit
23779 and they are all timed out, the email address is bounced, even though not all
23780 possible IP addresses have been tried.
23781 .ecindex IIDsmttra1
23782 .ecindex IIDsmttra2
23783
23784
23785
23786
23787
23788 . ////////////////////////////////////////////////////////////////////////////
23789 . ////////////////////////////////////////////////////////////////////////////
23790
23791 .chapter "Address rewriting" "CHAPrewrite"
23792 .scindex IIDaddrew "rewriting" "addresses"
23793 There are some circumstances in which Exim automatically rewrites domains in
23794 addresses. The two most common are when an address is given without a domain
23795 (referred to as an &"unqualified address"&) or when an address contains an
23796 abbreviated domain that is expanded by DNS lookup.
23797
23798 Unqualified envelope addresses are accepted only for locally submitted
23799 messages, or for messages that are received from hosts matching
23800 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23801 appropriate. Unqualified addresses in header lines are qualified if they are in
23802 locally submitted messages, or messages from hosts that are permitted to send
23803 unqualified envelope addresses. Otherwise, unqualified addresses in header
23804 lines are neither qualified nor rewritten.
23805
23806 One situation in which Exim does &'not'& automatically rewrite a domain is
23807 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23808 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23809 do this. The new RFCs do not contain this suggestion.
23810
23811
23812 .section "Explicitly configured address rewriting" "SECID147"
23813 This chapter describes the rewriting rules that can be used in the
23814 main rewrite section of the configuration file, and also in the generic
23815 &%headers_rewrite%& option that can be set on any transport.
23816
23817 Some people believe that configured address rewriting is a Mortal Sin.
23818 Others believe that life is not possible without it. Exim provides the
23819 facility; you do not have to use it.
23820
23821 The main rewriting rules that appear in the &"rewrite"& section of the
23822 configuration file are applied to addresses in incoming messages, both envelope
23823 addresses and addresses in header lines. Each rule specifies the types of
23824 address to which it applies.
23825
23826 Whether or not addresses in header lines are rewritten depends on the origin of
23827 the headers and the type of rewriting. Global rewriting, that is, rewriting
23828 rules from the rewrite section of the configuration file, is applied only to
23829 those headers that were received with the message. Header lines that are added
23830 by ACLs or by a system filter or by individual routers or transports (which
23831 are specific to individual recipient addresses) are not rewritten by the global
23832 rules.
23833
23834 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23835 applies all headers except those added by routers and transports. That is, as
23836 well as the headers that were received with the message, it also applies to
23837 headers that were added by an ACL or a system filter.
23838
23839
23840 In general, rewriting addresses from your own system or domain has some
23841 legitimacy. Rewriting other addresses should be done only with great care and
23842 in special circumstances. The author of Exim believes that rewriting should be
23843 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23844 Although it can sometimes be used as a routing tool, this is very strongly
23845 discouraged.
23846
23847 There are two commonly encountered circumstances where rewriting is used, as
23848 illustrated by these examples:
23849
23850 .ilist
23851 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23852 exchange mail with each other behind a firewall, but there is only a single
23853 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23854 &'hitch.fict.example'& when sending mail off-site.
23855 .next
23856 A host rewrites the local parts of its own users so that, for example,
23857 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23858 .endlist
23859
23860
23861
23862 .section "When does rewriting happen?" "SECID148"
23863 .cindex "rewriting" "timing of"
23864 .cindex "&ACL;" "rewriting addresses in"
23865 Configured address rewriting can take place at several different stages of a
23866 message's processing.
23867
23868 .vindex "&$sender_address$&"
23869 At the start of an ACL for MAIL, the sender address may have been rewritten
23870 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23871 ordinary rewrite rules have yet been applied. If, however, the sender address
23872 is verified in the ACL, it is rewritten before verification, and remains
23873 rewritten thereafter. The subsequent value of &$sender_address$& is the
23874 rewritten address. This also applies if sender verification happens in a
23875 RCPT ACL. Otherwise, when the sender address is not verified, it is
23876 rewritten as soon as a message's header lines have been received.
23877
23878 .vindex "&$domain$&"
23879 .vindex "&$local_part$&"
23880 Similarly, at the start of an ACL for RCPT, the current recipient's address
23881 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23882 rewrite rules have yet been applied to it. However, the behaviour is different
23883 from the sender address when a recipient is verified. The address is rewritten
23884 for the verification, but the rewriting is not remembered at this stage. The
23885 value of &$local_part$& and &$domain$& after verification are always the same
23886 as they were before (that is, they contain the unrewritten &-- except for
23887 SMTP-time rewriting &-- address).
23888
23889 As soon as a message's header lines have been received, all the envelope
23890 recipient addresses are permanently rewritten, and rewriting is also applied to
23891 the addresses in the header lines (if configured). This happens before adding
23892 any header lines that were specified in MAIL or RCPT ACLs, and
23893 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23894 before the DATA ACL and &[local_scan()]& functions are run.
23895
23896 When an address is being routed, either for delivery or for verification,
23897 rewriting is applied immediately to child addresses that are generated by
23898 redirection, unless &%no_rewrite%& is set on the router.
23899
23900 .cindex "envelope sender" "rewriting at transport time"
23901 .cindex "rewriting" "at transport time"
23902 .cindex "header lines" "rewriting at transport time"
23903 At transport time, additional rewriting of addresses in header lines can be
23904 specified by setting the generic &%headers_rewrite%& option on a transport.
23905 This option contains rules that are identical in form to those in the rewrite
23906 section of the configuration file. They are applied to the original message
23907 header lines and any that were added by ACLs or a system filter. They are not
23908 applied to header lines that are added by routers or the transport.
23909
23910 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23911 transport option. However, it is not possible to rewrite envelope recipients at
23912 transport time.
23913
23914
23915
23916
23917 .section "Testing the rewriting rules that apply on input" "SECID149"
23918 .cindex "rewriting" "testing"
23919 .cindex "testing" "rewriting"
23920 Exim's input rewriting configuration appears in a part of the run time
23921 configuration file headed by &"begin rewrite"&. It can be tested by the
23922 &%-brw%& command line option. This takes an address (which can be a full RFC
23923 2822 address) as its argument. The output is a list of how the address would be
23924 transformed by the rewriting rules for each of the different places it might
23925 appear in an incoming message, that is, for each different header and for the
23926 envelope sender and recipient fields. For example,
23927 .code
23928 exim -brw ph10@exim.workshop.example
23929 .endd
23930 might produce the output
23931 .code
23932 sender: Philip.Hazel@exim.workshop.example
23933 from: Philip.Hazel@exim.workshop.example
23934 to: ph10@exim.workshop.example
23935 cc: ph10@exim.workshop.example
23936 bcc: ph10@exim.workshop.example
23937 reply-to: Philip.Hazel@exim.workshop.example
23938 env-from: Philip.Hazel@exim.workshop.example
23939 env-to: ph10@exim.workshop.example
23940 .endd
23941 which shows that rewriting has been set up for that address when used in any of
23942 the source fields, but not when it appears as a recipient address. At the
23943 present time, there is no equivalent way of testing rewriting rules that are
23944 set for a particular transport.
23945
23946
23947 .section "Rewriting rules" "SECID150"
23948 .cindex "rewriting" "rules"
23949 The rewrite section of the configuration file consists of lines of rewriting
23950 rules in the form
23951 .display
23952 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23953 .endd
23954 Rewriting rules that are specified for the &%headers_rewrite%& generic
23955 transport option are given as a colon-separated list. Each item in the list
23956 takes the same form as a line in the main rewriting configuration (except that
23957 any colons must be doubled, of course).
23958
23959 The formats of source patterns and replacement strings are described below.
23960 Each is terminated by white space, unless enclosed in double quotes, in which
23961 case normal quoting conventions apply inside the quotes. The flags are single
23962 characters which may appear in any order. Spaces and tabs between them are
23963 ignored.
23964
23965 For each address that could potentially be rewritten, the rules are scanned in
23966 order, and replacements for the address from earlier rules can themselves be
23967 replaced by later rules (but see the &"q"& and &"R"& flags).
23968
23969 The order in which addresses are rewritten is undefined, may change between
23970 releases, and must not be relied on, with one exception: when a message is
23971 received, the envelope sender is always rewritten first, before any header
23972 lines are rewritten. For example, the replacement string for a rewrite of an
23973 address in &'To:'& must not assume that the message's address in &'From:'& has
23974 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23975 that the envelope sender has already been rewritten.
23976
23977 .vindex "&$domain$&"
23978 .vindex "&$local_part$&"
23979 The variables &$local_part$& and &$domain$& can be used in the replacement
23980 string to refer to the address that is being rewritten. Note that lookup-driven
23981 rewriting can be done by a rule of the form
23982 .code
23983 *@*   ${lookup ...
23984 .endd
23985 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23986 refer to the address that is being rewritten.
23987
23988
23989 .section "Rewriting patterns" "SECID151"
23990 .cindex "rewriting" "patterns"
23991 .cindex "address list" "in a rewriting pattern"
23992 The source pattern in a rewriting rule is any item which may appear in an
23993 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23994 single-item address list, which means that it is expanded before being tested
23995 against the address. As always, if you use a regular expression as a pattern,
23996 you must take care to escape dollar and backslash characters, or use the &`\N`&
23997 facility to suppress string expansion within the regular expression.
23998
23999 Domains in patterns should be given in lower case. Local parts in patterns are
24000 case-sensitive. If you want to do case-insensitive matching of local parts, you
24001 can use a regular expression that starts with &`^(?i)`&.
24002
24003 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24004 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24005 depending on the type of match which occurred. These can be used in the
24006 replacement string to insert portions of the incoming address. &$0$& always
24007 refers to the complete incoming address. When a regular expression is used, the
24008 numerical variables are set from its capturing subexpressions. For other types
24009 of pattern they are set as follows:
24010
24011 .ilist
24012 If a local part or domain starts with an asterisk, the numerical variables
24013 refer to the character strings matched by asterisks, with &$1$& associated with
24014 the first asterisk, and &$2$& with the second, if present. For example, if the
24015 pattern
24016 .code
24017 *queen@*.fict.example
24018 .endd
24019 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24020 .code
24021 $0 = hearts-queen@wonderland.fict.example
24022 $1 = hearts-
24023 $2 = wonderland
24024 .endd
24025 Note that if the local part does not start with an asterisk, but the domain
24026 does, it is &$1$& that contains the wild part of the domain.
24027
24028 .next
24029 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24030 of the domain are placed in the next available numerical variables. Suppose,
24031 for example, that the address &'foo@bar.baz.example'& is processed by a
24032 rewriting rule of the form
24033 .display
24034 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24035 .endd
24036 and the key in the file that matches the domain is &`*.baz.example`&. Then
24037 .code
24038 $1 = foo
24039 $2 = bar
24040 $3 = baz.example
24041 .endd
24042 If the address &'foo@baz.example'& is looked up, this matches the same
24043 wildcard file entry, and in this case &$2$& is set to the empty string, but
24044 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24045 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24046 whole domain. For non-partial domain lookups, no numerical variables are set.
24047 .endlist
24048
24049
24050 .section "Rewriting replacements" "SECID152"
24051 .cindex "rewriting" "replacements"
24052 If the replacement string for a rule is a single asterisk, addresses that
24053 match the pattern and the flags are &'not'& rewritten, and no subsequent
24054 rewriting rules are scanned. For example,
24055 .code
24056 hatta@lookingglass.fict.example  *  f
24057 .endd
24058 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24059 &'From:'& headers.
24060
24061 .vindex "&$domain$&"
24062 .vindex "&$local_part$&"
24063 If the replacement string is not a single asterisk, it is expanded, and must
24064 yield a fully qualified address. Within the expansion, the variables
24065 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24066 Any letters they contain retain their original case &-- they are not lower
24067 cased. The numerical variables are set up according to the type of pattern that
24068 matched the address, as described above. If the expansion is forced to fail by
24069 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24070 current rule is abandoned, but subsequent rules may take effect. Any other
24071 expansion failure causes the entire rewriting operation to be abandoned, and an
24072 entry written to the panic log.
24073
24074
24075
24076 .section "Rewriting flags" "SECID153"
24077 There are three different kinds of flag that may appear on rewriting rules:
24078
24079 .ilist
24080 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24081 c, f, h, r, s, t.
24082 .next
24083 A flag that specifies rewriting at SMTP time: S.
24084 .next
24085 Flags that control the rewriting process: Q, q, R, w.
24086 .endlist
24087
24088 For rules that are part of the &%headers_rewrite%& generic transport option,
24089 E, F, T, and S are not permitted.
24090
24091
24092
24093 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24094          "SECID154"
24095 .cindex "rewriting" "flags"
24096 If none of the following flag letters, nor the &"S"& flag (see section
24097 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24098 and to both the sender and recipient fields of the envelope, whereas a
24099 transport-time rewriting rule just applies to all headers. Otherwise, the
24100 rewriting rule is skipped unless the relevant addresses are being processed.
24101 .display
24102 &`E`&       rewrite all envelope fields
24103 &`F`&       rewrite the envelope From field
24104 &`T`&       rewrite the envelope To field
24105 &`b`&       rewrite the &'Bcc:'& header
24106 &`c`&       rewrite the &'Cc:'& header
24107 &`f`&       rewrite the &'From:'& header
24108 &`h`&       rewrite all headers
24109 &`r`&       rewrite the &'Reply-To:'& header
24110 &`s`&       rewrite the &'Sender:'& header
24111 &`t`&       rewrite the &'To:'& header
24112 .endd
24113 "All headers" means all of the headers listed above that can be selected
24114 individually, plus their &'Resent-'& versions. It does not include
24115 other headers such as &'Subject:'& etc.
24116
24117 You should be particularly careful about rewriting &'Sender:'& headers, and
24118 restrict this to special known cases in your own domains.
24119
24120
24121 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24122 .cindex "SMTP" "rewriting malformed addresses"
24123 .cindex "RCPT" "rewriting argument of"
24124 .cindex "MAIL" "rewriting argument of"
24125 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24126 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24127 before any other processing; even before syntax checking. The pattern is
24128 required to be a regular expression, and it is matched against the whole of the
24129 data for the command, including any surrounding angle brackets.
24130
24131 .vindex "&$domain$&"
24132 .vindex "&$local_part$&"
24133 This form of rewrite rule allows for the handling of addresses that are not
24134 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24135 input). Because the input is not required to be a syntactically valid address,
24136 the variables &$local_part$& and &$domain$& are not available during the
24137 expansion of the replacement string. The result of rewriting replaces the
24138 original address in the MAIL or RCPT command.
24139
24140
24141 .section "Flags controlling the rewriting process" "SECID155"
24142 There are four flags which control the way the rewriting process works. These
24143 take effect only when a rule is invoked, that is, when the address is of the
24144 correct type (matches the flags) and matches the pattern:
24145
24146 .ilist
24147 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24148 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24149 absence of &"Q"& the rewritten address must always include a domain.
24150 .next
24151 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24152 even if no rewriting actually takes place because of a &"fail"& in the
24153 expansion. The &"q"& flag is not effective if the address is of the wrong type
24154 (does not match the flags) or does not match the pattern.
24155 .next
24156 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24157 address, up to ten times. It can be combined with the &"q"& flag, to stop
24158 rewriting once it fails to match (after at least one successful rewrite).
24159 .next
24160 .cindex "rewriting" "whole addresses"
24161 When an address in a header is rewritten, the rewriting normally applies only
24162 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24163 left unchanged. For example, rewriting might change
24164 .code
24165 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24166 .endd
24167 into
24168 .code
24169 From: Ford Prefect <prefectf@hitch.fict.example>
24170 .endd
24171 .cindex "RFC 2047"
24172 Sometimes there is a need to replace the whole address item, and this can be
24173 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24174 causes an address in a header line to be rewritten, the entire address is
24175 replaced, not just the working part. The replacement must be a complete RFC
24176 2822 address, including the angle brackets if necessary. If text outside angle
24177 brackets contains a character whose value is greater than 126 or less than 32
24178 (except for tab), the text is encoded according to RFC 2047. The character set
24179 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24180
24181 When the &"w"& flag is set on a rule that causes an envelope address to be
24182 rewritten, all but the working part of the replacement address is discarded.
24183 .endlist
24184
24185
24186 .section "Rewriting examples" "SECID156"
24187 Here is an example of the two common rewriting paradigms:
24188 .code
24189 *@*.hitch.fict.example  $1@hitch.fict.example
24190 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24191                      {$value}fail}@hitch.fict.example bctfrF
24192 .endd
24193 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24194 the string expansion to fail if the lookup does not succeed. In this context it
24195 has the effect of leaving the original address unchanged, but Exim goes on to
24196 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24197 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24198 explicitly, which would cause the rewritten address to be the same as before,
24199 at the cost of a small bit of processing. Not supplying either of these is an
24200 error, since the rewritten address would then contain no local part.
24201
24202 The first example above replaces the domain with a superior, more general
24203 domain. This may not be desirable for certain local parts. If the rule
24204 .code
24205 root@*.hitch.fict.example  *
24206 .endd
24207 were inserted before the first rule, rewriting would be suppressed for the
24208 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24209
24210 Rewriting can be made conditional on a number of tests, by making use of
24211 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24212 messages that originate outside the local host:
24213 .code
24214 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24215                          {$1@hitch.fict.example}fail}"
24216 .endd
24217 The replacement string is quoted in this example because it contains white
24218 space.
24219
24220 .cindex "rewriting" "bang paths"
24221 .cindex "bang paths" "rewriting"
24222 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24223 an address it treats it as an unqualified local part which it qualifies with
24224 the local qualification domain (if the source of the message is local or if the
24225 remote host is permitted to send unqualified addresses). Rewriting can
24226 sometimes be used to handle simple bang paths with a fixed number of
24227 components. For example, the rule
24228 .code
24229 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24230 .endd
24231 rewrites a two-component bang path &'host.name!user'& as the domain address
24232 &'user@host.name'&. However, there is a security implication in using this as
24233 a global rewriting rule for envelope addresses. It can provide a backdoor
24234 method for using your system as a relay, because the incoming addresses appear
24235 to be local. If the bang path addresses are received via SMTP, it is safer to
24236 use the &"S"& flag to rewrite them as they are received, so that relay checking
24237 can be done on the rewritten addresses.
24238 .ecindex IIDaddrew
24239
24240
24241
24242
24243
24244 . ////////////////////////////////////////////////////////////////////////////
24245 . ////////////////////////////////////////////////////////////////////////////
24246
24247 .chapter "Retry configuration" "CHAPretry"
24248 .scindex IIDretconf1 "retry" "configuration, description of"
24249 .scindex IIDregconf2 "configuration file" "retry section"
24250 The &"retry"& section of the runtime configuration file contains a list of
24251 retry rules that control how often Exim tries to deliver messages that cannot
24252 be delivered at the first attempt. If there are no retry rules (the section is
24253 empty or not present), there are no retries. In this situation, temporary
24254 errors are treated as permanent. The default configuration contains a single,
24255 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24256 line option can be used to test which retry rule will be used for a given
24257 address, domain and error.
24258
24259 The most common cause of retries is temporary failure to deliver to a remote
24260 host because the host is down, or inaccessible because of a network problem.
24261 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24262 address) basis, not on a per-message basis. Thus, if one message has recently
24263 been delayed, delivery of a new message to the same host is not immediately
24264 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24265 log selector is set, the message
24266 .cindex "retry" "time not reached"
24267 &"retry time not reached"& is written to the main log whenever a delivery is
24268 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24269 the handling of errors during remote deliveries.
24270
24271 Retry processing applies to routing as well as to delivering, except as covered
24272 in the next paragraph. The retry rules do not distinguish between these
24273 actions. It is not possible, for example, to specify different behaviour for
24274 failures to route the domain &'snark.fict.example'& and failures to deliver to
24275 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24276 added complication, so did not implement it. However, although they share the
24277 same retry rule, the actual retry times for routing and transporting a given
24278 domain are maintained independently.
24279
24280 When a delivery is not part of a queue run (typically an immediate delivery on
24281 receipt of a message), the routers are always run, and local deliveries are
24282 always attempted, even if retry times are set for them. This makes for better
24283 behaviour if one particular message is causing problems (for example, causing
24284 quota overflow, or provoking an error in a filter file). If such a delivery
24285 suffers a temporary failure, the retry data is updated as normal, and
24286 subsequent delivery attempts from queue runs occur only when the retry time for
24287 the local address is reached.
24288
24289 .section "Changing retry rules" "SECID157"
24290 If you change the retry rules in your configuration, you should consider
24291 whether or not to delete the retry data that is stored in Exim's spool area in
24292 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24293 always safe; that is why they are called &"hints"&.
24294
24295 The hints retry data contains suggested retry times based on the previous
24296 rules. In the case of a long-running problem with a remote host, it might
24297 record the fact that the host has timed out. If your new rules increase the
24298 timeout time for such a host, you should definitely remove the old retry data
24299 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24300 messages that it should now be retaining.
24301
24302
24303
24304 .section "Format of retry rules" "SECID158"
24305 .cindex "retry" "rules"
24306 Each retry rule occupies one line and consists of three or four parts,
24307 separated by white space: a pattern, an error name, an optional list of sender
24308 addresses, and a list of retry parameters. The pattern and sender lists must be
24309 enclosed in double quotes if they contain white space. The rules are searched
24310 in order until one is found where the pattern, error name, and sender list (if
24311 present) match the failing host or address, the error that occurred, and the
24312 message's sender, respectively.
24313
24314
24315 The pattern is any single item that may appear in an address list (see section
24316 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24317 which means that it is expanded before being tested against the address that
24318 has been delayed. A negated address list item is permitted. Address
24319 list processing treats a plain domain name as if it were preceded by &"*@"&,
24320 which makes it possible for many retry rules to start with just a domain. For
24321 example,
24322 .code
24323 lookingglass.fict.example        *  F,24h,30m;
24324 .endd
24325 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24326 whereas
24327 .code
24328 alice@lookingglass.fict.example  *  F,24h,30m;
24329 .endd
24330 applies only to temporary failures involving the local part &%alice%&.
24331 In practice, almost all rules start with a domain name pattern without a local
24332 part.
24333
24334 .cindex "regular expressions" "in retry rules"
24335 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24336 must match a complete address, not just a domain, because that is how regular
24337 expressions work in address lists.
24338 .display
24339 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24340 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24341 .endd
24342
24343
24344 .section "Choosing which retry rule to use for address errors" "SECID159"
24345 When Exim is looking for a retry rule after a routing attempt has failed (for
24346 example, after a DNS timeout), each line in the retry configuration is tested
24347 against the complete address only if &%retry_use_local_part%& is set for the
24348 router. Otherwise, only the domain is used, except when matching against a
24349 regular expression, when the local part of the address is replaced with &"*"&.
24350 A domain on its own can match a domain pattern, or a pattern that starts with
24351 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24352 &%check_local_user%& is true, and false for other routers.
24353
24354 Similarly, when Exim is looking for a retry rule after a local delivery has
24355 failed (for example, after a mailbox full error), each line in the retry
24356 configuration is tested against the complete address only if
24357 &%retry_use_local_part%& is set for the transport (it defaults true for all
24358 local transports).
24359
24360 .cindex "4&'xx'& responses" "retry rules for"
24361 However, when Exim is looking for a retry rule after a remote delivery attempt
24362 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24363 whole address is always used as the key when searching the retry rules. The
24364 rule that is found is used to create a retry time for the combination of the
24365 failing address and the message's sender. It is the combination of sender and
24366 recipient that is delayed in subsequent queue runs until its retry time is
24367 reached. You can delay the recipient without regard to the sender by setting
24368 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24369 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24370 commands.
24371
24372
24373
24374 .section "Choosing which retry rule to use for host and message errors" &&&
24375          "SECID160"
24376 For a temporary error that is not related to an individual address (for
24377 example, a connection timeout), each line in the retry configuration is checked
24378 twice. First, the name of the remote host is used as a domain name (preceded by
24379 &"*@"& when matching a regular expression). If this does not match the line,
24380 the domain from the email address is tried in a similar fashion. For example,
24381 suppose the MX records for &'a.b.c.example'& are
24382 .code
24383 a.b.c.example  MX  5  x.y.z.example
24384                MX  6  p.q.r.example
24385                MX  7  m.n.o.example
24386 .endd
24387 and the retry rules are
24388 .code
24389 p.q.r.example    *      F,24h,30m;
24390 a.b.c.example    *      F,4d,45m;
24391 .endd
24392 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24393 first rule matches neither the host nor the domain, so Exim looks at the second
24394 rule. This does not match the host, but it does match the domain, so it is used
24395 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24396 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24397 first retry rule is used, because it matches the host.
24398
24399 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24400 first rule to determine retry times, but for all the other hosts for the domain
24401 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24402 routing to &'a.b.c.example'& suffers a temporary failure.
24403
24404 &*Note*&: The host name is used when matching the patterns, not its IP address.
24405 However, if a message is routed directly to an IP address without the use of a
24406 host name, for example, if a &(manualroute)& router contains a setting such as:
24407 .code
24408 route_list = *.a.example  192.168.34.23
24409 .endd
24410 then the &"host name"& that is used when searching for a retry rule is the
24411 textual form of the IP address.
24412
24413 .section "Retry rules for specific errors" "SECID161"
24414 .cindex "retry" "specific errors; specifying"
24415 The second field in a retry rule is the name of a particular error, or an
24416 asterisk, which matches any error. The errors that can be tested for are:
24417
24418 .vlist
24419 .vitem &%auth_failed%&
24420 Authentication failed when trying to send to a host in the
24421 &%hosts_require_auth%& list in an &(smtp)& transport.
24422
24423 .vitem &%data_4xx%&
24424 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24425 after the command, or after sending the message's data.
24426
24427 .vitem &%mail_4xx%&
24428 A 4&'xx'& error was received for an outgoing MAIL command.
24429
24430 .vitem &%rcpt_4xx%&
24431 A 4&'xx'& error was received for an outgoing RCPT command.
24432 .endlist
24433
24434 For the three 4&'xx'& errors, either the first or both of the x's can be given
24435 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24436 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24437 and have retries every ten minutes with a one-hour timeout, you could set up a
24438 retry rule of this form:
24439 .code
24440 the.domain.name  rcpt_452   F,1h,10m
24441 .endd
24442 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24443 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24444
24445 .vlist
24446 .vitem &%lost_connection%&
24447 A server unexpectedly closed the SMTP connection. There may, of course,
24448 legitimate reasons for this (host died, network died), but if it repeats a lot
24449 for the same host, it indicates something odd.
24450
24451 .vitem &%lookup%&
24452 A DNS lookup for a host failed.
24453 Note that a &%dnslookup%& router will need to have matched
24454 its &%fail_defer_domains%& option for this retry type to be usable.
24455 Also note that a &%manualroute%& router will probably need
24456 its &%host_find_failed%& option set to &%defer%&.
24457
24458 .vitem &%refused_MX%&
24459 A connection to a host obtained from an MX record was refused.
24460
24461 .vitem &%refused_A%&
24462 A connection to a host not obtained from an MX record was refused.
24463
24464 .vitem &%refused%&
24465 A connection was refused.
24466
24467 .vitem &%timeout_connect_MX%&
24468 A connection attempt to a host obtained from an MX record timed out.
24469
24470 .vitem &%timeout_connect_A%&
24471 A connection attempt to a host not obtained from an MX record timed out.
24472
24473 .vitem &%timeout_connect%&
24474 A connection attempt timed out.
24475
24476 .vitem &%timeout_MX%&
24477 There was a timeout while connecting or during an SMTP session with a host
24478 obtained from an MX record.
24479
24480 .vitem &%timeout_A%&
24481 There was a timeout while connecting or during an SMTP session with a host not
24482 obtained from an MX record.
24483
24484 .vitem &%timeout%&
24485 There was a timeout while connecting or during an SMTP session.
24486
24487 .vitem &%tls_required%&
24488 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24489 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24490 to STARTTLS, or there was a problem setting up the TLS connection.
24491
24492 .vitem &%quota%&
24493 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24494 transport.
24495
24496 .vitem &%quota_%&<&'time'&>
24497 .cindex "quota" "error testing in retry rule"
24498 .cindex "retry" "quota error testing"
24499 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24500 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24501 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24502 for four days.
24503 .endlist
24504
24505 .cindex "mailbox" "time of last read"
24506 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24507 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24508 it should be based on the last time that the user accessed the mailbox.
24509 However, it is not always possible to determine this. Exim uses the following
24510 heuristic rules:
24511
24512 .ilist
24513 If the mailbox is a single file, the time of last access (the &"atime"&) is
24514 used. As no new messages are being delivered (because the mailbox is over
24515 quota), Exim does not access the file, so this is the time of last user access.
24516 .next
24517 .cindex "maildir format" "time of last read"
24518 For a maildir delivery, the time of last modification of the &_new_&
24519 subdirectory is used. As the mailbox is over quota, no new files are created in
24520 the &_new_& subdirectory, because no new messages are being delivered. Any
24521 change to the &_new_& subdirectory is therefore assumed to be the result of an
24522 MUA moving a new message to the &_cur_& directory when it is first read. The
24523 time that is used is therefore the last time that the user read a new message.
24524 .next
24525 For other kinds of multi-file mailbox, the time of last access cannot be
24526 obtained, so a retry rule that uses this type of error field is never matched.
24527 .endlist
24528
24529 The quota errors apply both to system-enforced quotas and to Exim's own quota
24530 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24531 when a local delivery is deferred because a partition is full (the ENOSPC
24532 error).
24533
24534
24535
24536 .section "Retry rules for specified senders" "SECID162"
24537 .cindex "retry" "rules; sender-specific"
24538 You can specify retry rules that apply only when the failing message has a
24539 specific sender. In particular, this can be used to define retry rules that
24540 apply only to bounce messages. The third item in a retry rule can be of this
24541 form:
24542 .display
24543 &`senders=`&<&'address list'&>
24544 .endd
24545 The retry timings themselves are then the fourth item. For example:
24546 .code
24547 *   rcpt_4xx   senders=:   F,1h,30m
24548 .endd
24549 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24550 host. If the address list contains white space, it must be enclosed in quotes.
24551 For example:
24552 .code
24553 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24554 .endd
24555 &*Warning*&: This facility can be unhelpful if it is used for host errors
24556 (which do not depend on the recipient). The reason is that the sender is used
24557 only to match the retry rule. Once the rule has been found for a host error,
24558 its contents are used to set a retry time for the host, and this will apply to
24559 all messages, not just those with specific senders.
24560
24561 When testing retry rules using &%-brt%&, you can supply a sender using the
24562 &%-f%& command line option, like this:
24563 .code
24564 exim -f "" -brt user@dom.ain
24565 .endd
24566 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24567 list is never matched.
24568
24569
24570
24571
24572
24573 .section "Retry parameters" "SECID163"
24574 .cindex "retry" "parameters in rules"
24575 The third (or fourth, if a senders list is present) field in a retry rule is a
24576 sequence of retry parameter sets, separated by semicolons. Each set consists of
24577 .display
24578 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24579 .endd
24580 The letter identifies the algorithm for computing a new retry time; the cutoff
24581 time is the time beyond which this algorithm no longer applies, and the
24582 arguments vary the algorithm's action. The cutoff time is measured from the
24583 time that the first failure for the domain (combined with the local part if
24584 relevant) was detected, not from the time the message was received.
24585
24586 .cindex "retry" "algorithms"
24587 .cindex "retry" "fixed intervals"
24588 .cindex "retry" "increasing intervals"
24589 .cindex "retry" "random intervals"
24590 The available algorithms are:
24591
24592 .ilist
24593 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24594 the interval.
24595 .next
24596 &'G'&: retry at geometrically increasing intervals. The first argument
24597 specifies a starting value for the interval, and the second a multiplier, which
24598 is used to increase the size of the interval at each retry.
24599 .next
24600 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24601 retry, the previous interval is multiplied by the factor in order to get a
24602 maximum for the next interval. The minimum interval is the first argument of
24603 the parameter, and an actual interval is chosen randomly between them. Such a
24604 rule has been found to be helpful in cluster configurations when all the
24605 members of the cluster restart at once, and may therefore synchronize their
24606 queue processing times.
24607 .endlist
24608
24609 When computing the next retry time, the algorithm definitions are scanned in
24610 order until one whose cutoff time has not yet passed is reached. This is then
24611 used to compute a new retry time that is later than the current time. In the
24612 case of fixed interval retries, this simply means adding the interval to the
24613 current time. For geometrically increasing intervals, retry intervals are
24614 computed from the rule's parameters until one that is greater than the previous
24615 interval is found. The main configuration variable
24616 .cindex "limit" "retry interval"
24617 .cindex "retry" "interval, maximum"
24618 .oindex "&%retry_interval_max%&"
24619 &%retry_interval_max%& limits the maximum interval between retries. It
24620 cannot be set greater than &`24h`&, which is its default value.
24621
24622 A single remote domain may have a number of hosts associated with it, and each
24623 host may have more than one IP address. Retry algorithms are selected on the
24624 basis of the domain name, but are applied to each IP address independently. If,
24625 for example, a host has two IP addresses and one is unusable, Exim will
24626 generate retry times for it and will not try to use it until its next retry
24627 time comes. Thus the good IP address is likely to be tried first most of the
24628 time.
24629
24630 .cindex "hints database" "use for retrying"
24631 Retry times are hints rather than promises. Exim does not make any attempt to
24632 run deliveries exactly at the computed times. Instead, a queue runner process
24633 starts delivery processes for delayed messages periodically, and these attempt
24634 new deliveries only for those addresses that have passed their next retry time.
24635 If a new message arrives for a deferred address, an immediate delivery attempt
24636 occurs only if the address has passed its retry time. In the absence of new
24637 messages, the minimum time between retries is the interval between queue runner
24638 processes. There is not much point in setting retry times of five minutes if
24639 your queue runners happen only once an hour, unless there are a significant
24640 number of incoming messages (which might be the case on a system that is
24641 sending everything to a smart host, for example).
24642
24643 The data in the retry hints database can be inspected by using the
24644 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24645 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24646 &'exinext'& utility script can be used to find out what the next retry times
24647 are for the hosts associated with a particular mail domain, and also for local
24648 deliveries that have been deferred.
24649
24650
24651 .section "Retry rule examples" "SECID164"
24652 Here are some example retry rules:
24653 .code
24654 alice@wonderland.fict.example quota_5d  F,7d,3h
24655 wonderland.fict.example       quota_5d
24656 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24657 lookingglass.fict.example     *         F,24h,30m;
24658 *                 refused_A   F,2h,20m;
24659 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24660 .endd
24661 The first rule sets up special handling for mail to
24662 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24663 mailbox has not been read for at least 5 days. Retries continue every three
24664 hours for 7 days. The second rule handles over-quota errors for all other local
24665 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24666 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24667 fail are bounced immediately if the mailbox has not been read for at least 5
24668 days.
24669
24670 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24671 happen every 15 minutes for an hour, then with geometrically increasing
24672 intervals until two days have passed since a delivery first failed. After the
24673 first hour there is a delay of one hour, then two hours, then four hours, and
24674 so on (this is a rather extreme example).
24675
24676 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24677 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24678 all other domains, with special action for connection refusal from hosts that
24679 were not obtained from an MX record.
24680
24681 The final rule in a retry configuration should always have asterisks in the
24682 first two fields so as to provide a general catch-all for any addresses that do
24683 not have their own special handling. This example tries every 15 minutes for 2
24684 hours, then with intervals starting at one hour and increasing by a factor of
24685 1.5 up to 16 hours, then every 8 hours up to 5 days.
24686
24687
24688
24689 .section "Timeout of retry data" "SECID165"
24690 .cindex "timeout" "of retry data"
24691 .oindex "&%retry_data_expire%&"
24692 .cindex "hints database" "data expiry"
24693 .cindex "retry" "timeout of data"
24694 Exim timestamps the data that it writes to its retry hints database. When it
24695 consults the data during a delivery it ignores any that is older than the value
24696 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24697 been tried for 7 days, Exim will try to deliver to it immediately a message
24698 arrives, and if that fails, it will calculate a retry time as if it were
24699 failing for the first time.
24700
24701 This improves the behaviour for messages routed to rarely-used hosts such as MX
24702 backups. If such a host was down at one time, and happens to be down again when
24703 Exim tries a month later, using the old retry data would imply that it had been
24704 down all the time, which is not a justified assumption.
24705
24706 If a host really is permanently dead, this behaviour causes a burst of retries
24707 every now and again, but only if messages routed to it are rare. If there is a
24708 message at least once every 7 days the retry data never expires.
24709
24710
24711
24712
24713 .section "Long-term failures" "SECID166"
24714 .cindex "delivery failure, long-term"
24715 .cindex "retry" "after long-term failure"
24716 Special processing happens when an email address has been failing for so long
24717 that the cutoff time for the last algorithm is reached. For example, using the
24718 default retry rule:
24719 .code
24720 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24721 .endd
24722 the cutoff time is four days. Reaching the retry cutoff is independent of how
24723 long any specific message has been failing; it is the length of continuous
24724 failure for the recipient address that counts.
24725
24726 When the cutoff time is reached for a local delivery, or for all the IP
24727 addresses associated with a remote delivery, a subsequent delivery failure
24728 causes Exim to give up on the address, and a bounce message is generated.
24729 In order to cater for new messages that use the failing address, a next retry
24730 time is still computed from the final algorithm, and is used as follows:
24731
24732 For local deliveries, one delivery attempt is always made for any subsequent
24733 messages. If this delivery fails, the address fails immediately. The
24734 post-cutoff retry time is not used.
24735
24736 If the delivery is remote, there are two possibilities, controlled by the
24737 .oindex "&%delay_after_cutoff%&"
24738 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24739 default. Until the post-cutoff retry time for one of the IP addresses is
24740 reached, the failing email address is bounced immediately, without a delivery
24741 attempt taking place. After that time, one new delivery attempt is made to
24742 those IP addresses that are past their retry times, and if that still fails,
24743 the address is bounced and new retry times are computed.
24744
24745 In other words, when all the hosts for a given email address have been failing
24746 for a long time, Exim bounces rather then defers until one of the hosts' retry
24747 times is reached. Then it tries once, and bounces if that attempt fails. This
24748 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24749 to a broken destination, but if the host does recover, Exim will eventually
24750 notice.
24751
24752 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24753 addresses are past their final cutoff time, Exim tries to deliver to those IP
24754 addresses that have not been tried since the message arrived. If there are
24755 no suitable IP addresses, or if they all fail, the address is bounced. In other
24756 words, it does not delay when a new message arrives, but tries the expired
24757 addresses immediately, unless they have been tried since the message arrived.
24758 If there is a continuous stream of messages for the failing domains, setting
24759 &%delay_after_cutoff%& false means that there will be many more attempts to
24760 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24761 true.
24762
24763 .section "Deliveries that work intermittently" "SECID167"
24764 .cindex "retry" "intermittently working deliveries"
24765 Some additional logic is needed to cope with cases where a host is
24766 intermittently available, or when a message has some attribute that prevents
24767 its delivery when others to the same address get through. In this situation,
24768 because some messages are successfully delivered, the &"retry clock"& for the
24769 host or address keeps getting reset by the successful deliveries, and so
24770 failing messages remain on the queue for ever because the cutoff time is never
24771 reached.
24772
24773 Two exceptional actions are applied to prevent this happening. The first
24774 applies to errors that are related to a message rather than a remote host.
24775 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24776 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24777 commands, and quota failures. For this type of error, if a message's arrival
24778 time is earlier than the &"first failed"& time for the error, the earlier time
24779 is used when scanning the retry rules to decide when to try next and when to
24780 time out the address.
24781
24782 The exceptional second action applies in all cases. If a message has been on
24783 the queue for longer than the cutoff time of any applicable retry rule for a
24784 given address, a delivery is attempted for that address, even if it is not yet
24785 time, and if this delivery fails, the address is timed out. A new retry time is
24786 not computed in this case, so that other messages for the same address are
24787 considered immediately.
24788 .ecindex IIDretconf1
24789 .ecindex IIDregconf2
24790
24791
24792
24793
24794
24795
24796 . ////////////////////////////////////////////////////////////////////////////
24797 . ////////////////////////////////////////////////////////////////////////////
24798
24799 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24800 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24801 .scindex IIDauthconf2 "authentication"
24802 The &"authenticators"& section of Exim's run time configuration is concerned
24803 with SMTP authentication. This facility is an extension to the SMTP protocol,
24804 described in RFC 2554, which allows a client SMTP host to authenticate itself
24805 to a server. This is a common way for a server to recognize clients that are
24806 permitted to use it as a relay. SMTP authentication is not of relevance to the
24807 transfer of mail between servers that have no managerial connection with each
24808 other.
24809
24810 .cindex "AUTH" "description of"
24811 Very briefly, the way SMTP authentication works is as follows:
24812
24813 .ilist
24814 The server advertises a number of authentication &'mechanisms'& in response to
24815 the client's EHLO command.
24816 .next
24817 The client issues an AUTH command, naming a specific mechanism. The command
24818 may, optionally, contain some authentication data.
24819 .next
24820 The server may issue one or more &'challenges'&, to which the client must send
24821 appropriate responses. In simple authentication mechanisms, the challenges are
24822 just prompts for user names and passwords. The server does not have to issue
24823 any challenges &-- in some mechanisms the relevant data may all be transmitted
24824 with the AUTH command.
24825 .next
24826 The server either accepts or denies authentication.
24827 .next
24828 If authentication succeeds, the client may optionally make use of the AUTH
24829 option on the MAIL command to pass an authenticated sender in subsequent
24830 mail transactions. Authentication lasts for the remainder of the SMTP
24831 connection.
24832 .next
24833 If authentication fails, the client may give up, or it may try a different
24834 authentication mechanism, or it may try transferring mail over the
24835 unauthenticated connection.
24836 .endlist
24837
24838 If you are setting up a client, and want to know which authentication
24839 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24840 SMTP port) on the server, and issue an EHLO command. The response to this
24841 includes the list of supported mechanisms. For example:
24842 .display
24843 &`$ `&&*&`telnet server.example 25`&*&
24844 &`Trying 192.168.34.25...`&
24845 &`Connected to server.example.`&
24846 &`Escape character is &#x0027;^]&#x0027;.`&
24847 &`220 server.example ESMTP Exim 4.20 ...`&
24848 &*&`ehlo client.example`&*&
24849 &`250-server.example Hello client.example [10.8.4.5]`&
24850 &`250-SIZE 52428800`&
24851 &`250-PIPELINING`&
24852 &`250-AUTH PLAIN`&
24853 &`250 HELP`&
24854 .endd
24855 The second-last line of this example output shows that the server supports
24856 authentication using the PLAIN mechanism. In Exim, the different authentication
24857 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24858 routers and transports, which authenticators are included in the binary is
24859 controlled by build-time definitions. The following are currently available,
24860 included by setting
24861 .code
24862 AUTH_CRAM_MD5=yes
24863 AUTH_CYRUS_SASL=yes
24864 AUTH_DOVECOT=yes
24865 AUTH_GSASL=yes
24866 AUTH_HEIMDAL_GSSAPI=yes
24867 AUTH_PLAINTEXT=yes
24868 AUTH_SPA=yes
24869 AUTH_TLS=yes
24870 .endd
24871 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24872 authentication mechanism (RFC 2195), and the second provides an interface to
24873 the Cyrus SASL authentication library.
24874 The third is an interface to Dovecot's authentication system, delegating the
24875 work via a socket interface.
24876 The fourth provides an interface to the GNU SASL authentication library, which
24877 provides mechanisms but typically not data sources.
24878 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24879 supporting setting a server keytab.
24880 The sixth can be configured to support
24881 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24882 not formally documented, but used by several MUAs. The seventh authenticator
24883 supports Microsoft's &'Secure Password Authentication'& mechanism.
24884 The eighth is an Exim authenticator but not an SMTP one;
24885 instead it can use information from a TLS negotiation.
24886
24887 The authenticators are configured using the same syntax as other drivers (see
24888 section &<<SECTfordricon>>&). If no authenticators are required, no
24889 authentication section need be present in the configuration file. Each
24890 authenticator can in principle have both server and client functions. When Exim
24891 is receiving SMTP mail, it is acting as a server; when it is sending out
24892 messages over SMTP, it is acting as a client. Authenticator configuration
24893 options are provided for use in both these circumstances.
24894
24895 To make it clear which options apply to which situation, the prefixes
24896 &%server_%& and &%client_%& are used on option names that are specific to
24897 either the server or the client function, respectively. Server and client
24898 functions are disabled if none of their options are set. If an authenticator is
24899 to be used for both server and client functions, a single definition, using
24900 both sets of options, is required. For example:
24901 .code
24902 cram:
24903   driver = cram_md5
24904   public_name = CRAM-MD5
24905   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24906   client_name = ph10
24907   client_secret = secret2
24908 .endd
24909 The &%server_%& option is used when Exim is acting as a server, and the
24910 &%client_%& options when it is acting as a client.
24911
24912 Descriptions of the individual authenticators are given in subsequent chapters.
24913 The remainder of this chapter covers the generic options for the
24914 authenticators, followed by general discussion of the way authentication works
24915 in Exim.
24916
24917 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24918 per-mechanism basis.  Please read carefully to determine which variables hold
24919 account labels such as usercodes and which hold passwords or other
24920 authenticating data.
24921
24922 Note that some mechanisms support two different identifiers for accounts: the
24923 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24924 and &'authz'& are commonly encountered.  The American spelling is standard here.
24925 Conceptually, authentication data such as passwords are tied to the identifier
24926 used to authenticate; servers may have rules to permit one user to act as a
24927 second user, so that after login the session is treated as though that second
24928 user had logged in.  That second user is the &'authorization id'&.  A robust
24929 configuration might confirm that the &'authz'& field is empty or matches the
24930 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24931 as verified data, the &'authz'& as an unverified request which the server might
24932 choose to honour.
24933
24934 A &'realm'& is a text string, typically a domain name, presented by a server
24935 to a client to help it select an account and credentials to use.  In some
24936 mechanisms, the client and server provably agree on the realm, but clients
24937 typically can not treat the realm as secure data to be blindly trusted.
24938
24939
24940
24941 .section "Generic options for authenticators" "SECID168"
24942 .cindex "authentication" "generic options"
24943 .cindex "options" "generic; for authenticators"
24944
24945 .option client_condition authenticators string&!! unset
24946 When Exim is authenticating as a client, it skips any authenticator whose
24947 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24948 used, for example, to skip plain text authenticators when the connection is not
24949 encrypted by a setting such as:
24950 .code
24951 client_condition = ${if !eq{$tls_out_cipher}{}}
24952 .endd
24953
24954
24955 .option client_set_id authenticators string&!! unset
24956 When client authentication succeeds, this condition is expanded; the
24957 result is used in the log lines for outbound messasges.
24958 Typically it will be the user name used for authentication.
24959
24960
24961 .option driver authenticators string unset
24962 This option must always be set. It specifies which of the available
24963 authenticators is to be used.
24964
24965
24966 .option public_name authenticators string unset
24967 This option specifies the name of the authentication mechanism that the driver
24968 implements, and by which it is known to the outside world. These names should
24969 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24970 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24971 defaults to the driver's instance name.
24972
24973
24974 .option server_advertise_condition authenticators string&!! unset
24975 When a server is about to advertise an authentication mechanism, the condition
24976 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24977 mechanism is not advertised.
24978 If the expansion fails, the mechanism is not advertised. If the failure was not
24979 forced, and was not caused by a lookup defer, the incident is logged.
24980 See section &<<SECTauthexiser>>& below for further discussion.
24981
24982
24983 .option server_condition authenticators string&!! unset
24984 This option must be set for a &%plaintext%& server authenticator, where it
24985 is used directly to control authentication. See section &<<SECTplainserver>>&
24986 for details.
24987
24988 For the &(gsasl)& authenticator, this option is required for various
24989 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24990
24991 For the other authenticators, &%server_condition%& can be used as an additional
24992 authentication or authorization mechanism that is applied after the other
24993 authenticator conditions succeed. If it is set, it is expanded when the
24994 authenticator would otherwise return a success code. If the expansion is forced
24995 to fail, authentication fails. Any other expansion failure causes a temporary
24996 error code to be returned. If the result of a successful expansion is an empty
24997 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24998 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24999 other result, a temporary error code is returned, with the expanded string as
25000 the error text.
25001
25002
25003 .option server_debug_print authenticators string&!! unset
25004 If this option is set and authentication debugging is enabled (see the &%-d%&
25005 command line option), the string is expanded and included in the debugging
25006 output when the authenticator is run as a server. This can help with checking
25007 out the values of variables.
25008 If expansion of the string fails, the error message is written to the debugging
25009 output, and Exim carries on processing.
25010
25011
25012 .option server_set_id authenticators string&!! unset
25013 .vindex "&$authenticated_id$&"
25014 When an Exim server successfully authenticates a client, this string is
25015 expanded using data from the authentication, and preserved for any incoming
25016 messages in the variable &$authenticated_id$&. It is also included in the log
25017 lines for incoming messages. For example, a user/password authenticator
25018 configuration might preserve the user name that was used to authenticate, and
25019 refer to it subsequently during delivery of the message.
25020 If expansion fails, the option is ignored.
25021
25022
25023 .option server_mail_auth_condition authenticators string&!! unset
25024 This option allows a server to discard authenticated sender addresses supplied
25025 as part of MAIL commands in SMTP connections that are authenticated by the
25026 driver on which &%server_mail_auth_condition%& is set. The option is not used
25027 as part of the authentication process; instead its (unexpanded) value is
25028 remembered for later use.
25029 How it is used is described in the following section.
25030
25031
25032
25033
25034
25035 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25036 .cindex "authentication" "sender; authenticated"
25037 .cindex "AUTH" "on MAIL command"
25038 When a client supplied an AUTH= item on a MAIL command, Exim applies
25039 the following checks before accepting it as the authenticated sender of the
25040 message:
25041
25042 .ilist
25043 If the connection is not using extended SMTP (that is, HELO was used rather
25044 than EHLO), the use of AUTH= is a syntax error.
25045 .next
25046 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25047 .next
25048 .vindex "&$authenticated_sender$&"
25049 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25050 running, the value of &$authenticated_sender$& is set to the value obtained
25051 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25052 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25053 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25054 given for the MAIL command.
25055 .next
25056 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25057 is accepted and placed in &$authenticated_sender$& only if the client has
25058 authenticated.
25059 .next
25060 If the AUTH= value was accepted by either of the two previous rules, and
25061 the client has authenticated, and the authenticator has a setting for the
25062 &%server_mail_auth_condition%&, the condition is checked at this point. The
25063 valued that was saved from the authenticator is expanded. If the expansion
25064 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25065 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25066 the value of &$authenticated_sender$& is retained and passed on with the
25067 message.
25068 .endlist
25069
25070
25071 When &$authenticated_sender$& is set for a message, it is passed on to other
25072 hosts to which Exim authenticates as a client. Do not confuse this value with
25073 &$authenticated_id$&, which is a string obtained from the authentication
25074 process, and which is not usually a complete email address.
25075
25076 .vindex "&$sender_address$&"
25077 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25078 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25079 therefore make use of &$authenticated_sender$&. The converse is not true: the
25080 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25081 ACL is run.
25082
25083
25084
25085 .section "Authentication on an Exim server" "SECTauthexiser"
25086 .cindex "authentication" "on an Exim server"
25087 When Exim receives an EHLO command, it advertises the public names of those
25088 authenticators that are configured as servers, subject to the following
25089 conditions:
25090
25091 .ilist
25092 The client host must match &%auth_advertise_hosts%& (default *).
25093 .next
25094 It the &%server_advertise_condition%& option is set, its expansion must not
25095 yield the empty string, &"0"&, &"no"&, or &"false"&.
25096 .endlist
25097
25098 The order in which the authenticators are defined controls the order in which
25099 the mechanisms are advertised.
25100
25101 Some mail clients (for example, some versions of Netscape) require the user to
25102 provide a name and password for authentication whenever AUTH is advertised,
25103 even though authentication may not in fact be needed (for example, Exim may be
25104 set up to allow unconditional relaying from the client by an IP address check).
25105 You can make such clients more friendly by not advertising AUTH to them.
25106 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25107 that runs for RCPT) to relay without authentication, you should set
25108 .code
25109 auth_advertise_hosts = ! 10.9.8.0/24
25110 .endd
25111 so that no authentication mechanisms are advertised to them.
25112
25113 The &%server_advertise_condition%& controls the advertisement of individual
25114 authentication mechanisms. For example, it can be used to restrict the
25115 advertisement of a particular mechanism to encrypted connections, by a setting
25116 such as:
25117 .code
25118 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25119 .endd
25120 .vindex "&$tls_in_cipher$&"
25121 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25122 yields &"yes"&, which allows the advertisement to happen.
25123
25124 When an Exim server receives an AUTH command from a client, it rejects it
25125 immediately if AUTH was not advertised in response to an earlier EHLO
25126 command. This is the case if
25127
25128 .ilist
25129 The client host does not match &%auth_advertise_hosts%&; or
25130 .next
25131 No authenticators are configured with server options; or
25132 .next
25133 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25134 server authenticators.
25135 .endlist
25136
25137
25138 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25139 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25140 AUTH is accepted from any client host.
25141
25142 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25143 server authentication mechanism that was advertised in response to EHLO and
25144 that matches the one named in the AUTH command. If it finds one, it runs
25145 the appropriate authentication protocol, and authentication either succeeds or
25146 fails. If there is no matching advertised mechanism, the AUTH command is
25147 rejected with a 504 error.
25148
25149 .vindex "&$received_protocol$&"
25150 .vindex "&$sender_host_authenticated$&"
25151 When a message is received from an authenticated host, the value of
25152 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25153 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25154 public name) of the authenticator driver that successfully authenticated the
25155 client from which the message was received. This variable is empty if there was
25156 no successful authentication.
25157
25158
25159
25160
25161 .section "Testing server authentication" "SECID169"
25162 .cindex "authentication" "testing a server"
25163 .cindex "AUTH" "testing a server"
25164 .cindex "base64 encoding" "creating authentication test data"
25165 Exim's &%-bh%& option can be useful for testing server authentication
25166 configurations. The data for the AUTH command has to be sent using base64
25167 encoding. A quick way to produce such data for testing is the following Perl
25168 script:
25169 .code
25170 use MIME::Base64;
25171 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25172 .endd
25173 .cindex "binary zero" "in authentication data"
25174 This interprets its argument as a Perl string, and then encodes it. The
25175 interpretation as a Perl string allows binary zeros, which are required for
25176 some kinds of authentication, to be included in the data. For example, a
25177 command line to run this script on such data might be
25178 .code
25179 encode '\0user\0password'
25180 .endd
25181 Note the use of single quotes to prevent the shell interpreting the
25182 backslashes, so that they can be interpreted by Perl to specify characters
25183 whose code value is zero.
25184
25185 &*Warning 1*&: If either of the user or password strings starts with an octal
25186 digit, you must use three zeros instead of one after the leading backslash. If
25187 you do not, the octal digit that starts your string will be incorrectly
25188 interpreted as part of the code for the first character.
25189
25190 &*Warning 2*&: If there are characters in the strings that Perl interprets
25191 specially, you must use a Perl escape to prevent them being misinterpreted. For
25192 example, a command such as
25193 .code
25194 encode '\0user@domain.com\0pas$$word'
25195 .endd
25196 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25197
25198 If you have the &%mimencode%& command installed, another way to do produce
25199 base64-encoded strings is to run the command
25200 .code
25201 echo -e -n `\0user\0password' | mimencode
25202 .endd
25203 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25204 in the argument, and the &%-n%& option specifies no newline at the end of its
25205 output. However, not all versions of &%echo%& recognize these options, so you
25206 should check your version before relying on this suggestion.
25207
25208
25209
25210 .section "Authentication by an Exim client" "SECID170"
25211 .cindex "authentication" "on an Exim client"
25212 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25213 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25214 announces support for authentication, and the host matches an entry in either
25215 of these options, Exim (as a client) tries to authenticate as follows:
25216
25217 .ilist
25218 For each authenticator that is configured as a client, in the order in which
25219 they are defined in the configuration, it searches the authentication
25220 mechanisms announced by the server for one whose name matches the public name
25221 of the authenticator.
25222 .next
25223 .vindex "&$host$&"
25224 .vindex "&$host_address$&"
25225 When it finds one that matches, it runs the authenticator's client code. The
25226 variables &$host$& and &$host_address$& are available for any string expansions
25227 that the client might do. They are set to the server's name and IP address. If
25228 any expansion is forced to fail, the authentication attempt is abandoned, and
25229 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25230 delivery to be deferred.
25231 .next
25232 If the result of the authentication attempt is a temporary error or a timeout,
25233 Exim abandons trying to send the message to the host for the moment. It will
25234 try again later. If there are any backup hosts available, they are tried in the
25235 usual way.
25236 .next
25237 If the response to authentication is a permanent error (5&'xx'& code), Exim
25238 carries on searching the list of authenticators and tries another one if
25239 possible. If all authentication attempts give permanent errors, or if there are
25240 no attempts because no mechanisms match (or option expansions force failure),
25241 what happens depends on whether the host matches &%hosts_require_auth%& or
25242 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25243 delivery is deferred. The error can be detected in the retry rules, and thereby
25244 turned into a permanent error if you wish. In the second case, Exim tries to
25245 deliver the message unauthenticated.
25246 .endlist
25247
25248 .cindex "AUTH" "on MAIL command"
25249 When Exim has authenticated itself to a remote server, it adds the AUTH
25250 parameter to the MAIL commands it sends, if it has an authenticated sender for
25251 the message. If the message came from a remote host, the authenticated sender
25252 is the one that was receiving on an incoming MAIL command, provided that the
25253 incoming connection was authenticated and the &%server_mail_auth%& condition
25254 allowed the authenticated sender to be retained. If a local process calls Exim
25255 to send a message, the sender address that is built from the login name and
25256 &%qualify_domain%& is treated as authenticated. However, if the
25257 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25258 the authenticated sender that was received with the message.
25259 .ecindex IIDauthconf1
25260 .ecindex IIDauthconf2
25261
25262
25263
25264
25265
25266
25267 . ////////////////////////////////////////////////////////////////////////////
25268 . ////////////////////////////////////////////////////////////////////////////
25269
25270 .chapter "The plaintext authenticator" "CHAPplaintext"
25271 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25272 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25273 The &(plaintext)& authenticator can be configured to support the PLAIN and
25274 LOGIN authentication mechanisms, both of which transfer authentication data as
25275 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25276 security risk; you are strongly advised to insist on the use of SMTP encryption
25277 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25278 use unencrypted plain text, you should not use the same passwords for SMTP
25279 connections as you do for login accounts.
25280
25281 .section "Plaintext options" "SECID171"
25282 .cindex "options" "&(plaintext)& authenticator (server)"
25283 When configured as a server, &(plaintext)& uses the following options:
25284
25285 .option server_condition authenticators string&!! unset
25286 This is actually a global authentication option, but it must be set in order to
25287 configure the &(plaintext)& driver as a server. Its use is described below.
25288
25289 .option server_prompts plaintext string&!! unset
25290 The contents of this option, after expansion, must be a colon-separated list of
25291 prompt strings. If expansion fails, a temporary authentication rejection is
25292 given.
25293
25294 .section "Using plaintext in a server" "SECTplainserver"
25295 .cindex "AUTH" "in &(plaintext)& authenticator"
25296 .cindex "binary zero" "in &(plaintext)& authenticator"
25297 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25298         "in &(plaintext)& authenticator"
25299 .vindex "&$auth1$&, &$auth2$&, etc"
25300 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25301
25302 When running as a server, &(plaintext)& performs the authentication test by
25303 expanding a string. The data sent by the client with the AUTH command, or in
25304 response to subsequent prompts, is base64 encoded, and so may contain any byte
25305 values when decoded. If any data is supplied with the command, it is treated as
25306 a list of strings, separated by NULs (binary zeros), the first three of which
25307 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25308 (neither LOGIN nor PLAIN uses more than three strings).
25309
25310 For compatibility with previous releases of Exim, the values are also placed in
25311 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25312 variables for this purpose is now deprecated, as it can lead to confusion in
25313 string expansions that also use them for other things.
25314
25315 If there are more strings in &%server_prompts%& than the number of strings
25316 supplied with the AUTH command, the remaining prompts are used to obtain more
25317 data. Each response from the client may be a list of NUL-separated strings.
25318
25319 .vindex "&$authenticated_id$&"
25320 Once a sufficient number of data strings have been received,
25321 &%server_condition%& is expanded. If the expansion is forced to fail,
25322 authentication fails. Any other expansion failure causes a temporary error code
25323 to be returned. If the result of a successful expansion is an empty string,
25324 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25325 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25326 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25327 For any other result, a temporary error code is returned, with the expanded
25328 string as the error text
25329
25330 &*Warning*&: If you use a lookup in the expansion to find the user's
25331 password, be sure to make the authentication fail if the user is unknown.
25332 There are good and bad examples at the end of the next section.
25333
25334
25335
25336 .section "The PLAIN authentication mechanism" "SECID172"
25337 .cindex "PLAIN authentication mechanism"
25338 .cindex "authentication" "PLAIN mechanism"
25339 .cindex "binary zero" "in &(plaintext)& authenticator"
25340 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25341 sent as one item of data (that is, one combined string containing two NUL
25342 separators). The data is sent either as part of the AUTH command, or
25343 subsequently in response to an empty prompt from the server.
25344
25345 The second and third strings are a user name and a corresponding password.
25346 Using a single fixed user name and password as an example, this could be
25347 configured as follows:
25348 .code
25349 fixed_plain:
25350   driver = plaintext
25351   public_name = PLAIN
25352   server_prompts = :
25353   server_condition = \
25354     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25355   server_set_id = $auth2
25356 .endd
25357 Note that the default result strings from &%if%& (&"true"& or an empty string)
25358 are exactly what we want here, so they need not be specified. Obviously, if the
25359 password contains expansion-significant characters such as dollar, backslash,
25360 or closing brace, they have to be escaped.
25361
25362 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25363 the end of a string list are ignored). If all the data comes as part of the
25364 AUTH command, as is commonly the case, the prompt is not used. This
25365 authenticator is advertised in the response to EHLO as
25366 .code
25367 250-AUTH PLAIN
25368 .endd
25369 and a client host can authenticate itself by sending the command
25370 .code
25371 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25372 .endd
25373 As this contains three strings (more than the number of prompts), no further
25374 data is required from the client. Alternatively, the client may just send
25375 .code
25376 AUTH PLAIN
25377 .endd
25378 to initiate authentication, in which case the server replies with an empty
25379 prompt. The client must respond with the combined data string.
25380
25381 The data string is base64 encoded, as required by the RFC. This example,
25382 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25383 represents a zero byte. This is split up into three strings, the first of which
25384 is empty. The &%server_condition%& option in the authenticator checks that the
25385 second two are &`username`& and &`mysecret`& respectively.
25386
25387 Having just one fixed user name and password, as in this example, is not very
25388 realistic, though for a small organization with only a handful of
25389 authenticating clients it could make sense.
25390
25391 A more sophisticated instance of this authenticator could use the user name in
25392 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25393 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25394 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25395 This is an incorrect example:
25396 .code
25397 server_condition = \
25398   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25399 .endd
25400 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25401 which it then compares to the supplied password (&$auth3$&). Why is this example
25402 incorrect? It works fine for existing users, but consider what happens if a
25403 non-existent user name is given. The lookup fails, but as no success/failure
25404 strings are given for the lookup, it yields an empty string. Thus, to defeat
25405 the authentication, all a client has to do is to supply a non-existent user
25406 name and an empty password. The correct way of writing this test is:
25407 .code
25408 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25409   {${if eq{$value}{$auth3}}} {false}}
25410 .endd
25411 In this case, if the lookup succeeds, the result is checked; if the lookup
25412 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25413 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25414 always fails if its second argument is empty. However, the second way of
25415 writing the test makes the logic clearer.
25416
25417
25418 .section "The LOGIN authentication mechanism" "SECID173"
25419 .cindex "LOGIN authentication mechanism"
25420 .cindex "authentication" "LOGIN mechanism"
25421 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25422 in a number of programs. No data is sent with the AUTH command. Instead, a
25423 user name and password are supplied separately, in response to prompts. The
25424 plaintext authenticator can be configured to support this as in this example:
25425 .code
25426 fixed_login:
25427   driver = plaintext
25428   public_name = LOGIN
25429   server_prompts = User Name : Password
25430   server_condition = \
25431     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25432   server_set_id = $auth1
25433 .endd
25434 Because of the way plaintext operates, this authenticator accepts data supplied
25435 with the AUTH command (in contravention of the specification of LOGIN), but
25436 if the client does not supply it (as is the case for LOGIN clients), the prompt
25437 strings are used to obtain two data items.
25438
25439 Some clients are very particular about the precise text of the prompts. For
25440 example, Outlook Express is reported to recognize only &"Username:"& and
25441 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25442 strings. It uses the &%ldapauth%& expansion condition to check the user
25443 name and password by binding to an LDAP server:
25444 .code
25445 login:
25446   driver = plaintext
25447   public_name = LOGIN
25448   server_prompts = Username:: : Password::
25449   server_condition = ${if and{{ \
25450     !eq{}{$auth1} }{ \
25451     ldapauth{\
25452       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25453       pass=${quote:$auth2} \
25454       ldap://ldap.example.org/} }} }
25455   server_set_id = uid=$auth1,ou=people,o=example.org
25456 .endd
25457 We have to check that the username is not empty before using it, because LDAP
25458 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25459 operator to correctly quote the DN for authentication. However, the basic
25460 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25461 correct one to use for the password, because quoting is needed only to make
25462 the password conform to the Exim syntax. At the LDAP level, the password is an
25463 uninterpreted string.
25464
25465
25466 .section "Support for different kinds of authentication" "SECID174"
25467 A number of string expansion features are provided for the purpose of
25468 interfacing to different ways of user authentication. These include checking
25469 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25470 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25471 &<<SECTexpcond>>&.
25472
25473
25474
25475
25476 .section "Using plaintext in a client" "SECID175"
25477 .cindex "options" "&(plaintext)& authenticator (client)"
25478 The &(plaintext)& authenticator has two client options:
25479
25480 .option client_ignore_invalid_base64 plaintext boolean false
25481 If the client receives a server prompt that is not a valid base64 string,
25482 authentication is abandoned by default. However, if this option is set true,
25483 the error in the challenge is ignored and the client sends the response as
25484 usual.
25485
25486 .option client_send plaintext string&!! unset
25487 The string is a colon-separated list of authentication data strings. Each
25488 string is independently expanded before being sent to the server. The first
25489 string is sent with the AUTH command; any more strings are sent in response
25490 to prompts from the server. Before each string is expanded, the value of the
25491 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25492 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25493 way. Thus, the prompt that is received in response to sending the first string
25494 (with the AUTH command) can be used in the expansion of the second string, and
25495 so on. If an invalid base64 string is received when
25496 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25497 &$auth$&<&'n'&> variable.
25498
25499 &*Note*&: You cannot use expansion to create multiple strings, because
25500 splitting takes priority and happens first.
25501
25502 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25503 the data, further processing is applied to each string before it is sent. If
25504 there are any single circumflex characters in the string, they are converted to
25505 NULs. Should an actual circumflex be required as data, it must be doubled in
25506 the string.
25507
25508 This is an example of a client configuration that implements the PLAIN
25509 authentication mechanism with a fixed user name and password:
25510 .code
25511 fixed_plain:
25512   driver = plaintext
25513   public_name = PLAIN
25514   client_send = ^username^mysecret
25515 .endd
25516 The lack of colons means that the entire text is sent with the AUTH
25517 command, with the circumflex characters converted to NULs. A similar example
25518 that uses the LOGIN mechanism is:
25519 .code
25520 fixed_login:
25521   driver = plaintext
25522   public_name = LOGIN
25523   client_send = : username : mysecret
25524 .endd
25525 The initial colon means that the first string is empty, so no data is sent with
25526 the AUTH command itself. The remaining strings are sent in response to
25527 prompts.
25528 .ecindex IIDplaiauth1
25529 .ecindex IIDplaiauth2
25530
25531
25532
25533
25534 . ////////////////////////////////////////////////////////////////////////////
25535 . ////////////////////////////////////////////////////////////////////////////
25536
25537 .chapter "The cram_md5 authenticator" "CHID9"
25538 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25539 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25540 .cindex "CRAM-MD5 authentication mechanism"
25541 .cindex "authentication" "CRAM-MD5 mechanism"
25542 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25543 sends a challenge string to the client, and the response consists of a user
25544 name and the CRAM-MD5 digest of the challenge string combined with a secret
25545 string (password) which is known to both server and client. Thus, the secret
25546 is not sent over the network as plain text, which makes this authenticator more
25547 secure than &(plaintext)&. However, the downside is that the secret has to be
25548 available in plain text at either end.
25549
25550
25551 .section "Using cram_md5 as a server" "SECID176"
25552 .cindex "options" "&(cram_md5)& authenticator (server)"
25553 This authenticator has one server option, which must be set to configure the
25554 authenticator as a server:
25555
25556 .option server_secret cram_md5 string&!! unset
25557 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25558 When the server receives the client's response, the user name is placed in
25559 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25560 obtain the password for that user. The server then computes the CRAM-MD5 digest
25561 that the client should have sent, and checks that it received the correct
25562 string. If the expansion of &%server_secret%& is forced to fail, authentication
25563 fails. If the expansion fails for some other reason, a temporary error code is
25564 returned to the client.
25565
25566 For compatibility with previous releases of Exim, the user name is also placed
25567 in &$1$&. However, the use of this variables for this purpose is now
25568 deprecated, as it can lead to confusion in string expansions that also use
25569 numeric variables for other things.
25570
25571 For example, the following authenticator checks that the user name given by the
25572 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25573 user name, authentication fails.
25574 .code
25575 fixed_cram:
25576   driver = cram_md5
25577   public_name = CRAM-MD5
25578   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25579   server_set_id = $auth1
25580 .endd
25581 .vindex "&$authenticated_id$&"
25582 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25583 name in &$authenticated_id$&. A more typical configuration might look up the
25584 secret string in a file, using the user name as the key. For example:
25585 .code
25586 lookup_cram:
25587   driver = cram_md5
25588   public_name = CRAM-MD5
25589   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25590                   {$value}fail}
25591   server_set_id = $auth1
25592 .endd
25593 Note that this expansion explicitly forces failure if the lookup fails
25594 because &$auth1$& contains an unknown user name.
25595
25596 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25597 using the relevant libraries, you need to know the realm to specify in the
25598 lookup and then ask for the &"userPassword"& attribute for that user in that
25599 realm, with:
25600 .code
25601 cyrusless_crammd5:
25602   driver = cram_md5
25603   public_name = CRAM-MD5
25604   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25605                   dbmjz{/etc/sasldb2}}
25606   server_set_id = $auth1
25607 .endd
25608
25609 .section "Using cram_md5 as a client" "SECID177"
25610 .cindex "options" "&(cram_md5)& authenticator (client)"
25611 When used as a client, the &(cram_md5)& authenticator has two options:
25612
25613
25614
25615 .option client_name cram_md5 string&!! "the primary host name"
25616 This string is expanded, and the result used as the user name data when
25617 computing the response to the server's challenge.
25618
25619
25620 .option client_secret cram_md5 string&!! unset
25621 This option must be set for the authenticator to work as a client. Its value is
25622 expanded and the result used as the secret string when computing the response.
25623
25624
25625 .vindex "&$host$&"
25626 .vindex "&$host_address$&"
25627 Different user names and secrets can be used for different servers by referring
25628 to &$host$& or &$host_address$& in the options. Forced failure of either
25629 expansion string is treated as an indication that this authenticator is not
25630 prepared to handle this case. Exim moves on to the next configured client
25631 authenticator. Any other expansion failure causes Exim to give up trying to
25632 send the message to the current server.
25633
25634 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25635 strings, is:
25636 .code
25637 fixed_cram:
25638   driver = cram_md5
25639   public_name = CRAM-MD5
25640   client_name = ph10
25641   client_secret = secret
25642 .endd
25643 .ecindex IIDcramauth1
25644 .ecindex IIDcramauth2
25645
25646
25647
25648 . ////////////////////////////////////////////////////////////////////////////
25649 . ////////////////////////////////////////////////////////////////////////////
25650
25651 .chapter "The cyrus_sasl authenticator" "CHID10"
25652 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25653 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25654 .cindex "Cyrus" "SASL library"
25655 .cindex "Kerberos"
25656 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25657 Digital Ltd (&url(http://www.aldigital.co.uk)).
25658
25659 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25660 library implementation of the RFC 2222 (&"Simple Authentication and Security
25661 Layer"&). This library supports a number of authentication mechanisms,
25662 including PLAIN and LOGIN, but also several others that Exim does not support
25663 directly. In particular, there is support for Kerberos authentication.
25664
25665 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25666 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25667 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25668 name of the driver to determine which mechanism to support.
25669
25670 Where access to some kind of secret file is required, for example in GSSAPI
25671 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25672 user, and that the Cyrus SASL library has no way of escalating privileges
25673 by default. You may also find you need to set environment variables,
25674 depending on the driver you are using.
25675
25676 The application name provided by Exim is &"exim"&, so various SASL options may
25677 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25678 Kerberos, note that because of limitations in the GSSAPI interface,
25679 changing the server keytab might need to be communicated down to the Kerberos
25680 layer independently. The mechanism for doing so is dependent upon the Kerberos
25681 implementation.
25682
25683 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25684 may be set to point to an alternative keytab file. Exim will pass this
25685 variable through from its own inherited environment when started as root or the
25686 Exim user. The keytab file needs to be readable by the Exim user.
25687 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25688 environment variable.  In practice, for those releases, the Cyrus authenticator
25689 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25690 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25691
25692
25693 .section "Using cyrus_sasl as a server" "SECID178"
25694 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25695 (on a successful authentication) into &$auth1$&. For compatibility with
25696 previous releases of Exim, the username is also placed in &$1$&. However, the
25697 use of this variable for this purpose is now deprecated, as it can lead to
25698 confusion in string expansions that also use numeric variables for other
25699 things.
25700
25701
25702 .option server_hostname cyrus_sasl string&!! "see below"
25703 This option selects the hostname that is used when communicating with the
25704 library. The default value is &`$primary_hostname`&. It is up to the underlying
25705 SASL plug-in what it does with this data.
25706
25707
25708 .option server_mech cyrus_sasl string "see below"
25709 This option selects the authentication mechanism this driver should use. The
25710 default is the value of the generic &%public_name%& option. This option allows
25711 you to use a different underlying mechanism from the advertised name. For
25712 example:
25713 .code
25714 sasl:
25715   driver = cyrus_sasl
25716   public_name = X-ANYTHING
25717   server_mech = CRAM-MD5
25718   server_set_id = $auth1
25719 .endd
25720
25721 .option server_realm cyrus_sasl string&!! unset
25722 This specifies the SASL realm that the server claims to be in.
25723
25724
25725 .option server_service cyrus_sasl string &`smtp`&
25726 This is the SASL service that the server claims to implement.
25727
25728
25729 For straightforward cases, you do not need to set any of the authenticator's
25730 private options. All you need to do is to specify an appropriate mechanism as
25731 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25732 PLAIN, you could have two authenticators as follows:
25733 .code
25734 sasl_cram_md5:
25735   driver = cyrus_sasl
25736   public_name = CRAM-MD5
25737   server_set_id = $auth1
25738
25739 sasl_plain:
25740   driver = cyrus_sasl
25741   public_name = PLAIN
25742   server_set_id = $auth2
25743 .endd
25744 Cyrus SASL does implement the LOGIN authentication method, even though it is
25745 not a standard method. It is disabled by default in the source distribution,
25746 but it is present in many binary distributions.
25747 .ecindex IIDcyrauth1
25748 .ecindex IIDcyrauth2
25749
25750
25751
25752
25753 . ////////////////////////////////////////////////////////////////////////////
25754 . ////////////////////////////////////////////////////////////////////////////
25755 .chapter "The dovecot authenticator" "CHAPdovecot"
25756 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25757 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25758 This authenticator is an interface to the authentication facility of the
25759 Dovecot POP/IMAP server, which can support a number of authentication methods.
25760 Note that Dovecot must be configured to use auth-client not auth-userdb.
25761 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25762 to use the same mechanisms for SMTP authentication. This is a server
25763 authenticator only. There is only one option:
25764
25765 .option server_socket dovecot string unset
25766
25767 This option must specify the socket that is the interface to Dovecot
25768 authentication. The &%public_name%& option must specify an authentication
25769 mechanism that Dovecot is configured to support. You can have several
25770 authenticators for different mechanisms. For example:
25771 .code
25772 dovecot_plain:
25773   driver = dovecot
25774   public_name = PLAIN
25775   server_socket = /var/run/dovecot/auth-client
25776   server_set_id = $auth1
25777
25778 dovecot_ntlm:
25779   driver = dovecot
25780   public_name = NTLM
25781   server_socket = /var/run/dovecot/auth-client
25782   server_set_id = $auth1
25783 .endd
25784 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25785 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25786 option is passed in the Dovecot authentication command. If, for a TLS
25787 connection, a client certificate has been verified, the &"valid-client-cert"&
25788 option is passed. When authentication succeeds, the identity of the user
25789 who authenticated is placed in &$auth1$&.
25790 .ecindex IIDdcotauth1
25791 .ecindex IIDdcotauth2
25792
25793
25794 . ////////////////////////////////////////////////////////////////////////////
25795 . ////////////////////////////////////////////////////////////////////////////
25796 .chapter "The gsasl authenticator" "CHAPgsasl"
25797 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25798 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25799 .cindex "authentication" "GNU SASL"
25800 .cindex "authentication" "SASL"
25801 .cindex "authentication" "EXTERNAL"
25802 .cindex "authentication" "ANONYMOUS"
25803 .cindex "authentication" "PLAIN"
25804 .cindex "authentication" "LOGIN"
25805 .cindex "authentication" "DIGEST-MD5"
25806 .cindex "authentication" "CRAM-MD5"
25807 .cindex "authentication" "SCRAM-SHA-1"
25808 The &(gsasl)& authenticator provides server integration for the GNU SASL
25809 library and the mechanisms it provides.  This is new as of the 4.80 release
25810 and there are a few areas where the library does not let Exim smoothly
25811 scale to handle future authentication mechanisms, so no guarantee can be
25812 made that any particular new authentication mechanism will be supported
25813 without code changes in Exim.
25814
25815
25816 .option server_channelbinding gsasl boolean false
25817 Some authentication mechanisms are able to use external context at both ends
25818 of the session to bind the authentication to that context, and fail the
25819 authentication process if that context differs.  Specifically, some TLS
25820 ciphersuites can provide identifying information about the cryptographic
25821 context.
25822
25823 This means that certificate identity and verification becomes a non-issue,
25824 as a man-in-the-middle attack will cause the correct client and server to
25825 see different identifiers and authentication will fail.
25826
25827 This is currently only supported when using the GnuTLS library.  This is
25828 only usable by mechanisms which support "channel binding"; at time of
25829 writing, that's the SCRAM family.
25830
25831 This defaults off to ensure smooth upgrade across Exim releases, in case
25832 this option causes some clients to start failing.  Some future release
25833 of Exim may switch the default to be true.
25834
25835
25836 .option server_hostname gsasl string&!! "see below"
25837 This option selects the hostname that is used when communicating with the
25838 library. The default value is &`$primary_hostname`&.
25839 Some mechanisms will use this data.
25840
25841
25842 .option server_mech gsasl string "see below"
25843 This option selects the authentication mechanism this driver should use. The
25844 default is the value of the generic &%public_name%& option. This option allows
25845 you to use a different underlying mechanism from the advertised name. For
25846 example:
25847 .code
25848 sasl:
25849   driver = gsasl
25850   public_name = X-ANYTHING
25851   server_mech = CRAM-MD5
25852   server_set_id = $auth1
25853 .endd
25854
25855
25856 .option server_password gsasl string&!! unset
25857 Various mechanisms need access to the cleartext password on the server, so
25858 that proof-of-possession can be demonstrated on the wire, without sending
25859 the password itself.
25860
25861 The data available for lookup varies per mechanism.
25862 In all cases, &$auth1$& is set to the &'authentication id'&.
25863 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25864 if available, else the empty string.
25865 The &$auth3$& variable will always be the &'realm'& if available,
25866 else the empty string.
25867
25868 A forced failure will cause authentication to defer.
25869
25870 If using this option, it may make sense to set the &%server_condition%&
25871 option to be simply "true".
25872
25873
25874 .option server_realm gsasl string&!! unset
25875 This specifies the SASL realm that the server claims to be in.
25876 Some mechanisms will use this data.
25877
25878
25879 .option server_scram_iter gsasl string&!! unset
25880 This option provides data for the SCRAM family of mechanisms.
25881 &$auth1$& is not available at evaluation time.
25882 (This may change, as we receive feedback on use)
25883
25884
25885 .option server_scram_salt gsasl string&!! unset
25886 This option provides data for the SCRAM family of mechanisms.
25887 &$auth1$& is not available at evaluation time.
25888 (This may change, as we receive feedback on use)
25889
25890
25891 .option server_service gsasl string &`smtp`&
25892 This is the SASL service that the server claims to implement.
25893 Some mechanisms will use this data.
25894
25895
25896 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25897 .vindex "&$auth1$&, &$auth2$&, etc"
25898 These may be set when evaluating specific options, as detailed above.
25899 They will also be set when evaluating &%server_condition%&.
25900
25901 Unless otherwise stated below, the &(gsasl)& integration will use the following
25902 meanings for these variables:
25903
25904 .ilist
25905 .vindex "&$auth1$&"
25906 &$auth1$&: the &'authentication id'&
25907 .next
25908 .vindex "&$auth2$&"
25909 &$auth2$&: the &'authorization id'&
25910 .next
25911 .vindex "&$auth3$&"
25912 &$auth3$&: the &'realm'&
25913 .endlist
25914
25915 On a per-mechanism basis:
25916
25917 .ilist
25918 .cindex "authentication" "EXTERNAL"
25919 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25920 the &%server_condition%& option must be present.
25921 .next
25922 .cindex "authentication" "ANONYMOUS"
25923 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25924 the &%server_condition%& option must be present.
25925 .next
25926 .cindex "authentication" "GSSAPI"
25927 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25928 &$auth2$& will be set to the &'authorization id'&,
25929 the &%server_condition%& option must be present.
25930 .endlist
25931
25932 An &'anonymous token'& is something passed along as an unauthenticated
25933 identifier; this is analogous to FTP anonymous authentication passing an
25934 email address, or software-identifier@, as the "password".
25935
25936
25937 An example showing the password having the realm specified in the callback
25938 and demonstrating a Cyrus SASL to GSASL migration approach is:
25939 .code
25940 gsasl_cyrusless_crammd5:
25941   driver = gsasl
25942   public_name = CRAM-MD5
25943   server_realm = imap.example.org
25944   server_password = ${lookup{$auth1:$auth3:userPassword}\
25945                     dbmjz{/etc/sasldb2}{$value}fail}
25946   server_set_id = ${quote:$auth1}
25947   server_condition = yes
25948 .endd
25949
25950
25951 . ////////////////////////////////////////////////////////////////////////////
25952 . ////////////////////////////////////////////////////////////////////////////
25953
25954 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25955 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25956 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25957 .cindex "authentication" "GSSAPI"
25958 .cindex "authentication" "Kerberos"
25959 The &(heimdal_gssapi)& authenticator provides server integration for the
25960 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25961 reliably.
25962
25963 .option server_hostname heimdal_gssapi string&!! "see below"
25964 This option selects the hostname that is used, with &%server_service%&,
25965 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25966 identifier.  The default value is &`$primary_hostname`&.
25967
25968 .option server_keytab heimdal_gssapi string&!! unset
25969 If set, then Heimdal will not use the system default keytab (typically
25970 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25971 The value should be a pathname, with no &"file:"& prefix.
25972
25973 .option server_service heimdal_gssapi string&!! "smtp"
25974 This option specifies the service identifier used, in conjunction with
25975 &%server_hostname%&, for building the identifer for finding credentials
25976 from the keytab.
25977
25978
25979 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25980 Beware that these variables will typically include a realm, thus will appear
25981 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25982 not verified, so a malicious client can set it to anything.
25983
25984 The &$auth1$& field should be safely trustable as a value from the Key
25985 Distribution Center.  Note that these are not quite email addresses.
25986 Each identifier is for a role, and so the left-hand-side may include a
25987 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25988
25989 .vindex "&$auth1$&, &$auth2$&, etc"
25990 .ilist
25991 .vindex "&$auth1$&"
25992 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25993 .next
25994 .vindex "&$auth2$&"
25995 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25996 authentication.  If that was empty, this will also be set to the
25997 GSS Display Name.
25998 .endlist
25999
26000
26001 . ////////////////////////////////////////////////////////////////////////////
26002 . ////////////////////////////////////////////////////////////////////////////
26003
26004 .chapter "The spa authenticator" "CHAPspa"
26005 .scindex IIDspaauth1 "&(spa)& authenticator"
26006 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26007 .cindex "authentication" "Microsoft Secure Password"
26008 .cindex "authentication" "NTLM"
26009 .cindex "Microsoft Secure Password Authentication"
26010 .cindex "NTLM authentication"
26011 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26012 Password Authentication'& mechanism,
26013 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26014 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26015 taken from the Samba project (&url(http://www.samba.org)). The code for the
26016 server side was subsequently contributed by Tom Kistner. The mechanism works as
26017 follows:
26018
26019 .ilist
26020 After the AUTH command has been accepted, the client sends an SPA
26021 authentication request based on the user name and optional domain.
26022 .next
26023 The server sends back a challenge.
26024 .next
26025 The client builds a challenge response which makes use of the user's password
26026 and sends it to the server, which then accepts or rejects it.
26027 .endlist
26028
26029 Encryption is used to protect the password in transit.
26030
26031
26032
26033 .section "Using spa as a server" "SECID179"
26034 .cindex "options" "&(spa)& authenticator (server)"
26035 The &(spa)& authenticator has just one server option:
26036
26037 .option server_password spa string&!! unset
26038 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26039 This option is expanded, and the result must be the cleartext password for the
26040 authenticating user, whose name is at this point in &$auth1$&. For
26041 compatibility with previous releases of Exim, the user name is also placed in
26042 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26043 it can lead to confusion in string expansions that also use numeric variables
26044 for other things. For example:
26045 .code
26046 spa:
26047   driver = spa
26048   public_name = NTLM
26049   server_password = \
26050     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26051 .endd
26052 If the expansion is forced to fail, authentication fails. Any other expansion
26053 failure causes a temporary error code to be returned.
26054
26055
26056
26057
26058
26059 .section "Using spa as a client" "SECID180"
26060 .cindex "options" "&(spa)& authenticator (client)"
26061 The &(spa)& authenticator has the following client options:
26062
26063
26064
26065 .option client_domain spa string&!! unset
26066 This option specifies an optional domain for the authentication.
26067
26068
26069 .option client_password spa string&!! unset
26070 This option specifies the user's password, and must be set.
26071
26072
26073 .option client_username spa string&!! unset
26074 This option specifies the user name, and must be set. Here is an example of a
26075 configuration of this authenticator for use with the mail servers at
26076 &'msn.com'&:
26077 .code
26078 msn:
26079   driver = spa
26080   public_name = MSN
26081   client_username = msn/msn_username
26082   client_password = msn_plaintext_password
26083   client_domain = DOMAIN_OR_UNSET
26084 .endd
26085 .ecindex IIDspaauth1
26086 .ecindex IIDspaauth2
26087
26088
26089
26090
26091
26092 . ////////////////////////////////////////////////////////////////////////////
26093 . ////////////////////////////////////////////////////////////////////////////
26094
26095 .new
26096 .chapter "The tls authenticator" "CHAPtlsauth"
26097 .scindex IIDtlsauth1 "&(tls)& authenticator"
26098 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26099 .cindex "authentication" "Client Certificate"
26100 .cindex "authentication" "X509"
26101 .cindex "Certificate-based authentication"
26102 The &(tls)& authenticator provides server support for
26103 authentication based on client certificates.
26104
26105 It is not an SMTP authentication mechanism and is not
26106 advertised by the server as part of the SMTP EHLO response.
26107 It is an Exim authenticator in the sense that it affects
26108 the protocol element of the log line, can be tested for
26109 by the &%authenticated%& ACL condition, and can set
26110 the &$authenticated_id$& variable.
26111
26112 The client must present a verifiable certificate,
26113 for which it must have been requested via the
26114 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26115 (see &<<CHAPTLS>>&).
26116
26117 If an authenticator of this type is configured it is
26118 run before any SMTP-level communication is done,
26119 and can authenticate the connection.
26120 If it does, SMTP suthentication is not offered.
26121
26122 A maximum of one authenticator of this type may be present.
26123
26124
26125 .cindex "options" "&(tls)& authenticator (server)"
26126 The &(tls)& authenticator has three server options:
26127
26128 .option server_param1 tls string&!! unset
26129 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26130 This option is expanded after the TLS negotiation and
26131 the result is placed in &$auth1$&.
26132 If the expansion is forced to fail, authentication fails. Any other expansion
26133 failure causes a temporary error code to be returned.
26134
26135 .option server_param2 tls string&!! unset
26136 .option server_param3 tls string&!! unset
26137 As above, for &$auth2$& and &$auth3$&.
26138
26139 &%server_param1%& may also be spelled &%server_param%&.
26140
26141
26142 Example:
26143 .code
26144 tls:
26145   driver = tls
26146   server_param1 =     ${certextract {subj_altname,mail,>:} \
26147                                     {$tls_in_peercert}}
26148   server_condition =  ${if forany {$auth1} \
26149                             {!= {0} \
26150                                 {${lookup ldap{ldap:///\
26151                          mailname=${quote_ldap_dn:${lc:$item}},\
26152                          ou=users,LDAP_DC?mailid} {$value}{0} \
26153                        }    }   } }
26154   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26155 .endd
26156 .ecindex IIDtlsauth1
26157 .ecindex IIDtlsauth2
26158 .wen
26159
26160
26161 Note that because authentication is traditionally an SMTP operation,
26162 the &%authenticated%& ACL condition cannot be used in
26163 a connect- or helo-ACL.
26164
26165
26166
26167 . ////////////////////////////////////////////////////////////////////////////
26168 . ////////////////////////////////////////////////////////////////////////////
26169
26170 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26171          "Encrypted SMTP connections"
26172 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26173 .scindex IIDencsmtp2 "SMTP" "encryption"
26174 .cindex "TLS" "on SMTP connection"
26175 .cindex "OpenSSL"
26176 .cindex "GnuTLS"
26177 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26178 Sockets Layer), is implemented by making use of the OpenSSL library or the
26179 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26180 cryptographic code in the Exim distribution itself for implementing TLS. In
26181 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26182 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26183 You also need to understand the basic concepts of encryption at a managerial
26184 level, and in particular, the way that public keys, private keys, and
26185 certificates are used.
26186
26187 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26188 connection is established, the client issues a STARTTLS command. If the
26189 server accepts this, the client and the server negotiate an encryption
26190 mechanism. If the negotiation succeeds, the data that subsequently passes
26191 between them is encrypted.
26192
26193 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26194 and if so, what cipher suite is in use, whether the client supplied a
26195 certificate, and whether or not that certificate was verified. This makes it
26196 possible for an Exim server to deny or accept certain commands based on the
26197 encryption state.
26198
26199 &*Warning*&: Certain types of firewall and certain anti-virus products can
26200 disrupt TLS connections. You need to turn off SMTP scanning for these products
26201 in order to get TLS to work.
26202
26203
26204
26205 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26206          "SECID284"
26207 .cindex "ssmtp protocol"
26208 .cindex "smtps protocol"
26209 .cindex "SMTP" "ssmtp protocol"
26210 .cindex "SMTP" "smtps protocol"
26211 Early implementations of encrypted SMTP used a different TCP port from normal
26212 SMTP, and expected an encryption negotiation to start immediately, instead of
26213 waiting for a STARTTLS command from the client using the standard SMTP
26214 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26215 allocated for this purpose.
26216
26217 This approach was abandoned when encrypted SMTP was standardized, but there are
26218 still some legacy clients that use it. Exim supports these clients by means of
26219 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26220 numbers; the most common use is expected to be:
26221 .code
26222 tls_on_connect_ports = 465
26223 .endd
26224 The port numbers specified by this option apply to all SMTP connections, both
26225 via the daemon and via &'inetd'&. You still need to specify all the ports that
26226 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26227 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26228 an extra port &-- rather, it specifies different behaviour on a port that is
26229 defined elsewhere.
26230
26231 There is also a &%-tls-on-connect%& command line option. This overrides
26232 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26233
26234
26235
26236
26237
26238
26239 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26240 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26241 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26242 followed later, when the first versions of GnuTLS were released. To build Exim
26243 to use GnuTLS, you need to set
26244 .code
26245 USE_GNUTLS=yes
26246 .endd
26247 in Local/Makefile, in addition to
26248 .code
26249 SUPPORT_TLS=yes
26250 .endd
26251 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26252 include files and libraries for GnuTLS can be found.
26253
26254 There are some differences in usage when using GnuTLS instead of OpenSSL:
26255
26256 .ilist
26257 The &%tls_verify_certificates%& option
26258 cannot be the path of a directory
26259 for GnuTLS versions before 3.3.6
26260 (for later versions, or OpenSSL, it can be either).
26261 .next
26262 The default value for &%tls_dhparam%& differs for historical reasons.
26263 .next
26264 .vindex "&$tls_in_peerdn$&"
26265 .vindex "&$tls_out_peerdn$&"
26266 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26267 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26268 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26269 .next
26270 OpenSSL identifies cipher suites using hyphens as separators, for example:
26271 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26272 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26273 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26274 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26275 to handle its own older variants) when processing lists of cipher suites in the
26276 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26277 option).
26278 .next
26279 The &%tls_require_ciphers%& options operate differently, as described in the
26280 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26281 .next
26282 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26283 When using OpenSSL, this option is ignored.
26284 (If an API is found to let OpenSSL be configured in this way,
26285 let the Exim Maintainers know and we'll likely use it).
26286 .next
26287 Some other recently added features may only be available in one or the other.
26288 This should be documented with the feature.  If the documentation does not
26289 explicitly state that the feature is infeasible in the other TLS
26290 implementation, then patches are welcome.
26291 .endlist
26292
26293
26294 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26295 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26296 an explicit path; if the latter, then the text about generation still applies,
26297 but not the chosen filename.
26298 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26299 See the documentation of &%tls_dhparam%& for more information.
26300
26301 GnuTLS uses D-H parameters that may take a substantial amount of time
26302 to compute. It is unreasonable to re-compute them for every TLS session.
26303 Therefore, Exim keeps this data in a file in its spool directory, called
26304 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26305 of bits requested.
26306 The file is owned by the Exim user and is readable only by
26307 its owner. Every Exim process that start up GnuTLS reads the D-H
26308 parameters from this file. If the file does not exist, the first Exim process
26309 that needs it computes the data and writes it to a temporary file which is
26310 renamed once it is complete. It does not matter if several Exim processes do
26311 this simultaneously (apart from wasting a few resources). Once a file is in
26312 place, new Exim processes immediately start using it.
26313
26314 For maximum security, the parameters that are stored in this file should be
26315 recalculated periodically, the frequency depending on your paranoia level.
26316 If you are avoiding using the fixed D-H primes published in RFCs, then you
26317 are concerned about some advanced attacks and will wish to do this; if you do
26318 not regenerate then you might as well stick to the standard primes.
26319
26320 Arranging this is easy in principle; just delete the file when you want new
26321 values to be computed. However, there may be a problem. The calculation of new
26322 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26323 If the system is not very active, &_/dev/random_& may delay returning data
26324 until enough randomness (entropy) is available. This may cause Exim to hang for
26325 a substantial amount of time, causing timeouts on incoming connections.
26326
26327 The solution is to generate the parameters externally to Exim. They are stored
26328 in &_gnutls-params-N_& in PEM format, which means that they can be
26329 generated externally using the &(certtool)& command that is part of GnuTLS.
26330
26331 To replace the parameters with new ones, instead of deleting the file
26332 and letting Exim re-create it, you can generate new parameters using
26333 &(certtool)& and, when this has been done, replace Exim's cache file by
26334 renaming. The relevant commands are something like this:
26335 .code
26336 # ls
26337 [ look for file; assume gnutls-params-2236 is the most recent ]
26338 # rm -f new-params
26339 # touch new-params
26340 # chown exim:exim new-params
26341 # chmod 0600 new-params
26342 # certtool --generate-dh-params --bits 2236 >>new-params
26343 # openssl dhparam -noout -text -in new-params | head
26344 [ check the first line, make sure it's not more than 2236;
26345   if it is, then go back to the start ("rm") and repeat
26346   until the size generated is at most the size requested ]
26347 # chmod 0400 new-params
26348 # mv new-params gnutls-params-2236
26349 .endd
26350 If Exim never has to generate the parameters itself, the possibility of
26351 stalling is removed.
26352
26353 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26354 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26355 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26356 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26357 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26358 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26359 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26360 which applies to all D-H usage, client or server.  If the value returned by
26361 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26362 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26363 limit, which is still much higher than Exim historically used.
26364
26365 The filename and bits used will change as the GnuTLS maintainers change the
26366 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26367 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26368 2432 bits, while NSS is limited to 2236 bits.
26369
26370 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26371 increase the chance of the generated prime actually being within acceptable
26372 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26373 procedure above.  There is no sane procedure available to Exim to double-check
26374 the size of the generated prime, so it might still be too large.
26375
26376
26377 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26378 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26379 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26380 There is a function in the OpenSSL library that can be passed a list of cipher
26381 suites before the cipher negotiation takes place. This specifies which ciphers
26382 are acceptable. The list is colon separated and may contain names like
26383 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26384 directly to this function call.
26385 Many systems will install the OpenSSL manual-pages, so you may have
26386 &'ciphers(1)'& available to you.
26387 The following quotation from the OpenSSL
26388 documentation specifies what forms of item are allowed in the cipher string:
26389
26390 .ilist
26391 It can consist of a single cipher suite such as RC4-SHA.
26392 .next
26393 It can represent a list of cipher suites containing a certain algorithm,
26394 or cipher suites of a certain type. For example SHA1 represents all
26395 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26396 SSL v3 algorithms.
26397 .next
26398 Lists of cipher suites can be combined in a single cipher string using
26399 the + character. This is used as a logical and operation. For example
26400 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26401 algorithms.
26402 .endlist
26403
26404 Each cipher string can be optionally preceded by one of the characters &`!`&,
26405 &`-`& or &`+`&.
26406 .ilist
26407 If &`!`& is used, the ciphers are permanently deleted from the list. The
26408 ciphers deleted can never reappear in the list even if they are explicitly
26409 stated.
26410 .next
26411 If &`-`& is used, the ciphers are deleted from the list, but some or all
26412 of the ciphers can be added again by later options.
26413 .next
26414 If &`+`& is used, the ciphers are moved to the end of the list. This
26415 option does not add any new ciphers; it just moves matching existing ones.
26416 .endlist
26417
26418 If none of these characters is present, the string is interpreted as
26419 a list of ciphers to be appended to the current preference list. If the list
26420 includes any ciphers already present they will be ignored: that is, they will
26421 not be moved to the end of the list.
26422 .endlist
26423
26424 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26425 string:
26426 .code
26427 # note single-quotes to get ! past any shell history expansion
26428 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26429 .endd
26430
26431 This example will let the library defaults be permitted on the MX port, where
26432 there's probably no identity verification anyway, but ups the ante on the
26433 submission ports where the administrator might have some influence on the
26434 choice of clients used:
26435 .code
26436 # OpenSSL variant; see man ciphers(1)
26437 tls_require_ciphers = ${if =={$received_port}{25}\
26438                            {DEFAULT}\
26439                            {HIGH:!MD5:!SHA1}}
26440 .endd
26441
26442
26443
26444 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26445          "SECTreqciphgnu"
26446 .cindex "GnuTLS" "specifying parameters for"
26447 .cindex "TLS" "specifying ciphers (GnuTLS)"
26448 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26449 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26450 .cindex "TLS" "specifying protocols (GnuTLS)"
26451 .cindex "TLS" "specifying priority string (GnuTLS)"
26452 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26453 The GnuTLS library allows the caller to provide a "priority string", documented
26454 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26455 ciphersuite specification in OpenSSL.
26456
26457 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26458 and controls both protocols and ciphers.
26459
26460 The &%tls_require_ciphers%& option is available both as an global option,
26461 controlling how Exim behaves as a server, and also as an option of the
26462 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26463 the value is string expanded.  The resulting string is not an Exim list and
26464 the string is given to the GnuTLS library, so that Exim does not need to be
26465 aware of future feature enhancements of GnuTLS.
26466
26467 Documentation of the strings accepted may be found in the GnuTLS manual, under
26468 "Priority strings".  This is online as
26469 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26470 but beware that this relates to GnuTLS 3, which may be newer than the version
26471 installed on your system.  If you are using GnuTLS 3,
26472 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26473 on that site can be used to test a given string.
26474
26475 For example:
26476 .code
26477 # Disable older versions of protocols
26478 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26479 .endd
26480
26481 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26482 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26483 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26484
26485 This example will let the library defaults be permitted on the MX port, where
26486 there's probably no identity verification anyway, and lowers security further
26487 by increasing compatibility; but this ups the ante on the submission ports
26488 where the administrator might have some influence on the choice of clients
26489 used:
26490 .code
26491 # GnuTLS variant
26492 tls_require_ciphers = ${if =={$received_port}{25}\
26493                            {NORMAL:%COMPAT}\
26494                            {SECURE128}}
26495 .endd
26496
26497
26498 .section "Configuring an Exim server to use TLS" "SECID182"
26499 .cindex "TLS" "configuring an Exim server"
26500 When Exim has been built with TLS support, it advertises the availability of
26501 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26502 but not to any others. The default value of this option is unset, which means
26503 that STARTTLS is not advertised at all. This default is chosen because you
26504 need to set some other options in order to make TLS available, and also it is
26505 sensible for systems that want to use TLS only as a client.
26506
26507 If a client issues a STARTTLS command and there is some configuration
26508 problem in the server, the command is rejected with a 454 error. If the client
26509 persists in trying to issue SMTP commands, all except QUIT are rejected
26510 with the error
26511 .code
26512 554 Security failure
26513 .endd
26514 If a STARTTLS command is issued within an existing TLS session, it is
26515 rejected with a 554 error code.
26516
26517 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26518 match some hosts. You can, of course, set it to * to match all hosts.
26519 However, this is not all you need to do. TLS sessions to a server won't work
26520 without some further configuration at the server end.
26521
26522 It is rumoured that all existing clients that support TLS/SSL use RSA
26523 encryption. To make this work you need to set, in the server,
26524 .code
26525 tls_certificate = /some/file/name
26526 tls_privatekey = /some/file/name
26527 .endd
26528 These options are, in fact, expanded strings, so you can make them depend on
26529 the identity of the client that is connected if you wish. The first file
26530 contains the server's X509 certificate, and the second contains the private key
26531 that goes with it. These files need to be
26532 PEM format and readable by the Exim user, and must
26533 always be given as full path names.
26534 The key must not be password-protected.
26535 They can be the same file if both the
26536 certificate and the key are contained within it. If &%tls_privatekey%& is not
26537 set, or if its expansion is forced to fail or results in an empty string, this
26538 is assumed to be the case. The certificate file may also contain intermediate
26539 certificates that need to be sent to the client to enable it to authenticate
26540 the server's certificate.
26541
26542 If you do not understand about certificates and keys, please try to find a
26543 source of this background information, which is not Exim-specific. (There are a
26544 few comments below in section &<<SECTcerandall>>&.)
26545
26546 &*Note*&: These options do not apply when Exim is operating as a client &--
26547 they apply only in the case of a server. If you need to use a certificate in an
26548 Exim client, you must set the options of the same names in an &(smtp)&
26549 transport.
26550
26551 With just these options, an Exim server will be able to use TLS. It does not
26552 require the client to have a certificate (but see below for how to insist on
26553 this). There is one other option that may be needed in other situations. If
26554 .code
26555 tls_dhparam = /some/file/name
26556 .endd
26557 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26558 with the parameters contained in the file.
26559 Set this to &`none`& to disable use of DH entirely, by making no prime
26560 available:
26561 .code
26562 tls_dhparam = none
26563 .endd
26564 This may also be set to a string identifying a standard prime to be used for
26565 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26566 used is &`ike23`&.  There are a few standard primes available, see the
26567 documentation for &%tls_dhparam%& for the complete list.
26568
26569 See the command
26570 .code
26571 openssl dhparam
26572 .endd
26573 for a way of generating file data.
26574
26575 The strings supplied for these three options are expanded every time a client
26576 host connects. It is therefore possible to use different certificates and keys
26577 for different hosts, if you so wish, by making use of the client's IP address
26578 in &$sender_host_address$& to control the expansion. If a string expansion is
26579 forced to fail, Exim behaves as if the option is not set.
26580
26581 .cindex "cipher" "logging"
26582 .cindex "log" "TLS cipher"
26583 .vindex "&$tls_in_cipher$&"
26584 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26585 an incoming TLS connection. It is included in the &'Received:'& header of an
26586 incoming message (by default &-- you can, of course, change this), and it is
26587 also included in the log line that records a message's arrival, keyed by
26588 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26589 condition can be used to test for specific cipher suites in ACLs.
26590
26591 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26592 can check the name of the cipher suite and vary their actions accordingly. The
26593 cipher suite names vary, depending on which TLS library is being used. For
26594 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26595 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26596 documentation for more details.
26597
26598 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26599 (again depending on the &%tls_cipher%& log selector).
26600
26601
26602 .section "Requesting and verifying client certificates" "SECID183"
26603 .cindex "certificate" "verification of client"
26604 .cindex "TLS" "client certificate verification"
26605 If you want an Exim server to request a certificate when negotiating a TLS
26606 session with a client, you must set either &%tls_verify_hosts%& or
26607 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26608 apply to all TLS connections. For any host that matches one of these options,
26609 Exim requests a certificate as part of the setup of the TLS session. The
26610 contents of the certificate are verified by comparing it with a list of
26611 expected certificates.
26612 .new
26613 These may be the system default set (depending on library version),
26614 .wen
26615 an explicit file or,
26616 depending on library version, a directory, identified by
26617 &%tls_verify_certificates%&.
26618
26619 A file can contain multiple certificates, concatenated end to end. If a
26620 directory is used
26621 (OpenSSL only),
26622 each certificate must be in a separate file, with a name (or a symbolic link)
26623 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26624 certificate. You can compute the relevant hash by running the command
26625 .code
26626 openssl x509 -hash -noout -in /cert/file
26627 .endd
26628 where &_/cert/file_& contains a single certificate.
26629
26630 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26631 what happens if the client does not supply a certificate, or if the certificate
26632 does not match any of the certificates in the collection named by
26633 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26634 attempt to set up a TLS session is aborted, and the incoming connection is
26635 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26636 session continues. ACLs that run for subsequent SMTP commands can detect the
26637 fact that no certificate was verified, and vary their actions accordingly. For
26638 example, you can insist on a certificate before accepting a message for
26639 relaying, but not when the message is destined for local delivery.
26640
26641 .vindex "&$tls_in_peerdn$&"
26642 When a client supplies a certificate (whether it verifies or not), the value of
26643 the Distinguished Name of the certificate is made available in the variable
26644 &$tls_in_peerdn$& during subsequent processing of the message.
26645
26646 .cindex "log" "distinguished name"
26647 Because it is often a long text string, it is not included in the log line or
26648 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26649 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26650 &%received_header_text%& to change the &'Received:'& header. When no
26651 certificate is supplied, &$tls_in_peerdn$& is empty.
26652
26653
26654 .section "Revoked certificates" "SECID184"
26655 .cindex "TLS" "revoked certificates"
26656 .cindex "revocation list"
26657 .cindex "certificate" "revocation list"
26658 .cindex "OCSP" "stapling"
26659 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26660 certificates are revoked. If you have such a list, you can pass it to an Exim
26661 server using the global option called &%tls_crl%& and to an Exim client using
26662 an identically named option for the &(smtp)& transport. In each case, the value
26663 of the option is expanded and must then be the name of a file that contains a
26664 CRL in PEM format.
26665 The downside is that clients have to periodically re-download a potentially huge
26666 file from every certificate authority they know of.
26667
26668 The way with most moving parts at query time is Online Certificate
26669 Status Protocol (OCSP), where the client verifies the certificate
26670 against an OCSP server run by the CA.  This lets the CA track all
26671 usage of the certs.  It requires running software with access to the
26672 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26673 is based on HTTP and can be proxied accordingly.
26674
26675 The only widespread OCSP server implementation (known to this writer)
26676 comes as part of OpenSSL and aborts on an invalid request, such as
26677 connecting to the port and then disconnecting.  This requires
26678 re-entering the passphrase each time some random client does this.
26679
26680 The third way is OCSP Stapling; in this, the server using a certificate
26681 issued by the CA periodically requests an OCSP proof of validity from
26682 the OCSP server, then serves it up inline as part of the TLS
26683 negotiation.   This approach adds no extra round trips, does not let the
26684 CA track users, scales well with number of certs issued by the CA and is
26685 resilient to temporary OCSP server failures, as long as the server
26686 starts retrying to fetch an OCSP proof some time before its current
26687 proof expires.  The downside is that it requires server support.
26688
26689 Unless Exim is built with the support disabled,
26690 or with GnuTLS earlier than version 3.1.3,
26691 support for OCSP stapling is included.
26692
26693 There is a global option called &%tls_ocsp_file%&.
26694 The file specified therein is expected to be in DER format, and contain
26695 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26696 option will be re-expanded for SNI, if the &%tls_certificate%& option
26697 contains &`tls_in_sni`&, as per other TLS options.
26698
26699 Exim does not at this time implement any support for fetching a new OCSP
26700 proof.  The burden is on the administrator to handle this, outside of
26701 Exim.  The file specified should be replaced atomically, so that the
26702 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26703 on each connection, so a new file will be handled transparently on the
26704 next connection.
26705
26706 When built with OpenSSL Exim will check for a valid next update timestamp
26707 in the OCSP proof; if not present, or if the proof has expired, it will be
26708 ignored.
26709
26710 For the client to be able to verify the stapled OCSP the server must
26711 also supply, in its stapled information, any intermediate
26712 certificates for the chain leading to the OCSP proof from the signer
26713 of the server certificate.  There may be zero or one such. These
26714 intermediate certificates should be added to the server OCSP stapling
26715 file named by &%tls_ocsp_file%&.
26716
26717 Note that the proof only covers the terminal server certificate,
26718 not any of the chain from CA to it.
26719
26720 There is no current way to staple a proof for a client certificate.
26721
26722 .code
26723   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26724   OCSP server is supplied.  The server URL may be included in the
26725   server certificate, if the CA is helpful.
26726
26727   One failure mode seen was the OCSP Signer cert expiring before the end
26728   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26729   noted this as invalid overall, but the re-fetch script did not.
26730 .endd
26731
26732
26733
26734
26735 .section "Configuring an Exim client to use TLS" "SECID185"
26736 .cindex "cipher" "logging"
26737 .cindex "log" "TLS cipher"
26738 .cindex "log" "distinguished name"
26739 .cindex "TLS" "configuring an Exim client"
26740 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26741 deliveries as well as to incoming, the latter one causing logging of the
26742 server certificate's DN. The remaining client configuration for TLS is all
26743 within the &(smtp)& transport.
26744
26745 It is not necessary to set any options to have TLS work in the &(smtp)&
26746 transport. If Exim is built with TLS support, and TLS is advertised by a
26747 server, the &(smtp)& transport always tries to start a TLS session. However,
26748 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26749 transport) to a list of server hosts for which TLS should not be used.
26750
26751 If you do not want Exim to attempt to send messages unencrypted when an attempt
26752 to set up an encrypted connection fails in any way, you can set
26753 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26754 those hosts, delivery is always deferred if an encrypted connection cannot be
26755 set up. If there are any other hosts for the address, they are tried in the
26756 usual way.
26757
26758 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26759 the message unencrypted. It always does this if the response to STARTTLS is
26760 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26761 session after a success response code, what happens is controlled by the
26762 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26763 delivery to this host is deferred, and other hosts (if available) are tried. If
26764 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26765 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26766 negotiation fails, Exim closes the current connection (because it is in an
26767 unknown state), opens a new one to the same host, and then tries the delivery
26768 unencrypted.
26769
26770 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26771 transport provide the client with a certificate, which is passed to the server
26772 if it requests it. If the server is Exim, it will request a certificate only if
26773 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26774
26775 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26776 specifies a collection of expected server certificates.
26777 .new
26778 These may be the system default set (depending on library version),
26779 .wen
26780 a file or,
26781 depnding on liibrary version, a directory,
26782 must name a file or,
26783 for OpenSSL only (not GnuTLS), a directory.
26784 The client verifies the server's certificate
26785 against this collection, taking into account any revoked certificates that are
26786 in the list defined by &%tls_crl%&.
26787 Failure to verify fails the TLS connection unless either of the
26788 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26789
26790 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26791 certificate verification to the listed servers.  Verification either must
26792 or need not succeed respectively.
26793
26794 The &(smtp)& transport has two OCSP-related options:
26795 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26796 is requested and required for the connection to proceed.  The default
26797 value is empty.
26798 &%hosts_request_ocsp%&; a host-list for which (additionally)
26799 a Certificate Status is requested (but not necessarily verified).  The default
26800 value is "*" meaning that requests are made unless configured
26801 otherwise.
26802
26803 The host(s) should also be in &%hosts_require_tls%&, and
26804 &%tls_verify_certificates%& configured for the transport,
26805 for OCSP to be relevant.
26806
26807 If
26808 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26809 list of permitted cipher suites. If either of these checks fails, delivery to
26810 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26811 alternative hosts, if any.
26812
26813  &*Note*&:
26814 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26815 is operating as a client. Exim does not assume that a server certificate (set
26816 by the global options of the same name) should also be used when operating as a
26817 client.
26818
26819 .vindex "&$host$&"
26820 .vindex "&$host_address$&"
26821 All the TLS options in the &(smtp)& transport are expanded before use, with
26822 &$host$& and &$host_address$& containing the name and address of the server to
26823 which the client is connected. Forced failure of an expansion causes Exim to
26824 behave as if the relevant option were unset.
26825
26826 .vindex &$tls_out_bits$&
26827 .vindex &$tls_out_cipher$&
26828 .vindex &$tls_out_peerdn$&
26829 .vindex &$tls_out_sni$&
26830 Before an SMTP connection is established, the
26831 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26832 variables are emptied. (Until the first connection, they contain the values
26833 that were set when the message was received.) If STARTTLS is subsequently
26834 successfully obeyed, these variables are set to the relevant values for the
26835 outgoing connection.
26836
26837
26838
26839 .section "Use of TLS Server Name Indication" "SECTtlssni"
26840 .cindex "TLS" "Server Name Indication"
26841 .vindex "&$tls_in_sni$&"
26842 .oindex "&%tls_in_sni%&"
26843 With TLS1.0 or above, there is an extension mechanism by which extra
26844 information can be included at various points in the protocol.  One of these
26845 extensions, documented in RFC 6066 (and before that RFC 4366) is
26846 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26847 client in the initial handshake, so that the server can examine the servername
26848 within and possibly choose to use different certificates and keys (and more)
26849 for this session.
26850
26851 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26852 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26853 address.
26854
26855 With SMTP to MX, there are the same problems here as in choosing the identity
26856 against which to validate a certificate: you can't rely on insecure DNS to
26857 provide the identity which you then cryptographically verify.  So this will
26858 be of limited use in that environment.
26859
26860 With SMTP to Submission, there is a well-defined hostname which clients are
26861 connecting to and can validate certificates against.  Thus clients &*can*&
26862 choose to include this information in the TLS negotiation.  If this becomes
26863 wide-spread, then hosters can choose to present different certificates to
26864 different clients.  Or even negotiate different cipher suites.
26865
26866 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26867 if not empty, will be sent on a TLS session as part of the handshake.  There's
26868 nothing more to it.  Choosing a sensible value not derived insecurely is the
26869 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26870 for the lifetime of the client connection (including during authentication).
26871
26872 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26873 received from a client.
26874 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26875
26876 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26877 option (prior to expansion) then the following options will be re-expanded
26878 during TLS session handshake, to permit alternative values to be chosen:
26879
26880 .ilist
26881 .vindex "&%tls_certificate%&"
26882 &%tls_certificate%&
26883 .next
26884 .vindex "&%tls_crl%&"
26885 &%tls_crl%&
26886 .next
26887 .vindex "&%tls_privatekey%&"
26888 &%tls_privatekey%&
26889 .next
26890 .vindex "&%tls_verify_certificates%&"
26891 &%tls_verify_certificates%&
26892 .next
26893 .vindex "&%tls_ocsp_file%&"
26894 &%tls_ocsp_file%&
26895 .endlist
26896
26897 Great care should be taken to deal with matters of case, various injection
26898 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26899 can always be referenced; it is important to remember that &$tls_sni$& is
26900 arbitrary unverified data provided prior to authentication.
26901
26902 The Exim developers are proceeding cautiously and so far no other TLS options
26903 are re-expanded.
26904
26905 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26906 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26907 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26908 see &`-servername`& in the output, then OpenSSL has support.
26909
26910 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26911 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26912 built, then you have SNI support).
26913
26914
26915
26916 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26917          "SECTmulmessam"
26918 .cindex "multiple SMTP deliveries with TLS"
26919 .cindex "TLS" "multiple message deliveries"
26920 Exim sends multiple messages down the same TCP/IP connection by starting up
26921 an entirely new delivery process for each message, passing the socket from
26922 one process to the next. This implementation does not fit well with the use
26923 of TLS, because there is quite a lot of state information associated with a TLS
26924 connection, not just a socket identification. Passing all the state information
26925 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26926 session before passing the socket to a new process. The new process may then
26927 try to start a new TLS session, and if successful, may try to re-authenticate
26928 if AUTH is in use, before sending the next message.
26929
26930 The RFC is not clear as to whether or not an SMTP session continues in clear
26931 after TLS has been shut down, or whether TLS may be restarted again later, as
26932 just described. However, if the server is Exim, this shutdown and
26933 reinitialization works. It is not known which (if any) other servers operate
26934 successfully if the client closes a TLS session and continues with unencrypted
26935 SMTP, but there are certainly some that do not work. For such servers, Exim
26936 should not pass the socket to another process, because the failure of the
26937 subsequent attempt to use it would cause Exim to record a temporary host error,
26938 and delay other deliveries to that host.
26939
26940 To test for this case, Exim sends an EHLO command to the server after
26941 closing down the TLS session. If this fails in any way, the connection is
26942 closed instead of being passed to a new delivery process, but no retry
26943 information is recorded.
26944
26945 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26946 &(smtp)& transport to match those hosts for which Exim should not pass
26947 connections to new processes if TLS has been used.
26948
26949
26950
26951
26952 .section "Certificates and all that" "SECTcerandall"
26953 .cindex "certificate" "references to discussion"
26954 In order to understand fully how TLS works, you need to know about
26955 certificates, certificate signing, and certificate authorities. This is not the
26956 place to give a tutorial, especially as I do not know very much about it
26957 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26958 to Apache, currently at
26959 .display
26960 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26961 .endd
26962 Other parts of the &'modssl'& documentation are also helpful, and have
26963 links to further files.
26964 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26965 0-201-61598-3), contains both introductory and more in-depth descriptions.
26966 Some sample programs taken from the book are available from
26967 .display
26968 &url(http://www.rtfm.com/openssl-examples/)
26969 .endd
26970
26971
26972 .section "Certificate chains" "SECID186"
26973 The file named by &%tls_certificate%& may contain more than one
26974 certificate. This is useful in the case where the certificate that is being
26975 sent is validated by an intermediate certificate which the other end does
26976 not have. Multiple certificates must be in the correct order in the file.
26977 First the host's certificate itself, then the first intermediate
26978 certificate to validate the issuer of the host certificate, then the next
26979 intermediate certificate to validate the issuer of the first intermediate
26980 certificate, and so on, until finally (optionally) the root certificate.
26981 The root certificate must already be trusted by the recipient for
26982 validation to succeed, of course, but if it's not preinstalled, sending the
26983 root certificate along with the rest makes it available for the user to
26984 install if the receiving end is a client MUA that can interact with a user.
26985
26986 Note that certificates using MD5 are unlikely to work on today's Internet;
26987 even if your libraries allow loading them for use in Exim when acting as a
26988 server, increasingly clients will not accept such certificates.  The error
26989 diagnostics in such a case can be frustratingly vague.
26990
26991
26992
26993 .section "Self-signed certificates" "SECID187"
26994 .cindex "certificate" "self-signed"
26995 You can create a self-signed certificate using the &'req'& command provided
26996 with OpenSSL, like this:
26997 . ==== Do not shorten the duration here without reading and considering
26998 . ==== the text below.  Please leave it at 9999 days.
26999 .code
27000 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27001             -days 9999 -nodes
27002 .endd
27003 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27004 delimited and so can be identified independently. The &%-days%& option
27005 specifies a period for which the certificate is valid. The &%-nodes%& option is
27006 important: if you do not set it, the key is encrypted with a passphrase
27007 that you are prompted for, and any use that is made of the key causes more
27008 prompting for the passphrase. This is not helpful if you are going to use
27009 this certificate and key in an MTA, where prompting is not possible.
27010
27011 . ==== I expect to still be working 26 years from now.  The less technical
27012 . ==== debt I create, in terms of storing up trouble for my later years, the
27013 . ==== happier I will be then.  We really have reached the point where we
27014 . ==== should start, at the very least, provoking thought and making folks
27015 . ==== pause before proceeding, instead of leaving all the fixes until two
27016 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27017 . ==== -pdp, 2012
27018 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27019 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27020 the above command might produce a date in the past.  Think carefully about
27021 the lifetime of the systems you're deploying, and either reduce the duration
27022 of the certificate or reconsider your platform deployment.  (At time of
27023 writing, reducing the duration is the most likely choice, but the inexorable
27024 progression of time takes us steadily towards an era where this will not
27025 be a sensible resolution).
27026
27027 A self-signed certificate made in this way is sufficient for testing, and
27028 may be adequate for all your requirements if you are mainly interested in
27029 encrypting transfers, and not in secure identification.
27030
27031 However, many clients require that the certificate presented by the server be a
27032 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27033 certificate. In this situation, the self-signed certificate described above
27034 must be installed on the client host as a trusted root &'certification
27035 authority'& (CA), and the certificate used by Exim must be a user certificate
27036 signed with that self-signed certificate.
27037
27038 For information on creating self-signed CA certificates and using them to sign
27039 user certificates, see the &'General implementation overview'& chapter of the
27040 Open-source PKI book, available online at
27041 &url(http://ospkibook.sourceforge.net/).
27042 .ecindex IIDencsmtp1
27043 .ecindex IIDencsmtp2
27044
27045
27046
27047 . ////////////////////////////////////////////////////////////////////////////
27048 . ////////////////////////////////////////////////////////////////////////////
27049
27050 .chapter "Access control lists" "CHAPACL"
27051 .scindex IIDacl "&ACL;" "description"
27052 .cindex "control of incoming mail"
27053 .cindex "message" "controlling incoming"
27054 .cindex "policy control" "access control lists"
27055 Access Control Lists (ACLs) are defined in a separate section of the run time
27056 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27057 name, terminated by a colon. Here is a complete ACL section that contains just
27058 one very small ACL:
27059 .code
27060 begin acl
27061 small_acl:
27062   accept   hosts = one.host.only
27063 .endd
27064 You can have as many lists as you like in the ACL section, and the order in
27065 which they appear does not matter. The lists are self-terminating.
27066
27067 The majority of ACLs are used to control Exim's behaviour when it receives
27068 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27069 when a local process submits a message using SMTP by specifying the &%-bs%&
27070 option. The most common use is for controlling which recipients are accepted
27071 in incoming messages. In addition, you can define an ACL that is used to check
27072 local non-SMTP messages. The default configuration file contains an example of
27073 a realistic ACL for checking RCPT commands. This is discussed in chapter
27074 &<<CHAPdefconfil>>&.
27075
27076
27077 .section "Testing ACLs" "SECID188"
27078 The &%-bh%& command line option provides a way of testing your ACL
27079 configuration locally by running a fake SMTP session with which you interact.
27080 The host &'relay-test.mail-abuse.org'& provides a service for checking your
27081 relaying configuration (see section &<<SECTcheralcon>>& for more details).
27082
27083
27084
27085 .section "Specifying when ACLs are used" "SECID189"
27086 .cindex "&ACL;" "options for specifying"
27087 In order to cause an ACL to be used, you have to name it in one of the relevant
27088 options in the main part of the configuration. These options are:
27089 .cindex "AUTH" "ACL for"
27090 .cindex "DATA" "ACLs for"
27091 .cindex "ETRN" "ACL for"
27092 .cindex "EXPN" "ACL for"
27093 .cindex "HELO" "ACL for"
27094 .cindex "EHLO" "ACL for"
27095 .cindex "MAIL" "ACL for"
27096 .cindex "QUIT, ACL for"
27097 .cindex "RCPT" "ACL for"
27098 .cindex "STARTTLS, ACL for"
27099 .cindex "VRFY" "ACL for"
27100 .cindex "SMTP" "connection, ACL for"
27101 .cindex "non-SMTP messages" "ACLs for"
27102 .cindex "MIME content scanning" "ACL for"
27103 .cindex "PRDR" "ACL for"
27104
27105 .table2 140pt
27106 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27107 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27108 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27109 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27110 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27111 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27112 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27113 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27114 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27115 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27116 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27117 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27118 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27119 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27120 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27121 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27122 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27123 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27124 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27125 .endtable
27126
27127 For example, if you set
27128 .code
27129 acl_smtp_rcpt = small_acl
27130 .endd
27131 the little ACL defined above is used whenever Exim receives a RCPT command
27132 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27133 done when RCPT commands arrive. A rejection of RCPT should cause the
27134 sending MTA to give up on the recipient address contained in the RCPT
27135 command, whereas rejection at other times may cause the client MTA to keep on
27136 trying to deliver the message. It is therefore recommended that you do as much
27137 testing as possible at RCPT time.
27138
27139
27140 .section "The non-SMTP ACLs" "SECID190"
27141 .cindex "non-SMTP messages" "ACLs for"
27142 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27143 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27144 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27145 the state of the SMTP connection such as encryption and authentication) are not
27146 relevant and are forbidden in these ACLs. However, the sender and recipients
27147 are known, so the &%senders%& and &%sender_domains%& conditions and the
27148 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27149 &$authenticated_sender$& are also available. You can specify added header lines
27150 in any of these ACLs.
27151
27152 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27153 non-SMTP message, before any of the message has been read. (This is the
27154 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27155 batched SMTP input, it runs after the DATA command has been reached. The
27156 result of this ACL is ignored; it cannot be used to reject a message. If you
27157 really need to, you could set a value in an ACL variable here and reject based
27158 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27159 controls, and in particular, it can be used to set
27160 .code
27161 control = suppress_local_fixups
27162 .endd
27163 This cannot be used in the other non-SMTP ACLs because by the time they are
27164 run, it is too late.
27165
27166 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27167 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27168
27169 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27170 kind of rejection is treated as permanent, because there is no way of sending a
27171 temporary error for these kinds of message.
27172
27173
27174 .section "The SMTP connect ACL" "SECID191"
27175 .cindex "SMTP" "connection, ACL for"
27176 .oindex &%smtp_banner%&
27177 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27178 session, after the test specified by &%host_reject_connection%& (which is now
27179 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27180 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27181 the message override the banner message that is otherwise specified by the
27182 &%smtp_banner%& option.
27183
27184
27185 .section "The EHLO/HELO ACL" "SECID192"
27186 .cindex "EHLO" "ACL for"
27187 .cindex "HELO" "ACL for"
27188 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27189 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27190 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27191 Note that a client may issue more than one EHLO or HELO command in an SMTP
27192 session, and indeed is required to issue a new EHLO or HELO after successfully
27193 setting up encryption following a STARTTLS command.
27194
27195 If the command is accepted by an &%accept%& verb that has a &%message%&
27196 modifier, the message may not contain more than one line (it will be truncated
27197 at the first newline and a panic logged if it does). Such a message cannot
27198 affect the EHLO options that are listed on the second and subsequent lines of
27199 an EHLO response.
27200
27201
27202 .section "The DATA ACLs" "SECID193"
27203 .cindex "DATA" "ACLs for"
27204 Two ACLs are associated with the DATA command, because it is two-stage
27205 command, with two responses being sent to the client.
27206 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27207 is obeyed. This gives you control after all the RCPT commands, but before
27208 the message itself is received. It offers the opportunity to give a negative
27209 response to the DATA command before the data is transmitted. Header lines
27210 added by MAIL or RCPT ACLs are not visible at this time, but any that
27211 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27212
27213 You cannot test the contents of the message, for example, to verify addresses
27214 in the headers, at RCPT time or when the DATA command is received. Such
27215 tests have to appear in the ACL that is run after the message itself has been
27216 received, before the final response to the DATA command is sent. This is
27217 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27218 associated with the DATA command.
27219
27220 For both of these ACLs, it is not possible to reject individual recipients. An
27221 error response rejects the entire message. Unfortunately, it is known that some
27222 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27223 before or after the data) correctly &-- they keep the message on their queues
27224 and try again later, but that is their problem, though it does waste some of
27225 your resources.
27226
27227 The &%acl_smtp_data%& ACL is run after
27228 the &%acl_smtp_data_prdr%&,
27229 the &%acl_smtp_dkim%&
27230 and the &%acl_smtp_mime%& ACLs.
27231
27232 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27233 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27234 enabled (which is the default).
27235
27236 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27237 received, and is executed for each DKIM signature found in a message.  If not
27238 otherwise specified, the default action is to accept.
27239
27240 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27241
27242 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27243
27244
27245 .section "The SMTP MIME ACL" "SECID194"
27246 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27247 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27248
27249 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27250
27251
27252 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27253 .cindex "PRDR" "ACL for"
27254 .oindex "&%prdr_enable%&"
27255 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27256 with PRDR support enabled (which is the default).
27257 It becomes active only when the PRDR feature is negotiated between
27258 client and server for a message, and more than one recipient
27259 has been accepted.
27260
27261 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27262 has been recieved, and is executed once for each recipient of the message
27263 with &$local_part$& and &$domain$& valid.
27264 The test may accept, defer or deny for inividual recipients.
27265 The &%acl_smtp_data%& will still be called after this ACL and
27266 can reject the message overall, even if this ACL has accepted it
27267 for some or all recipients.
27268
27269 PRDR may be used to support per-user content filtering.  Without it
27270 one must defer any recipient after the first that has a different
27271 content-filter configuration.  With PRDR, the RCPT-time check
27272 for this can be disabled when the MAIL-time $smtp_command included
27273 "PRDR".  Any required difference in behaviour of the main DATA-time
27274 ACL should however depend on the PRDR-time ACL having run, as Exim
27275 will avoid doing so in some situations (eg.  single-recipient mails).
27276
27277 See also the &%prdr_enable%& global option
27278 and the &%hosts_try_prdr%& smtp transport option.
27279
27280 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27281 If the ACL is not defined, processing completes as if
27282 the feature was not requested by the client.
27283
27284 .section "The QUIT ACL" "SECTQUITACL"
27285 .cindex "QUIT, ACL for"
27286 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27287 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27288 does not in fact control any access. For this reason, it may only accept
27289 or warn as its final result.
27290
27291 This ACL can be used for tasks such as custom logging at the end of an SMTP
27292 session. For example, you can use ACL variables in other ACLs to count
27293 messages, recipients, etc., and log the totals at QUIT time using one or
27294 more &%logwrite%& modifiers on a &%warn%& verb.
27295
27296 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27297 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27298
27299 You do not need to have a final &%accept%&, but if you do, you can use a
27300 &%message%& modifier to specify custom text that is sent as part of the 221
27301 response to QUIT.
27302
27303 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27304 failure (for example, failure to open a log file, or when Exim is bombing out
27305 because it has detected an unrecoverable error), all SMTP commands from the
27306 client are given temporary error responses until QUIT is received or the
27307 connection is closed. In these special cases, the QUIT ACL does not run.
27308
27309
27310 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27311 .vindex &$acl_smtp_notquit$&
27312 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27313 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27314 trouble, such as being unable to write to its log files, this ACL is not run,
27315 because it might try to do things (such as write to log files) that make the
27316 situation even worse.
27317
27318 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27319 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27320 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27321 and &%warn%&.
27322
27323 .vindex &$smtp_notquit_reason$&
27324 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27325 to a string that indicates the reason for the termination of the SMTP
27326 connection. The possible values are:
27327 .table2
27328 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27329 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27330 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27331 .irow &`connection-lost`&          "The SMTP connection has been lost"
27332 .irow &`data-timeout`&             "Timeout while reading message data"
27333 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27334 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27335 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27336 .irow &`synchronization-error`&    "SMTP synchronization error"
27337 .irow &`tls-failed`&               "TLS failed to start"
27338 .endtable
27339 In most cases when an SMTP connection is closed without having received QUIT,
27340 Exim sends an SMTP response message before actually closing the connection.
27341 With the exception of the &`acl-drop`& case, the default message can be
27342 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27343 &%drop%& verb in another ACL, it is the message from the other ACL that is
27344 used.
27345
27346
27347 .section "Finding an ACL to use" "SECID195"
27348 .cindex "&ACL;" "finding which to use"
27349 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27350 you can use different ACLs in different circumstances. For example,
27351 .code
27352 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27353                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27354 .endd
27355 In the default configuration file there are some example settings for
27356 providing an RFC 4409 message submission service on port 587 and a
27357 non-standard &"smtps"& service on port 465. You can use a string
27358 expansion like this to choose an ACL for MUAs on these ports which is
27359 more appropriate for this purpose than the default ACL on port 25.
27360
27361 The expanded string does not have to be the name of an ACL in the
27362 configuration file; there are other possibilities. Having expanded the
27363 string, Exim searches for an ACL as follows:
27364
27365 .ilist
27366 If the string begins with a slash, Exim uses it as a file name, and reads its
27367 contents as an ACL. The lines are processed in the same way as lines in the
27368 Exim configuration file. In particular, continuation lines are supported, blank
27369 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27370 If the file does not exist or cannot be read, an error occurs (typically
27371 causing a temporary failure of whatever caused the ACL to be run). For example:
27372 .code
27373 acl_smtp_data = /etc/acls/\
27374   ${lookup{$sender_host_address}lsearch\
27375   {/etc/acllist}{$value}{default}}
27376 .endd
27377 This looks up an ACL file to use on the basis of the host's IP address, falling
27378 back to a default if the lookup fails. If an ACL is successfully read from a
27379 file, it is retained in memory for the duration of the Exim process, so that it
27380 can be re-used without having to re-read the file.
27381 .next
27382 If the string does not start with a slash, and does not contain any spaces,
27383 Exim searches the ACL section of the configuration for an ACL whose name
27384 matches the string.
27385 .next
27386 If no named ACL is found, or if the string contains spaces, Exim parses
27387 the string as an inline ACL. This can save typing in cases where you just
27388 want to have something like
27389 .code
27390 acl_smtp_vrfy = accept
27391 .endd
27392 in order to allow free use of the VRFY command. Such a string may contain
27393 newlines; it is processed in the same way as an ACL that is read from a file.
27394 .endlist
27395
27396
27397
27398
27399 .section "ACL return codes" "SECID196"
27400 .cindex "&ACL;" "return codes"
27401 Except for the QUIT ACL, which does not affect the SMTP return code (see
27402 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27403 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27404 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27405 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27406 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27407 This also causes a 4&'xx'& return code.
27408
27409 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27410 &"deny"&, because there is no mechanism for passing temporary errors to the
27411 submitters of non-SMTP messages.
27412
27413
27414 ACLs that are relevant to message reception may also return &"discard"&. This
27415 has the effect of &"accept"&, but causes either the entire message or an
27416 individual recipient address to be discarded. In other words, it is a
27417 blackholing facility. Use it with care.
27418
27419 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27420 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27421 RCPT ACL is to discard just the one recipient address. If there are no
27422 recipients left when the message's data is received, the DATA ACL is not
27423 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27424 remaining recipients. The &"discard"& return is not permitted for the
27425 &%acl_smtp_predata%& ACL.
27426
27427
27428 .cindex "&[local_scan()]& function" "when all recipients discarded"
27429 The &[local_scan()]& function is always run, even if there are no remaining
27430 recipients; it may create new recipients.
27431
27432
27433
27434 .section "Unset ACL options" "SECID197"
27435 .cindex "&ACL;" "unset options"
27436 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27437 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27438 not defined at all. For any defined ACL, the default action when control
27439 reaches the end of the ACL statements is &"deny"&.
27440
27441 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27442 these two are ACLs that are used only for their side effects. They cannot be
27443 used to accept or reject anything.
27444
27445 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27446 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27447 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27448 when the ACL is not defined is &"accept"&.
27449
27450 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27451 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27452 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27453 messages over an SMTP connection. For an example, see the ACL in the default
27454 configuration file.
27455
27456
27457
27458
27459 .section "Data for message ACLs" "SECID198"
27460 .cindex "&ACL;" "data for message ACL"
27461 .vindex &$domain$&
27462 .vindex &$local_part$&
27463 .vindex &$sender_address$&
27464 .vindex &$sender_host_address$&
27465 .vindex &$smtp_command$&
27466 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27467 that contain information about the host and the message's sender (for example,
27468 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27469 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27470 &$local_part$& are set from the argument address. The entire SMTP command
27471 is available in &$smtp_command$&.
27472
27473 When an ACL for the AUTH parameter of MAIL is running, the variables that
27474 contain information about the host are set, but &$sender_address$& is not yet
27475 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27476 how it is used.
27477
27478 .vindex "&$message_size$&"
27479 The &$message_size$& variable is set to the value of the SIZE parameter on
27480 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27481 that parameter is not given. The value is updated to the true message size by
27482 the time the final DATA ACL is run (after the message data has been
27483 received).
27484
27485 .vindex "&$rcpt_count$&"
27486 .vindex "&$recipients_count$&"
27487 The &$rcpt_count$& variable increases by one for each RCPT command received.
27488 The &$recipients_count$& variable increases by one each time a RCPT command is
27489 accepted, so while an ACL for RCPT is being processed, it contains the number
27490 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27491 &$rcpt_count$& contains the total number of RCPT commands, and
27492 &$recipients_count$& contains the total number of accepted recipients.
27493
27494
27495
27496
27497
27498 .section "Data for non-message ACLs" "SECTdatfornon"
27499 .cindex "&ACL;" "data for non-message ACL"
27500 .vindex &$smtp_command_argument$&
27501 .vindex &$smtp_command$&
27502 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27503 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27504 and the entire SMTP command is available in &$smtp_command$&.
27505 These variables can be tested using a &%condition%& condition. For example,
27506 here is an ACL for use with AUTH, which insists that either the session is
27507 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27508 does not permit authentication methods that use cleartext passwords on
27509 unencrypted connections.
27510 .code
27511 acl_check_auth:
27512   accept encrypted = *
27513   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27514                      {CRAM-MD5}}
27515   deny   message   = TLS encryption or CRAM-MD5 required
27516 .endd
27517 (Another way of applying this restriction is to arrange for the authenticators
27518 that use cleartext passwords not to be advertised when the connection is not
27519 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27520 option to do this.)
27521
27522
27523
27524 .section "Format of an ACL" "SECID199"
27525 .cindex "&ACL;" "format of"
27526 .cindex "&ACL;" "verbs, definition of"
27527 An individual ACL consists of a number of statements. Each statement starts
27528 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27529 Modifiers can change the way the verb operates, define error and log messages,
27530 set variables, insert delays, and vary the processing of accepted messages.
27531
27532 If all the conditions are met, the verb is obeyed. The same condition may be
27533 used (with different arguments) more than once in the same statement. This
27534 provides a means of specifying an &"and"& conjunction between conditions. For
27535 example:
27536 .code
27537 deny  dnslists = list1.example
27538 dnslists = list2.example
27539 .endd
27540 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27541 the conditions and modifiers when it reaches a condition that fails. What
27542 happens then depends on the verb (and in one case, on a special modifier). Not
27543 all the conditions make sense at every testing point. For example, you cannot
27544 test a sender address in the ACL that is run for a VRFY command.
27545
27546
27547 .section "ACL verbs" "SECID200"
27548 The ACL verbs are as follows:
27549
27550 .ilist
27551 .cindex "&%accept%& ACL verb"
27552 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27553 of the conditions are not met, what happens depends on whether &%endpass%&
27554 appears among the conditions (for syntax see below). If the failing condition
27555 is before &%endpass%&, control is passed to the next ACL statement; if it is
27556 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27557 check a RCPT command:
27558 .code
27559 accept domains = +local_domains
27560 endpass
27561 verify = recipient
27562 .endd
27563 If the recipient domain does not match the &%domains%& condition, control
27564 passes to the next statement. If it does match, the recipient is verified, and
27565 the command is accepted if verification succeeds. However, if verification
27566 fails, the ACL yields &"deny"&, because the failing condition is after
27567 &%endpass%&.
27568
27569 The &%endpass%& feature has turned out to be confusing to many people, so its
27570 use is not recommended nowadays. It is always possible to rewrite an ACL so
27571 that &%endpass%& is not needed, and it is no longer used in the default
27572 configuration.
27573
27574 .cindex "&%message%& ACL modifier" "with &%accept%&"
27575 If a &%message%& modifier appears on an &%accept%& statement, its action
27576 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27577 (when an &%accept%& verb either accepts or passes control to the next
27578 statement), &%message%& can be used to vary the message that is sent when an
27579 SMTP command is accepted. For example, in a RCPT ACL you could have:
27580 .display
27581 &`accept  `&<&'some conditions'&>
27582 &`        message = OK, I will allow you through today`&
27583 .endd
27584 You can specify an SMTP response code, optionally followed by an &"extended
27585 response code"& at the start of the message, but the first digit must be the
27586 same as would be sent by default, which is 2 for an &%accept%& verb.
27587
27588 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27589 an error message that is used when access is denied. This behaviour is retained
27590 for backward compatibility, but current &"best practice"& is to avoid the use
27591 of &%endpass%&.
27592
27593
27594 .next
27595 .cindex "&%defer%& ACL verb"
27596 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27597 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27598 &%defer%& is the same as &%deny%&, because there is no way of sending a
27599 temporary error. For a RCPT command, &%defer%& is much the same as using a
27600 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27601 be used in any ACL, and even for a recipient it might be a simpler approach.
27602
27603
27604 .next
27605 .cindex "&%deny%& ACL verb"
27606 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27607 the conditions are not met, control is passed to the next ACL statement. For
27608 example,
27609 .code
27610 deny dnslists = blackholes.mail-abuse.org
27611 .endd
27612 rejects commands from hosts that are on a DNS black list.
27613
27614
27615 .next
27616 .cindex "&%discard%& ACL verb"
27617 &%discard%&: This verb behaves like &%accept%&, except that it returns
27618 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27619 that are concerned with receiving messages. When all the conditions are true,
27620 the sending entity receives a &"success"& response. However, &%discard%& causes
27621 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27622 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27623 message's recipients are discarded. Recipients that are discarded before DATA
27624 do not appear in the log line when the &%received_recipients%& log selector is set.
27625
27626 If the &%log_message%& modifier is set when &%discard%& operates,
27627 its contents are added to the line that is automatically written to the log.
27628 The &%message%& modifier operates exactly as it does for &%accept%&.
27629
27630
27631 .next
27632 .cindex "&%drop%& ACL verb"
27633 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27634 forcibly closed after the 5&'xx'& error message has been sent. For example:
27635 .code
27636 drop   message   = I don't take more than 20 RCPTs
27637        condition = ${if > {$rcpt_count}{20}}
27638 .endd
27639 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27640 The connection is always dropped after sending a 550 response.
27641
27642 .next
27643 .cindex "&%require%& ACL verb"
27644 &%require%&: If all the conditions are met, control is passed to the next ACL
27645 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27646 example, when checking a RCPT command,
27647 .code
27648 require message = Sender did not verify
27649         verify  = sender
27650 .endd
27651 passes control to subsequent statements only if the message's sender can be
27652 verified. Otherwise, it rejects the command. Note the positioning of the
27653 &%message%& modifier, before the &%verify%& condition. The reason for this is
27654 discussed in section &<<SECTcondmodproc>>&.
27655
27656 .next
27657 .cindex "&%warn%& ACL verb"
27658 &%warn%&: If all the conditions are true, a line specified by the
27659 &%log_message%& modifier is written to Exim's main log. Control always passes
27660 to the next ACL statement. If any condition is false, the log line is not
27661 written. If an identical log line is requested several times in the same
27662 message, only one copy is actually written to the log. If you want to force
27663 duplicates to be written, use the &%logwrite%& modifier instead.
27664
27665 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27666 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27667 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27668 first failing condition. There is more about adding header lines in section
27669 &<<SECTaddheadacl>>&.
27670
27671 If any condition on a &%warn%& statement cannot be completed (that is, there is
27672 some sort of defer), the log line specified by &%log_message%& is not written.
27673 This does not include the case of a forced failure from a lookup, which
27674 is considered to be a successful completion. After a defer, no further
27675 conditions or modifiers in the &%warn%& statement are processed. The incident
27676 is logged, and the ACL continues to be processed, from the next statement
27677 onwards.
27678
27679
27680 .vindex "&$acl_verify_message$&"
27681 When one of the &%warn%& conditions is an address verification that fails, the
27682 text of the verification failure message is in &$acl_verify_message$&. If you
27683 want this logged, you must set it up explicitly. For example:
27684 .code
27685 warn   !verify = sender
27686        log_message = sender verify failed: $acl_verify_message
27687 .endd
27688 .endlist
27689
27690 At the end of each ACL there is an implicit unconditional &%deny%&.
27691
27692 As you can see from the examples above, the conditions and modifiers are
27693 written one to a line, with the first one on the same line as the verb, and
27694 subsequent ones on following lines. If you have a very long condition, you can
27695 continue it onto several physical lines by the usual backslash continuation
27696 mechanism. It is conventional to align the conditions vertically.
27697
27698
27699
27700 .section "ACL variables" "SECTaclvariables"
27701 .cindex "&ACL;" "variables"
27702 There are some special variables that can be set during ACL processing. They
27703 can be used to pass information between different ACLs, different invocations
27704 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27705 transports, and filters that are used to deliver a message. The names of these
27706 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27707 an underscore, but the remainder of the name can be any sequence of
27708 alphanumeric characters and underscores that you choose. There is no limit on
27709 the number of ACL variables. The two sets act as follows:
27710 .ilist
27711 The values of those variables whose names begin with &$acl_c$& persist
27712 throughout an SMTP connection. They are never reset. Thus, a value that is set
27713 while receiving one message is still available when receiving the next message
27714 on the same SMTP connection.
27715 .next
27716 The values of those variables whose names begin with &$acl_m$& persist only
27717 while a message is being received. They are reset afterwards. They are also
27718 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27719 .endlist
27720
27721 When a message is accepted, the current values of all the ACL variables are
27722 preserved with the message and are subsequently made available at delivery
27723 time. The ACL variables are set by a modifier called &%set%&. For example:
27724 .code
27725 accept hosts = whatever
27726        set acl_m4 = some value
27727 accept authenticated = *
27728        set acl_c_auth = yes
27729 .endd
27730 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27731 be set. If you want to set a variable without taking any action, you can use a
27732 &%warn%& verb without any other modifiers or conditions.
27733
27734 .oindex &%strict_acl_vars%&
27735 What happens if a syntactically valid but undefined ACL variable is
27736 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27737 false (the default), an empty string is substituted; if it is true, an
27738 error is generated.
27739
27740 Versions of Exim before 4.64 have a limited set of numbered variables, but
27741 their names are compatible, so there is no problem with upgrading.
27742
27743
27744 .section "Condition and modifier processing" "SECTcondmodproc"
27745 .cindex "&ACL;" "conditions; processing"
27746 .cindex "&ACL;" "modifiers; processing"
27747 An exclamation mark preceding a condition negates its result. For example:
27748 .code
27749 deny   domains = *.dom.example
27750       !verify  = recipient
27751 .endd
27752 causes the ACL to return &"deny"& if the recipient domain ends in
27753 &'dom.example'& and the recipient address cannot be verified. Sometimes
27754 negation can be used on the right-hand side of a condition. For example, these
27755 two statements are equivalent:
27756 .code
27757 deny  hosts = !192.168.3.4
27758 deny !hosts =  192.168.3.4
27759 .endd
27760 However, for many conditions (&%verify%& being a good example), only left-hand
27761 side negation of the whole condition is possible.
27762
27763 The arguments of conditions and modifiers are expanded. A forced failure
27764 of an expansion causes a condition to be ignored, that is, it behaves as if the
27765 condition is true. Consider these two statements:
27766 .code
27767 accept  senders = ${lookup{$host_name}lsearch\
27768                   {/some/file}{$value}fail}
27769 accept  senders = ${lookup{$host_name}lsearch\
27770                   {/some/file}{$value}{}}
27771 .endd
27772 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27773 the returned list is searched, but if the lookup fails the behaviour is
27774 different in the two cases. The &%fail%& in the first statement causes the
27775 condition to be ignored, leaving no further conditions. The &%accept%& verb
27776 therefore succeeds. The second statement, however, generates an empty list when
27777 the lookup fails. No sender can match an empty list, so the condition fails,
27778 and therefore the &%accept%& also fails.
27779
27780 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27781 specify actions that are taken as the conditions for a statement are checked;
27782 others specify text for messages that are used when access is denied or a
27783 warning is generated. The &%control%& modifier affects the way an incoming
27784 message is handled.
27785
27786 The positioning of the modifiers in an ACL statement is important, because the
27787 processing of a verb ceases as soon as its outcome is known. Only those
27788 modifiers that have already been encountered will take effect. For example,
27789 consider this use of the &%message%& modifier:
27790 .code
27791 require message = Can't verify sender
27792         verify  = sender
27793         message = Can't verify recipient
27794         verify  = recipient
27795         message = This message cannot be used
27796 .endd
27797 If sender verification fails, Exim knows that the result of the statement is
27798 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27799 so its text is used as the error message. If sender verification succeeds, but
27800 recipient verification fails, the second message is used. If recipient
27801 verification succeeds, the third message becomes &"current"&, but is never used
27802 because there are no more conditions to cause failure.
27803
27804 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27805 modifier that is used, because all the conditions must be true for rejection to
27806 happen. Specifying more than one &%message%& modifier does not make sense, and
27807 the message can even be specified after all the conditions. For example:
27808 .code
27809 deny   hosts = ...
27810       !senders = *@my.domain.example
27811        message = Invalid sender from client host
27812 .endd
27813 The &"deny"& result does not happen until the end of the statement is reached,
27814 by which time Exim has set up the message.
27815
27816
27817
27818 .section "ACL modifiers" "SECTACLmodi"
27819 .cindex "&ACL;" "modifiers; list of"
27820 The ACL modifiers are as follows:
27821
27822 .vlist
27823 .vitem &*add_header*&&~=&~<&'text'&>
27824 This modifier specifies one or more header lines that are to be added to an
27825 incoming message, assuming, of course, that the message is ultimately
27826 accepted. For details, see section &<<SECTaddheadacl>>&.
27827
27828 .vitem &*continue*&&~=&~<&'text'&>
27829 .cindex "&%continue%& ACL modifier"
27830 .cindex "database" "updating in ACL"
27831 This modifier does nothing of itself, and processing of the ACL always
27832 continues with the next condition or modifier. The value of &%continue%& is in
27833 the side effects of expanding its argument. Typically this could be used to
27834 update a database. It is really just a syntactic tidiness, to avoid having to
27835 write rather ugly lines like this:
27836 .display
27837 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27838 .endd
27839 Instead, all you need is
27840 .display
27841 &`continue = `&<&'some expansion'&>
27842 .endd
27843
27844 .vitem &*control*&&~=&~<&'text'&>
27845 .cindex "&%control%& ACL modifier"
27846 This modifier affects the subsequent processing of the SMTP connection or of an
27847 incoming message that is accepted. The effect of the first type of control
27848 lasts for the duration of the connection, whereas the effect of the second type
27849 lasts only until the current message has been received. The message-specific
27850 controls always apply to the whole message, not to individual recipients,
27851 even if the &%control%& modifier appears in a RCPT ACL.
27852
27853 As there are now quite a few controls that can be applied, they are described
27854 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27855 in several different ways. For example:
27856
27857 . ==== As this is a nested list, any displays it contains must be indented
27858 . ==== as otherwise they are too far to the left. That comment applies only
27859 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27860 . ==== way.
27861
27862 .ilist
27863 It can be at the end of an &%accept%& statement:
27864 .code
27865     accept  ...some conditions
27866             control = queue_only
27867 .endd
27868 In this case, the control is applied when this statement yields &"accept"&, in
27869 other words, when the conditions are all true.
27870
27871 .next
27872 It can be in the middle of an &%accept%& statement:
27873 .code
27874     accept  ...some conditions...
27875             control = queue_only
27876             ...some more conditions...
27877 .endd
27878 If the first set of conditions are true, the control is applied, even if the
27879 statement does not accept because one of the second set of conditions is false.
27880 In this case, some subsequent statement must yield &"accept"& for the control
27881 to be relevant.
27882
27883 .next
27884 It can be used with &%warn%& to apply the control, leaving the
27885 decision about accepting or denying to a subsequent verb. For
27886 example:
27887 .code
27888     warn    ...some conditions...
27889             control = freeze
27890     accept  ...
27891 .endd
27892 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27893 &%logwrite%&, so it does not add anything to the message and does not write a
27894 log entry.
27895
27896 .next
27897 If you want to apply a control unconditionally, you can use it with a
27898 &%require%& verb. For example:
27899 .code
27900     require  control = no_multiline_responses
27901 .endd
27902 .endlist
27903
27904 .vitem &*delay*&&~=&~<&'time'&>
27905 .cindex "&%delay%& ACL modifier"
27906 .oindex "&%-bh%&"
27907 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27908 the time interval before proceeding. However, when testing Exim using the
27909 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27910 output instead). The time is given in the usual Exim notation, and the delay
27911 happens as soon as the modifier is processed. In an SMTP session, pending
27912 output is flushed before the delay is imposed.
27913
27914 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27915 example:
27916 .code
27917 deny    ...some conditions...
27918         delay = 30s
27919 .endd
27920 The delay happens if all the conditions are true, before the statement returns
27921 &"deny"&. Compare this with:
27922 .code
27923 deny    delay = 30s
27924         ...some conditions...
27925 .endd
27926 which waits for 30s before processing the conditions. The &%delay%& modifier
27927 can also be used with &%warn%& and together with &%control%&:
27928 .code
27929 warn    ...some conditions...
27930         delay = 2m
27931         control = freeze
27932 accept  ...
27933 .endd
27934
27935 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27936 responses to several commands are no longer buffered and sent in one packet (as
27937 they would normally be) because all output is flushed before imposing the
27938 delay. This optimization is disabled so that a number of small delays do not
27939 appear to the client as one large aggregated delay that might provoke an
27940 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27941 using a &%control%& modifier to set &%no_delay_flush%&.
27942
27943
27944 .vitem &*endpass*&
27945 .cindex "&%endpass%& ACL modifier"
27946 This modifier, which has no argument, is recognized only in &%accept%& and
27947 &%discard%& statements. It marks the boundary between the conditions whose
27948 failure causes control to pass to the next statement, and the conditions whose
27949 failure causes the ACL to return &"deny"&. This concept has proved to be
27950 confusing to some people, so the use of &%endpass%& is no longer recommended as
27951 &"best practice"&. See the description of &%accept%& above for more details.
27952
27953
27954 .vitem &*log_message*&&~=&~<&'text'&>
27955 .cindex "&%log_message%& ACL modifier"
27956 This modifier sets up a message that is used as part of the log message if the
27957 ACL denies access or a &%warn%& statement's conditions are true. For example:
27958 .code
27959 require log_message = wrong cipher suite $tls_in_cipher
27960         encrypted   = DES-CBC3-SHA
27961 .endd
27962 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27963 example:
27964 .display
27965 &`discard `&<&'some conditions'&>
27966 &`        log_message = Discarded $local_part@$domain because...`&
27967 .endd
27968 When access is denied, &%log_message%& adds to any underlying error message
27969 that may exist because of a condition failure. For example, while verifying a
27970 recipient address, a &':fail:'& redirection might have already set up a
27971 message.
27972
27973 The message may be defined before the conditions to which it applies, because
27974 the string expansion does not happen until Exim decides that access is to be
27975 denied. This means that any variables that are set by the condition are
27976 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27977 variables are set after a DNS black list lookup succeeds. If the expansion of
27978 &%log_message%& fails, or if the result is an empty string, the modifier is
27979 ignored.
27980
27981 .vindex "&$acl_verify_message$&"
27982 If you want to use a &%warn%& statement to log the result of an address
27983 verification, you can use &$acl_verify_message$& to include the verification
27984 error message.
27985
27986 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27987 the start of the logged message. If the same warning log message is requested
27988 more than once while receiving  a single email message, only one copy is
27989 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27990 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27991 is logged for a successful &%warn%& statement.
27992
27993 If &%log_message%& is not present and there is no underlying error message (for
27994 example, from the failure of address verification), but &%message%& is present,
27995 the &%message%& text is used for logging rejections. However, if any text for
27996 logging contains newlines, only the first line is logged. In the absence of
27997 both &%log_message%& and &%message%&, a default built-in message is used for
27998 logging rejections.
27999
28000
28001 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28002 .cindex "&%log_reject_target%& ACL modifier"
28003 .cindex "logging in ACL" "specifying which log"
28004 This modifier makes it possible to specify which logs are used for messages
28005 about ACL rejections. Its argument is a colon-separated list of words that can
28006 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28007 may be empty, in which case a rejection is not logged at all. For example, this
28008 ACL fragment writes no logging information when access is denied:
28009 .display
28010 &`deny `&<&'some conditions'&>
28011 &`     log_reject_target =`&
28012 .endd
28013 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28014 permanent and temporary rejections. Its effect lasts for the rest of the
28015 current ACL.
28016
28017
28018 .vitem &*logwrite*&&~=&~<&'text'&>
28019 .cindex "&%logwrite%& ACL modifier"
28020 .cindex "logging in ACL" "immediate"
28021 This modifier writes a message to a log file as soon as it is encountered when
28022 processing an ACL. (Compare &%log_message%&, which, except in the case of
28023 &%warn%& and &%discard%&, is used only if the ACL statement denies
28024 access.) The &%logwrite%& modifier can be used to log special incidents in
28025 ACLs. For example:
28026 .display
28027 &`accept `&<&'some special conditions'&>
28028 &`       control  = freeze`&
28029 &`       logwrite = froze message because ...`&
28030 .endd
28031 By default, the message is written to the main log. However, it may begin
28032 with a colon, followed by a comma-separated list of log names, and then
28033 another colon, to specify exactly which logs are to be written. For
28034 example:
28035 .code
28036 logwrite = :main,reject: text for main and reject logs
28037 logwrite = :panic: text for panic log only
28038 .endd
28039
28040
28041 .vitem &*message*&&~=&~<&'text'&>
28042 .cindex "&%message%& ACL modifier"
28043 This modifier sets up a text string that is expanded and used as a response
28044 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28045 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28046 there is some complication if &%endpass%& is involved; see the description of
28047 &%accept%& for details.)
28048
28049 The expansion of the message happens at the time Exim decides that the ACL is
28050 to end, not at the time it processes &%message%&. If the expansion fails, or
28051 generates an empty string, the modifier is ignored. Here is an example where
28052 &%message%& must be specified first, because the ACL ends with a rejection if
28053 the &%hosts%& condition fails:
28054 .code
28055 require  message = Host not recognized
28056          hosts = 10.0.0.0/8
28057 .endd
28058 (Once a condition has failed, no further conditions or modifiers are
28059 processed.)
28060
28061 .cindex "SMTP" "error codes"
28062 .oindex "&%smtp_banner%&
28063 For ACLs that are triggered by SMTP commands, the message is returned as part
28064 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28065 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28066 is accepted. In the case of the connect ACL, accepting with a message modifier
28067 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28068 accept message may not contain more than one line (otherwise it will be
28069 truncated at the first newline and a panic logged), and it cannot affect the
28070 EHLO options.
28071
28072 When SMTP is involved, the message may begin with an overriding response code,
28073 consisting of three digits optionally followed by an &"extended response code"&
28074 of the form &'n.n.n'&, each code being followed by a space. For example:
28075 .code
28076 deny  message = 599 1.2.3 Host not welcome
28077       hosts = 192.168.34.0/24
28078 .endd
28079 The first digit of the supplied response code must be the same as would be sent
28080 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28081 access, but for the predata ACL, note that the default success code is 354, not
28082 2&'xx'&.
28083
28084 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28085 the message modifier cannot override the 221 response code.
28086
28087 The text in a &%message%& modifier is literal; any quotes are taken as
28088 literals, but because the string is expanded, backslash escapes are processed
28089 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28090 response.
28091
28092 .vindex "&$acl_verify_message$&"
28093 For ACLs that are called by an &%acl =%& ACL condition, the message is
28094 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28095
28096 If &%message%& is used on a statement that verifies an address, the message
28097 specified overrides any message that is generated by the verification process.
28098 However, the original message is available in the variable
28099 &$acl_verify_message$&, so you can incorporate it into your message if you
28100 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28101 routers to be passed back as part of the SMTP response, you should either not
28102 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28103
28104 For compatibility with previous releases of Exim, a &%message%& modifier that
28105 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28106 modifier, but this usage is now deprecated. However, &%message%& acts only when
28107 all the conditions are true, wherever it appears in an ACL command, whereas
28108 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28109 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28110 effect.
28111
28112
28113 .vitem &*remove_header*&&~=&~<&'text'&>
28114 This modifier specifies one or more header names in a colon-separated list
28115  that are to be removed from an incoming message, assuming, of course, that
28116 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28117
28118
28119 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28120 .cindex "&%set%& ACL modifier"
28121 This modifier puts a value into one of the ACL variables (see section
28122 &<<SECTaclvariables>>&).
28123
28124
28125 .vitem &*udpsend*&&~=&~<&'parameters'&>
28126 This modifier sends a UDP packet, for purposes such as statistics
28127 collection or behaviour monitoring. The parameters are expanded, and
28128 the result of the expansion must be a colon-separated list consisting
28129 of a destination server, port number, and the packet contents. The
28130 server can be specified as a host name or IPv4 or IPv6 address. The
28131 separator can be changed with the usual angle bracket syntax. For
28132 example, you might want to collect information on which hosts connect
28133 when:
28134 .code
28135 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28136              $tod_zulu $sender_host_address
28137 .endd
28138 .endlist
28139
28140
28141
28142
28143 .section "Use of the control modifier" "SECTcontrols"
28144 .cindex "&%control%& ACL modifier"
28145 The &%control%& modifier supports the following settings:
28146
28147 .vlist
28148 .vitem &*control&~=&~allow_auth_unadvertised*&
28149 This modifier allows a client host to use the SMTP AUTH command even when it
28150 has not been advertised in response to EHLO. Furthermore, because there are
28151 apparently some really broken clients that do this, Exim will accept AUTH after
28152 HELO (rather than EHLO) when this control is set. It should be used only if you
28153 really need it, and you should limit its use to those broken clients that do
28154 not work without it. For example:
28155 .code
28156 warn hosts   = 192.168.34.25
28157      control = allow_auth_unadvertised
28158 .endd
28159 Normally, when an Exim server receives an AUTH command, it checks the name of
28160 the authentication mechanism that is given in the command to ensure that it
28161 matches an advertised mechanism. When this control is set, the check that a
28162 mechanism has been advertised is bypassed. Any configured mechanism can be used
28163 by the client. This control is permitted only in the connection and HELO ACLs.
28164
28165
28166 .vitem &*control&~=&~caseful_local_part*& &&&
28167        &*control&~=&~caselower_local_part*&
28168 .cindex "&ACL;" "case of local part in"
28169 .cindex "case of local parts"
28170 .vindex "&$local_part$&"
28171 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28172 (that is, during RCPT processing). By default, the contents of &$local_part$&
28173 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28174 any uppercase letters in the original local part are restored in &$local_part$&
28175 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28176 is encountered.
28177
28178 These controls affect only the current recipient. Moreover, they apply only to
28179 local part handling that takes place directly in the ACL (for example, as a key
28180 in lookups). If a test to verify the recipient is obeyed, the case-related
28181 handling of the local part during the verification is controlled by the router
28182 configuration (see the &%caseful_local_part%& generic router option).
28183
28184 This facility could be used, for example, to add a spam score to local parts
28185 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28186 spam score:
28187 .code
28188 warn  control = caseful_local_part
28189       set acl_m4 = ${eval:\
28190                      $acl_m4 + \
28191                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28192                     }
28193       control = caselower_local_part
28194 .endd
28195 Notice that we put back the lower cased version afterwards, assuming that
28196 is what is wanted for subsequent tests.
28197
28198
28199 .vitem &*control&~=&~cutthrough_delivery*&
28200 .cindex "&ACL;" "cutthrough routing"
28201 .cindex "cutthrough" "requesting"
28202 This option requests delivery be attempted while the item is being received.
28203
28204 The option is usable in the RCPT ACL.
28205 If enabled for a message recieved via smtp and routed to an smtp transport,
28206 and only one transport, interface, destination host and port combination
28207 is used for all recipients of the message,
28208 then the delivery connection is made while the receiving connection is open
28209 and data is copied from one to the other.
28210
28211 An attempt to set this option for any recipient but the first
28212 for a mail will be quietly ignored.
28213 If a recipient-verify callout connection is subsequently
28214 requested in the same ACL it is held open and used for
28215 any subsequent receipients and the data,
28216 otherwise one is made after the initial RCPT ACL completes.
28217
28218 Note that routers are used in verify mode,
28219 and cannot depend on content of received headers.
28220 Note also that headers cannot be
28221 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28222 Headers may be modified by routers (subject to the above) and transports.
28223
28224 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28225 of outgoing messages is done, because it sends data to the ultimate destination
28226 before the entire message has been received from the source.
28227 It is not supported for messages recieved with the SMTP PRDR option in use.
28228
28229 Should the ultimate destination system positively accept or reject the mail,
28230 a corresponding indication is given to the source system and nothing is queued.
28231 If there is a temporary error the item is queued for later delivery in the
28232 usual fashion. If the item is successfully delivered in cutthrough mode
28233 the delivery log lines are tagged with ">>" rather than "=>" and appear
28234 before the acceptance "<=" line.
28235
28236 Delivery in this mode avoids the generation of a bounce mail to a
28237 (possibly faked)
28238 sender when the destination system is doing content-scan based rejection.
28239
28240
28241 .vitem &*control&~=&~debug/*&<&'options'&>
28242 .cindex "&ACL;" "enabling debug logging"
28243 .cindex "debugging" "enabling from an ACL"
28244 This control turns on debug logging, almost as though Exim had been invoked
28245 with &`-d`&, with the output going to a new logfile, by default called
28246 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28247 may access any variables already defined.  The logging may be adjusted with
28248 the &'opts'& option, which takes the same values as the &`-d`& command-line
28249 option.  Some examples (which depend on variables that don't exist in all
28250 contexts):
28251 .code
28252       control = debug
28253       control = debug/tag=.$sender_host_address
28254       control = debug/opts=+expand+acl
28255       control = debug/tag=.$message_exim_id/opts=+expand
28256 .endd
28257
28258
28259 .vitem &*control&~=&~dkim_disable_verify*&
28260 .cindex "disable DKIM verify"
28261 .cindex "DKIM" "disable verify"
28262 This control turns off DKIM verification processing entirely.  For details on
28263 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28264
28265
28266 .vitem &*control&~=&~dscp/*&<&'value'&>
28267 .cindex "&ACL;" "setting DSCP value"
28268 .cindex "DSCP" "inbound"
28269 This option causes the DSCP value associated with the socket for the inbound
28270 connection to be adjusted to a given value, given as one of a number of fixed
28271 strings or to numeric value.
28272 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28273 Common values include &`throughput`&, &`mincost`&, and on newer systems
28274 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28275
28276 The outbound packets from Exim will be marked with this value in the header
28277 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28278 that these values will have any effect, not be stripped by networking
28279 equipment, or do much of anything without cooperation with your Network
28280 Engineer and those of all network operators between the source and destination.
28281
28282
28283 .vitem &*control&~=&~enforce_sync*& &&&
28284        &*control&~=&~no_enforce_sync*&
28285 .cindex "SMTP" "synchronization checking"
28286 .cindex "synchronization checking in SMTP"
28287 These controls make it possible to be selective about when SMTP synchronization
28288 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28289 state of the switch (it is true by default). See the description of this option
28290 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28291
28292 The effect of these two controls lasts for the remainder of the SMTP
28293 connection. They can appear in any ACL except the one for the non-SMTP
28294 messages. The most straightforward place to put them is in the ACL defined by
28295 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28296 before the first synchronization check. The expected use is to turn off the
28297 synchronization checks for badly-behaved hosts that you nevertheless need to
28298 work with.
28299
28300
28301 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28302 .cindex "fake defer"
28303 .cindex "defer, fake"
28304 This control works in exactly the same way as &%fakereject%& (described below)
28305 except that it causes an SMTP 450 response after the message data instead of a
28306 550 response. You must take care when using &%fakedefer%& because it causes the
28307 messages to be duplicated when the sender retries. Therefore, you should not
28308 use &%fakedefer%& if the message is to be delivered normally.
28309
28310 .vitem &*control&~=&~fakereject/*&<&'message'&>
28311 .cindex "fake rejection"
28312 .cindex "rejection, fake"
28313 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28314 words, only when an SMTP message is being received. If Exim accepts the
28315 message, instead the final 250 response, a 550 rejection message is sent.
28316 However, Exim proceeds to deliver the message as normal. The control applies
28317 only to the current message, not to any subsequent ones that may be received in
28318 the same SMTP connection.
28319
28320 The text for the 550 response is taken from the &%control%& modifier. If no
28321 message is supplied, the following is used:
28322 .code
28323 550-Your message has been rejected but is being
28324 550-kept for evaluation.
28325 550-If it was a legitimate message, it may still be
28326 550 delivered to the target recipient(s).
28327 .endd
28328 This facility should be used with extreme caution.
28329
28330 .vitem &*control&~=&~freeze*&
28331 .cindex "frozen messages" "forcing in ACL"
28332 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28333 other words, only when a message is being received. If the message is accepted,
28334 it is placed on Exim's queue and frozen. The control applies only to the
28335 current message, not to any subsequent ones that may be received in the same
28336 SMTP connection.
28337
28338 This modifier can optionally be followed by &`/no_tell`&. If the global option
28339 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28340 is told about the freezing), provided all the &*control=freeze*& modifiers that
28341 are obeyed for the current message have the &`/no_tell`& option.
28342
28343 .vitem &*control&~=&~no_delay_flush*&
28344 .cindex "SMTP" "output flushing, disabling for delay"
28345 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28346 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28347 use. This control, as long as it is encountered before the &%delay%& modifier,
28348 disables such output flushing.
28349
28350 .vitem &*control&~=&~no_callout_flush*&
28351 .cindex "SMTP" "output flushing, disabling for callout"
28352 Exim normally flushes SMTP output before performing a callout in an ACL, to
28353 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28354 use. This control, as long as it is encountered before the &%verify%& condition
28355 that causes the callout, disables such output flushing.
28356
28357 .vitem &*control&~=&~no_mbox_unspool*&
28358 This control is available when Exim is compiled with the content scanning
28359 extension. Content scanning may require a copy of the current message, or parts
28360 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28361 or spam scanner. Normally, such copies are deleted when they are no longer
28362 needed. If this control is set, the copies are not deleted. The control applies
28363 only to the current message, not to any subsequent ones that may be received in
28364 the same SMTP connection. It is provided for debugging purposes and is unlikely
28365 to be useful in production.
28366
28367 .vitem &*control&~=&~no_multiline_responses*&
28368 .cindex "multiline responses, suppressing"
28369 This control is permitted for any ACL except the one for non-SMTP messages.
28370 It seems that there are broken clients in use that cannot handle multiline
28371 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28372
28373 If this control is set, multiline SMTP responses from ACL rejections are
28374 suppressed. One way of doing this would have been to put out these responses as
28375 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28376 (&"use multiline responses for more"& it says &-- ha!), and some of the
28377 responses might get close to that. So this facility, which is after all only a
28378 sop to broken clients, is implemented by doing two very easy things:
28379
28380 .ilist
28381 Extra information that is normally output as part of a rejection caused by
28382 sender verification failure is omitted. Only the final line (typically &"sender
28383 verification failed"&) is sent.
28384 .next
28385 If a &%message%& modifier supplies a multiline response, only the first
28386 line is output.
28387 .endlist
28388
28389 The setting of the switch can, of course, be made conditional on the
28390 calling host. Its effect lasts until the end of the SMTP connection.
28391
28392 .vitem &*control&~=&~no_pipelining*&
28393 .cindex "PIPELINING" "suppressing advertising"
28394 This control turns off the advertising of the PIPELINING extension to SMTP in
28395 the current session. To be useful, it must be obeyed before Exim sends its
28396 response to an EHLO command. Therefore, it should normally appear in an ACL
28397 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28398 &%pipelining_advertise_hosts%&.
28399
28400 .vitem &*control&~=&~queue_only*&
28401 .oindex "&%queue_only%&"
28402 .cindex "queueing incoming messages"
28403 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28404 other words, only when a message is being received. If the message is accepted,
28405 it is placed on Exim's queue and left there for delivery by a subsequent queue
28406 runner. No immediate delivery process is started. In other words, it has the
28407 effect as the &%queue_only%& global option. However, the control applies only
28408 to the current message, not to any subsequent ones that may be received in the
28409 same SMTP connection.
28410
28411 .vitem &*control&~=&~submission/*&<&'options'&>
28412 .cindex "message" "submission"
28413 .cindex "submission mode"
28414 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28415 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28416 the current message is a submission from a local MUA. In this case, Exim
28417 operates in &"submission mode"&, and applies certain fixups to the message if
28418 necessary. For example, it adds a &'Date:'& header line if one is not present.
28419 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28420 late (the message has already been created).
28421
28422 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28423 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28424 submission mode; the available options for this control are described there.
28425 The control applies only to the current message, not to any subsequent ones
28426 that may be received in the same SMTP connection.
28427
28428 .vitem &*control&~=&~suppress_local_fixups*&
28429 .cindex "submission fixups, suppressing"
28430 This control applies to locally submitted (non TCP/IP) messages, and is the
28431 complement of &`control = submission`&. It disables the fixups that are
28432 normally applied to locally-submitted messages. Specifically:
28433
28434 .ilist
28435 Any &'Sender:'& header line is left alone (in this respect, it is a
28436 dynamic version of &%local_sender_retain%&).
28437 .next
28438 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28439 .next
28440 There is no check that &'From:'& corresponds to the actual sender.
28441 .endlist ilist
28442
28443 This control may be useful when a remotely-originated message is accepted,
28444 passed to some scanning program, and then re-submitted for delivery. It can be
28445 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28446 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28447 data is read.
28448
28449 &*Note:*& This control applies only to the current message, not to any others
28450 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28451 .endlist vlist
28452
28453
28454 .section "Summary of message fixup control" "SECTsummesfix"
28455 All four possibilities for message fixups can be specified:
28456
28457 .ilist
28458 Locally submitted, fixups applied: the default.
28459 .next
28460 Locally submitted, no fixups applied: use
28461 &`control = suppress_local_fixups`&.
28462 .next
28463 Remotely submitted, no fixups applied: the default.
28464 .next
28465 Remotely submitted, fixups applied: use &`control = submission`&.
28466 .endlist
28467
28468
28469
28470 .section "Adding header lines in ACLs" "SECTaddheadacl"
28471 .cindex "header lines" "adding in an ACL"
28472 .cindex "header lines" "position of added lines"
28473 .cindex "&%add_header%& ACL modifier"
28474 The &%add_header%& modifier can be used to add one or more extra header lines
28475 to an incoming message, as in this example:
28476 .code
28477 warn dnslists = sbl.spamhaus.org : \
28478                 dialup.mail-abuse.org
28479      add_header = X-blacklisted-at: $dnslist_domain
28480 .endd
28481 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28482 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28483 receiving a message). The message must ultimately be accepted for
28484 &%add_header%& to have any significant effect. You can use &%add_header%& with
28485 any ACL verb, including &%deny%& (though this is potentially useful only in a
28486 RCPT ACL).
28487
28488 Headers will not be added to the message if the modifier is used in
28489 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28490
28491 Leading and trailing newlines are removed from
28492 the data for the &%add_header%& modifier; if it then
28493 contains one or more newlines that
28494 are not followed by a space or a tab, it is assumed to contain multiple header
28495 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28496 front of any line that is not a valid header line.
28497
28498 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28499 They are added to the message before processing the DATA and MIME ACLs.
28500 However, if an identical header line is requested more than once, only one copy
28501 is actually added to the message. Further header lines may be accumulated
28502 during the DATA and MIME ACLs, after which they are added to the message, again
28503 with duplicates suppressed. Thus, it is possible to add two identical header
28504 lines to an SMTP message, but only if one is added before DATA and one after.
28505 In the case of non-SMTP messages, new headers are accumulated during the
28506 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28507 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28508 are included in the entry that is written to the reject log.
28509
28510 .cindex "header lines" "added; visibility of"
28511 Header lines are not visible in string expansions
28512 of message headers
28513 until they are added to the
28514 message. It follows that header lines defined in the MAIL, RCPT, and predata
28515 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28516 header lines that are added by the DATA or MIME ACLs are not visible in those
28517 ACLs. Because of this restriction, you cannot use header lines as a way of
28518 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28519 this, you can use ACL variables, as described in section
28520 &<<SECTaclvariables>>&.
28521
28522 The list of headers yet to be added is given by the &%$headers_added%& variable.
28523
28524 The &%add_header%& modifier acts immediately as it is encountered during the
28525 processing of an ACL. Notice the difference between these two cases:
28526 .display
28527 &`accept add_header = ADDED: some text`&
28528 &`       `&<&'some condition'&>
28529
28530 &`accept `&<&'some condition'&>
28531 &`       add_header = ADDED: some text`&
28532 .endd
28533 In the first case, the header line is always added, whether or not the
28534 condition is true. In the second case, the header line is added only if the
28535 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28536 ACL statement. All those that are encountered before a condition fails are
28537 honoured.
28538
28539 .cindex "&%warn%& ACL verb"
28540 For compatibility with previous versions of Exim, a &%message%& modifier for a
28541 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28542 effect only if all the conditions are true, even if it appears before some of
28543 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28544 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28545 are present on a &%warn%& verb, both are processed according to their
28546 specifications.
28547
28548 By default, new header lines are added to a message at the end of the existing
28549 header lines. However, you can specify that any particular header line should
28550 be added right at the start (before all the &'Received:'& lines), immediately
28551 after the first block of &'Received:'& lines, or immediately before any line
28552 that is not a &'Received:'& or &'Resent-something:'& header.
28553
28554 This is done by specifying &":at_start:"&, &":after_received:"&, or
28555 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28556 header line, respectively. (Header text cannot start with a colon, as there has
28557 to be a header name first.) For example:
28558 .code
28559 warn add_header = \
28560        :after_received:X-My-Header: something or other...
28561 .endd
28562 If more than one header line is supplied in a single &%add_header%& modifier,
28563 each one is treated independently and can therefore be placed differently. If
28564 you add more than one line at the start, or after the Received: block, they end
28565 up in reverse order.
28566
28567 &*Warning*&: This facility currently applies only to header lines that are
28568 added in an ACL. It does NOT work for header lines that are added in a
28569 system filter or in a router or transport.
28570
28571
28572
28573 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28574 .cindex "header lines" "removing in an ACL"
28575 .cindex "header lines" "position of removed lines"
28576 .cindex "&%remove_header%& ACL modifier"
28577 The &%remove_header%& modifier can be used to remove one or more header lines
28578 from an incoming message, as in this example:
28579 .code
28580 warn   message        = Remove internal headers
28581        remove_header  = x-route-mail1 : x-route-mail2
28582 .endd
28583 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28584 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28585 receiving a message). The message must ultimately be accepted for
28586 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28587 with any ACL verb, including &%deny%&, though this is really not useful for
28588 any verb that doesn't result in a delivered message.
28589
28590 Headers will not be removed to the message if the modifier is used in
28591 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28592
28593 More than one header can be removed at the same time by using a colon separated
28594 list of header names. The header matching is case insensitive. Wildcards are
28595 not permitted, nor is list expansion performed, so you cannot use hostlists to
28596 create a list of headers, however both connection and message variable expansion
28597 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28598 .code
28599 warn   hosts           = +internal_hosts
28600        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28601 warn   message         = Remove internal headers
28602        remove_header   = $acl_c_ihdrs
28603 .endd
28604 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28605 They are removed from the message before processing the DATA and MIME ACLs.
28606 There is no harm in attempting to remove the same header twice nor is removing
28607 a non-existent header. Further header lines to be removed may be accumulated
28608 during the DATA and MIME ACLs, after which they are removed from the message,
28609 if present. In the case of non-SMTP messages, headers to be removed are
28610 accumulated during the non-SMTP ACLs, and are removed from the message after
28611 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28612 ACL, there really is no effect because there is no logging of what headers
28613 would have been removed.
28614
28615 .cindex "header lines" "removed; visibility of"
28616 Header lines are not visible in string expansions until the DATA phase when it
28617 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28618 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28619 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28620 this restriction, you cannot use header lines as a way of controlling data
28621 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28622 you should instead use ACL variables, as described in section
28623 &<<SECTaclvariables>>&.
28624
28625 The &%remove_header%& modifier acts immediately as it is encountered during the
28626 processing of an ACL. Notice the difference between these two cases:
28627 .display
28628 &`accept remove_header = X-Internal`&
28629 &`       `&<&'some condition'&>
28630
28631 &`accept `&<&'some condition'&>
28632 &`       remove_header = X-Internal`&
28633 .endd
28634 In the first case, the header line is always removed, whether or not the
28635 condition is true. In the second case, the header line is removed only if the
28636 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28637 same ACL statement. All those that are encountered before a condition fails
28638 are honoured.
28639
28640 &*Warning*&: This facility currently applies only to header lines that are
28641 present during ACL processing. It does NOT remove header lines that are added
28642 in a system filter or in a router or transport.
28643
28644
28645
28646
28647 .section "ACL conditions" "SECTaclconditions"
28648 .cindex "&ACL;" "conditions; list of"
28649 Some of the conditions listed in this section are available only when Exim is
28650 compiled with the content-scanning extension. They are included here briefly
28651 for completeness. More detailed descriptions can be found in the discussion on
28652 content scanning in chapter &<<CHAPexiscan>>&.
28653
28654 Not all conditions are relevant in all circumstances. For example, testing
28655 senders and recipients does not make sense in an ACL that is being run as the
28656 result of the arrival of an ETRN command, and checks on message headers can be
28657 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28658 can use the same condition (with different parameters) more than once in the
28659 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28660 The conditions are as follows:
28661
28662
28663 .vlist
28664 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28665 .cindex "&ACL;" "nested"
28666 .cindex "&ACL;" "indirect"
28667 .cindex "&ACL;" "arguments"
28668 .cindex "&%acl%& ACL condition"
28669 The possible values of the argument are the same as for the
28670 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28671 &"accept"& the condition is true; if it returns &"deny"& the condition is
28672 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28673 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28674 condition false. This means that further processing of the &%warn%& verb
28675 ceases, but processing of the ACL continues.
28676
28677 If the argument is a named ACL, up to nine space-separated optional values
28678 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28679 and $acl_narg is set to the count of values.
28680 Previous values of these variables are restored after the call returns.
28681 The name and values are expanded separately.
28682 Note that spaces in complex expansions which are used as arguments
28683 will act as argument separators.
28684
28685 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28686 the connection is dropped. If it returns &"discard"&, the verb must be
28687 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28688 conditions are tested.
28689
28690 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28691 loops. This condition allows you to use different ACLs in different
28692 circumstances. For example, different ACLs can be used to handle RCPT commands
28693 for different local users or different local domains.
28694
28695 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28696 .cindex "&%authenticated%& ACL condition"
28697 .cindex "authentication" "ACL checking"
28698 .cindex "&ACL;" "testing for authentication"
28699 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28700 the name of the authenticator is tested against the list. To test for
28701 authentication by any authenticator, you can set
28702 .code
28703 authenticated = *
28704 .endd
28705
28706 .vitem &*condition&~=&~*&<&'string'&>
28707 .cindex "&%condition%& ACL condition"
28708 .cindex "customizing" "ACL condition"
28709 .cindex "&ACL;" "customized test"
28710 .cindex "&ACL;" "testing, customized"
28711 This feature allows you to make up custom conditions. If the result of
28712 expanding the string is an empty string, the number zero, or one of the strings
28713 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28714 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28715 any other value, some error is assumed to have occurred, and the ACL returns
28716 &"defer"&. However, if the expansion is forced to fail, the condition is
28717 ignored. The effect is to treat it as true, whether it is positive or
28718 negative.
28719
28720 .vitem &*decode&~=&~*&<&'location'&>
28721 .cindex "&%decode%& ACL condition"
28722 This condition is available only when Exim is compiled with the
28723 content-scanning extension, and it is allowed only in the ACL defined by
28724 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28725 If all goes well, the condition is true. It is false only if there are
28726 problems such as a syntax error or a memory shortage. For more details, see
28727 chapter &<<CHAPexiscan>>&.
28728
28729 .vitem &*demime&~=&~*&<&'extension&~list'&>
28730 .cindex "&%demime%& ACL condition"
28731 This condition is available only when Exim is compiled with the
28732 content-scanning extension. Its use is described in section
28733 &<<SECTdemimecond>>&.
28734
28735 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28736 .cindex "&%dnslists%& ACL condition"
28737 .cindex "DNS list" "in ACL"
28738 .cindex "black list (DNS)"
28739 .cindex "&ACL;" "testing a DNS list"
28740 This condition checks for entries in DNS black lists. These are also known as
28741 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28742 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28743 different variants of this condition to describe briefly here. See sections
28744 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28745
28746 .vitem &*domains&~=&~*&<&'domain&~list'&>
28747 .cindex "&%domains%& ACL condition"
28748 .cindex "domain" "ACL checking"
28749 .cindex "&ACL;" "testing a recipient domain"
28750 .vindex "&$domain_data$&"
28751 This condition is relevant only after a RCPT command. It checks that the domain
28752 of the recipient address is in the domain list. If percent-hack processing is
28753 enabled, it is done before this test is done. If the check succeeds with a
28754 lookup, the result of the lookup is placed in &$domain_data$& until the next
28755 &%domains%& test.
28756
28757 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28758 use &%domains%& in a DATA ACL.
28759
28760
28761 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28762 .cindex "&%encrypted%& ACL condition"
28763 .cindex "encryption" "checking in an ACL"
28764 .cindex "&ACL;" "testing for encryption"
28765 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28766 name of the cipher suite in use is tested against the list. To test for
28767 encryption without testing for any specific cipher suite(s), set
28768 .code
28769 encrypted = *
28770 .endd
28771
28772
28773 .vitem &*hosts&~=&~*&<&'host&~list'&>
28774 .cindex "&%hosts%& ACL condition"
28775 .cindex "host" "ACL checking"
28776 .cindex "&ACL;" "testing the client host"
28777 This condition tests that the calling host matches the host list. If you have
28778 name lookups or wildcarded host names and IP addresses in the same host list,
28779 you should normally put the IP addresses first. For example, you could have:
28780 .code
28781 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28782 .endd
28783 The lookup in this example uses the host name for its key. This is implied by
28784 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28785 and it wouldn't matter which way round you had these two items.)
28786
28787 The reason for the problem with host names lies in the left-to-right way that
28788 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28789 but when it reaches an item that requires a host name, it fails if it cannot
28790 find a host name to compare with the pattern. If the above list is given in the
28791 opposite order, the &%accept%& statement fails for a host whose name cannot be
28792 found, even if its IP address is 10.9.8.7.
28793
28794 If you really do want to do the name check first, and still recognize the IP
28795 address even if the name lookup fails, you can rewrite the ACL like this:
28796 .code
28797 accept hosts = dbm;/etc/friendly/hosts
28798 accept hosts = 10.9.8.7
28799 .endd
28800 The default action on failing to find the host name is to assume that the host
28801 is not in the list, so the first &%accept%& statement fails. The second
28802 statement can then check the IP address.
28803
28804 .vindex "&$host_data$&"
28805 If a &%hosts%& condition is satisfied by means of a lookup, the result
28806 of the lookup is made available in the &$host_data$& variable. This
28807 allows you, for example, to set up a statement like this:
28808 .code
28809 deny  hosts = net-lsearch;/some/file
28810 message = $host_data
28811 .endd
28812 which gives a custom error message for each denied host.
28813
28814 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28815 .cindex "&%local_parts%& ACL condition"
28816 .cindex "local part" "ACL checking"
28817 .cindex "&ACL;" "testing a local part"
28818 .vindex "&$local_part_data$&"
28819 This condition is relevant only after a RCPT command. It checks that the local
28820 part of the recipient address is in the list. If percent-hack processing is
28821 enabled, it is done before this test. If the check succeeds with a lookup, the
28822 result of the lookup is placed in &$local_part_data$&, which remains set until
28823 the next &%local_parts%& test.
28824
28825 .vitem &*malware&~=&~*&<&'option'&>
28826 .cindex "&%malware%& ACL condition"
28827 .cindex "&ACL;" "virus scanning"
28828 .cindex "&ACL;" "scanning for viruses"
28829 This condition is available only when Exim is compiled with the
28830 content-scanning extension. It causes the incoming message to be scanned for
28831 viruses. For details, see chapter &<<CHAPexiscan>>&.
28832
28833 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28834 .cindex "&%mime_regex%& ACL condition"
28835 .cindex "&ACL;" "testing by regex matching"
28836 This condition is available only when Exim is compiled with the
28837 content-scanning extension, and it is allowed only in the ACL defined by
28838 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28839 with any of the regular expressions. For details, see chapter
28840 &<<CHAPexiscan>>&.
28841
28842 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28843 .cindex "rate limiting"
28844 This condition can be used to limit the rate at which a user or host submits
28845 messages. Details are given in section &<<SECTratelimiting>>&.
28846
28847 .vitem &*recipients&~=&~*&<&'address&~list'&>
28848 .cindex "&%recipients%& ACL condition"
28849 .cindex "recipient" "ACL checking"
28850 .cindex "&ACL;" "testing a recipient"
28851 This condition is relevant only after a RCPT command. It checks the entire
28852 recipient address against a list of recipients.
28853
28854 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28855 .cindex "&%regex%& ACL condition"
28856 .cindex "&ACL;" "testing by regex matching"
28857 This condition is available only when Exim is compiled with the
28858 content-scanning extension, and is available only in the DATA, MIME, and
28859 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28860 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28861
28862 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28863 .cindex "&%sender_domains%& ACL condition"
28864 .cindex "sender" "ACL checking"
28865 .cindex "&ACL;" "testing a sender domain"
28866 .vindex "&$domain$&"
28867 .vindex "&$sender_address_domain$&"
28868 This condition tests the domain of the sender of the message against the given
28869 domain list. &*Note*&: The domain of the sender address is in
28870 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28871 of this condition. This is an exception to the general rule for testing domain
28872 lists. It is done this way so that, if this condition is used in an ACL for a
28873 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28874 influence the sender checking.
28875
28876 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28877 relaying, because sender addresses are easily, and commonly, forged.
28878
28879 .vitem &*senders&~=&~*&<&'address&~list'&>
28880 .cindex "&%senders%& ACL condition"
28881 .cindex "sender" "ACL checking"
28882 .cindex "&ACL;" "testing a sender"
28883 This condition tests the sender of the message against the given list. To test
28884 for a bounce message, which has an empty sender, set
28885 .code
28886 senders = :
28887 .endd
28888 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28889 relaying, because sender addresses are easily, and commonly, forged.
28890
28891 .vitem &*spam&~=&~*&<&'username'&>
28892 .cindex "&%spam%& ACL condition"
28893 .cindex "&ACL;" "scanning for spam"
28894 This condition is available only when Exim is compiled with the
28895 content-scanning extension. It causes the incoming message to be scanned by
28896 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28897
28898 .vitem &*verify&~=&~certificate*&
28899 .cindex "&%verify%& ACL condition"
28900 .cindex "TLS" "client certificate verification"
28901 .cindex "certificate" "verification of client"
28902 .cindex "&ACL;" "certificate verification"
28903 .cindex "&ACL;" "testing a TLS certificate"
28904 This condition is true in an SMTP session if the session is encrypted, and a
28905 certificate was received from the client, and the certificate was verified. The
28906 server requests a certificate only if the client matches &%tls_verify_hosts%&
28907 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28908
28909 .vitem &*verify&~=&~csa*&
28910 .cindex "CSA verification"
28911 This condition checks whether the sending host (the client) is authorized to
28912 send email. Details of how this works are given in section
28913 &<<SECTverifyCSA>>&.
28914
28915 .vitem &*verify&~=&~header_names_ascii*&
28916 .cindex "&%verify%& ACL condition"
28917 .cindex "&ACL;" "verifying header names only ASCII"
28918 .cindex "header lines" "verifying header names only ASCII"
28919 .cindex "verifying" "header names only ASCII"
28920 This condition is relevant only in an ACL that is run after a message has been
28921 received, that is, in an ACL specified by &%acl_smtp_data%& or
28922 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28923 there are no non-ASCII characters, also excluding control characters.  The
28924 allowable characters are decimal ASCII values 33 through 126.
28925
28926 Exim itself will handle headers with non-ASCII characters, but it can cause
28927 problems for downstream applications, so this option will allow their
28928 detection and rejection in the DATA ACL's.
28929
28930 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28931 .cindex "&%verify%& ACL condition"
28932 .cindex "&ACL;" "verifying sender in the header"
28933 .cindex "header lines" "verifying the sender in"
28934 .cindex "sender" "verifying in header"
28935 .cindex "verifying" "sender in header"
28936 This condition is relevant only in an ACL that is run after a message has been
28937 received, that is, in an ACL specified by &%acl_smtp_data%& or
28938 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28939 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28940 is loosely thought of as a &"sender"& address (hence the name of the test).
28941 However, an address that appears in one of these headers need not be an address
28942 that accepts bounce messages; only sender addresses in envelopes are required
28943 to accept bounces. Therefore, if you use the callout option on this check, you
28944 might want to arrange for a non-empty address in the MAIL command.
28945
28946 Details of address verification and the options are given later, starting at
28947 section &<<SECTaddressverification>>& (callouts are described in section
28948 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28949 condition to restrict it to bounce messages only:
28950 .code
28951 deny    senders = :
28952         message = A valid sender header is required for bounces
28953        !verify  = header_sender
28954 .endd
28955
28956 .vitem &*verify&~=&~header_syntax*&
28957 .cindex "&%verify%& ACL condition"
28958 .cindex "&ACL;" "verifying header syntax"
28959 .cindex "header lines" "verifying syntax"
28960 .cindex "verifying" "header syntax"
28961 This condition is relevant only in an ACL that is run after a message has been
28962 received, that is, in an ACL specified by &%acl_smtp_data%& or
28963 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28964 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28965 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28966 permitted only in locally generated messages and from hosts that match
28967 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28968 appropriate.
28969
28970 Note that this condition is a syntax check only. However, a common spamming
28971 ploy used to be to send syntactically invalid headers such as
28972 .code
28973 To: @
28974 .endd
28975 and this condition can be used to reject such messages, though they are not as
28976 common as they used to be.
28977
28978 .vitem &*verify&~=&~helo*&
28979 .cindex "&%verify%& ACL condition"
28980 .cindex "&ACL;" "verifying HELO/EHLO"
28981 .cindex "HELO" "verifying"
28982 .cindex "EHLO" "verifying"
28983 .cindex "verifying" "EHLO"
28984 .cindex "verifying" "HELO"
28985 This condition is true if a HELO or EHLO command has been received from the
28986 client host, and its contents have been verified. If there has been no previous
28987 attempt to verify the HELO/EHLO contents, it is carried out when this
28988 condition is encountered. See the description of the &%helo_verify_hosts%& and
28989 &%helo_try_verify_hosts%& options for details of how to request verification
28990 independently of this condition.
28991
28992 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28993 option), this condition is always true.
28994
28995
28996 .vitem &*verify&~=&~not_blind*&
28997 .cindex "verifying" "not blind"
28998 .cindex "bcc recipients, verifying none"
28999 This condition checks that there are no blind (bcc) recipients in the message.
29000 Every envelope recipient must appear either in a &'To:'& header line or in a
29001 &'Cc:'& header line for this condition to be true. Local parts are checked
29002 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29003 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29004 used only in a DATA or non-SMTP ACL.
29005
29006 There are, of course, many legitimate messages that make use of blind (bcc)
29007 recipients. This check should not be used on its own for blocking messages.
29008
29009
29010 .vitem &*verify&~=&~recipient/*&<&'options'&>
29011 .cindex "&%verify%& ACL condition"
29012 .cindex "&ACL;" "verifying recipient"
29013 .cindex "recipient" "verifying"
29014 .cindex "verifying" "recipient"
29015 .vindex "&$address_data$&"
29016 This condition is relevant only after a RCPT command. It verifies the current
29017 recipient. Details of address verification are given later, starting at section
29018 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29019 of &$address_data$& is the last value that was set while routing the address.
29020 This applies even if the verification fails. When an address that is being
29021 verified is redirected to a single address, verification continues with the new
29022 address, and in that case, the subsequent value of &$address_data$& is the
29023 value for the child address.
29024
29025 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29026 .cindex "&%verify%& ACL condition"
29027 .cindex "&ACL;" "verifying host reverse lookup"
29028 .cindex "host" "verifying reverse lookup"
29029 This condition ensures that a verified host name has been looked up from the IP
29030 address of the client host. (This may have happened already if the host name
29031 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29032 Verification ensures that the host name obtained from a reverse DNS lookup, or
29033 one of its aliases, does, when it is itself looked up in the DNS, yield the
29034 original IP address.
29035
29036 There is one possible option, &`defer_ok`&.  If this is present and a
29037 DNS operation returns a temporary error, the verify condition succeeds.
29038
29039 If this condition is used for a locally generated message (that is, when there
29040 is no client host involved), it always succeeds.
29041
29042 .vitem &*verify&~=&~sender/*&<&'options'&>
29043 .cindex "&%verify%& ACL condition"
29044 .cindex "&ACL;" "verifying sender"
29045 .cindex "sender" "verifying"
29046 .cindex "verifying" "sender"
29047 This condition is relevant only after a MAIL or RCPT command, or after a
29048 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29049 the message's sender is empty (that is, this is a bounce message), the
29050 condition is true. Otherwise, the sender address is verified.
29051
29052 .vindex "&$address_data$&"
29053 .vindex "&$sender_address_data$&"
29054 If there is data in the &$address_data$& variable at the end of routing, its
29055 value is placed in &$sender_address_data$& at the end of verification. This
29056 value can be used in subsequent conditions and modifiers in the same ACL
29057 statement. It does not persist after the end of the current statement. If you
29058 want to preserve the value for longer, you can save it in an ACL variable.
29059
29060 Details of verification are given later, starting at section
29061 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29062 to avoid doing it more than once per message.
29063
29064 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29065 .cindex "&%verify%& ACL condition"
29066 This is a variation of the previous option, in which a modified address is
29067 verified as a sender.
29068 .endlist
29069
29070
29071
29072 .section "Using DNS lists" "SECTmorednslists"
29073 .cindex "DNS list" "in ACL"
29074 .cindex "black list (DNS)"
29075 .cindex "&ACL;" "testing a DNS list"
29076 In its simplest form, the &%dnslists%& condition tests whether the calling host
29077 is on at least one of a number of DNS lists by looking up the inverted IP
29078 address in one or more DNS domains. (Note that DNS list domains are not mail
29079 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29080 special options instead.) For example, if the calling host's IP
29081 address is 192.168.62.43, and the ACL statement is
29082 .code
29083 deny dnslists = blackholes.mail-abuse.org : \
29084                 dialups.mail-abuse.org
29085 .endd
29086 the following records are looked up:
29087 .code
29088 43.62.168.192.blackholes.mail-abuse.org
29089 43.62.168.192.dialups.mail-abuse.org
29090 .endd
29091 As soon as Exim finds an existing DNS record, processing of the list stops.
29092 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29093 to test that a host is on more than one list (an &"and"& conjunction), you can
29094 use two separate conditions:
29095 .code
29096 deny dnslists = blackholes.mail-abuse.org
29097      dnslists = dialups.mail-abuse.org
29098 .endd
29099 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29100 behaves as if the host does not match the list item, that is, as if the DNS
29101 record does not exist. If there are further items in the DNS list, they are
29102 processed.
29103
29104 This is usually the required action when &%dnslists%& is used with &%deny%&
29105 (which is the most common usage), because it prevents a DNS failure from
29106 blocking mail. However, you can change this behaviour by putting one of the
29107 following special items in the list:
29108 .display
29109 &`+include_unknown `&   behave as if the item is on the list
29110 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29111 &`+defer_unknown   `&   give a temporary error
29112 .endd
29113 .cindex "&`+include_unknown`&"
29114 .cindex "&`+exclude_unknown`&"
29115 .cindex "&`+defer_unknown`&"
29116 Each of these applies to any subsequent items on the list. For example:
29117 .code
29118 deny dnslists = +defer_unknown : foo.bar.example
29119 .endd
29120 Testing the list of domains stops as soon as a match is found. If you want to
29121 warn for one list and block for another, you can use two different statements:
29122 .code
29123 deny  dnslists = blackholes.mail-abuse.org
29124 warn  message  = X-Warn: sending host is on dialups list
29125       dnslists = dialups.mail-abuse.org
29126 .endd
29127 DNS list lookups are cached by Exim for the duration of the SMTP session,
29128 so a lookup based on the IP address is done at most once for any incoming
29129 connection. Exim does not share information between multiple incoming
29130 connections (but your local name server cache should be active).
29131
29132
29133
29134 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29135 .cindex "DNS list" "keyed by explicit IP address"
29136 By default, the IP address that is used in a DNS list lookup is the IP address
29137 of the calling host. However, you can specify another IP address by listing it
29138 after the domain name, introduced by a slash. For example:
29139 .code
29140 deny dnslists = black.list.tld/192.168.1.2
29141 .endd
29142 This feature is not very helpful with explicit IP addresses; it is intended for
29143 use with IP addresses that are looked up, for example, the IP addresses of the
29144 MX hosts or nameservers of an email sender address. For an example, see section
29145 &<<SECTmulkeyfor>>& below.
29146
29147
29148
29149
29150 .section "DNS lists keyed on domain names" "SECID202"
29151 .cindex "DNS list" "keyed by domain name"
29152 There are some lists that are keyed on domain names rather than inverted IP
29153 addresses (see for example the &'domain based zones'& link at
29154 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29155 with these lists. You can change the name that is looked up in a DNS list by
29156 listing it after the domain name, introduced by a slash. For example,
29157 .code
29158 deny  message  = Sender's domain is listed at $dnslist_domain
29159       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29160 .endd
29161 This particular example is useful only in ACLs that are obeyed after the
29162 RCPT or DATA commands, when a sender address is available. If (for
29163 example) the message's sender is &'user@tld.example'& the name that is looked
29164 up by this example is
29165 .code
29166 tld.example.dsn.rfc-ignorant.org
29167 .endd
29168 A single &%dnslists%& condition can contain entries for both names and IP
29169 addresses. For example:
29170 .code
29171 deny dnslists = sbl.spamhaus.org : \
29172                 dsn.rfc-ignorant.org/$sender_address_domain
29173 .endd
29174 The first item checks the sending host's IP address; the second checks a domain
29175 name. The whole condition is true if either of the DNS lookups succeeds.
29176
29177
29178
29179
29180 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29181 .cindex "DNS list" "multiple keys for"
29182 The syntax described above for looking up explicitly-defined values (either
29183 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29184 name for the DNS list, what follows the slash can in fact be a list of items.
29185 As with all lists in Exim, the default separator is a colon. However, because
29186 this is a sublist within the list of DNS blacklist domains, it is necessary
29187 either to double the separators like this:
29188 .code
29189 dnslists = black.list.tld/name.1::name.2
29190 .endd
29191 or to change the separator character, like this:
29192 .code
29193 dnslists = black.list.tld/<;name.1;name.2
29194 .endd
29195 If an item in the list is an IP address, it is inverted before the DNS
29196 blacklist domain is appended. If it is not an IP address, no inversion
29197 occurs. Consider this condition:
29198 .code
29199 dnslists = black.list.tld/<;192.168.1.2;a.domain
29200 .endd
29201 The DNS lookups that occur are:
29202 .code
29203 2.1.168.192.black.list.tld
29204 a.domain.black.list.tld
29205 .endd
29206 Once a DNS record has been found (that matches a specific IP return
29207 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29208 are done. If there is a temporary DNS error, the rest of the sublist of domains
29209 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29210 only if no other DNS lookup in this sublist succeeds. In other words, a
29211 successful lookup for any of the items in the sublist overrides a temporary
29212 error for a previous item.
29213
29214 The ability to supply a list of items after the slash is in some sense just a
29215 syntactic convenience. These two examples have the same effect:
29216 .code
29217 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29218 dnslists = black.list.tld/a.domain::b.domain
29219 .endd
29220 However, when the data for the list is obtained from a lookup, the second form
29221 is usually much more convenient. Consider this example:
29222 .code
29223 deny message  = The mail servers for the domain \
29224                 $sender_address_domain \
29225                 are listed at $dnslist_domain ($dnslist_value); \
29226                 see $dnslist_text.
29227      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29228                                    ${lookup dnsdb {>|mxh=\
29229                                    $sender_address_domain} }} }
29230 .endd
29231 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29232 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29233 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29234 of expanding the condition might be something like this:
29235 .code
29236 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29237 .endd
29238 Thus, this example checks whether or not the IP addresses of the sender
29239 domain's mail servers are on the Spamhaus black list.
29240
29241 The key that was used for a successful DNS list lookup is put into the variable
29242 &$dnslist_matched$& (see section &<<SECID204>>&).
29243
29244
29245
29246
29247 .section "Data returned by DNS lists" "SECID203"
29248 .cindex "DNS list" "data returned from"
29249 DNS lists are constructed using address records in the DNS. The original RBL
29250 just used the address 127.0.0.1 on the right hand side of each record, but the
29251 RBL+ list and some other lists use a number of values with different meanings.
29252 The values used on the RBL+ list are:
29253 .display
29254 127.1.0.1  RBL
29255 127.1.0.2  DUL
29256 127.1.0.3  DUL and RBL
29257 127.1.0.4  RSS
29258 127.1.0.5  RSS and RBL
29259 127.1.0.6  RSS and DUL
29260 127.1.0.7  RSS and DUL and RBL
29261 .endd
29262 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29263 different values. Some DNS lists may return more than one address record;
29264 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29265
29266
29267 .section "Variables set from DNS lists" "SECID204"
29268 .cindex "expansion" "variables, set from DNS list"
29269 .cindex "DNS list" "variables set from"
29270 .vindex "&$dnslist_domain$&"
29271 .vindex "&$dnslist_matched$&"
29272 .vindex "&$dnslist_text$&"
29273 .vindex "&$dnslist_value$&"
29274 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29275 the name of the overall domain that matched (for example,
29276 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29277 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29278 the DNS record. When the key is an IP address, it is not reversed in
29279 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29280 cases, for example:
29281 .code
29282 deny dnslists = spamhaus.example
29283 .endd
29284 the key is also available in another variable (in this case,
29285 &$sender_host_address$&). In more complicated cases, however, this is not true.
29286 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29287 might generate a dnslists lookup like this:
29288 .code
29289 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29290 .endd
29291 If this condition succeeds, the value in &$dnslist_matched$& might be
29292 &`192.168.6.7`& (for example).
29293
29294 If more than one address record is returned by the DNS lookup, all the IP
29295 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29296 The variable &$dnslist_text$& contains the contents of any associated TXT
29297 record. For lists such as RBL+ the TXT record for a merged entry is often not
29298 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29299 information.
29300
29301 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29302 &-- although these appear before the condition in the ACL, they are not
29303 expanded until after it has failed. For example:
29304 .code
29305 deny    hosts = !+local_networks
29306         message = $sender_host_address is listed \
29307                   at $dnslist_domain
29308         dnslists = rbl-plus.mail-abuse.example
29309 .endd
29310
29311
29312
29313 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29314 .cindex "DNS list" "matching specific returned data"
29315 You can add an equals sign and an IP address after a &%dnslists%& domain name
29316 in order to restrict its action to DNS records with a matching right hand side.
29317 For example,
29318 .code
29319 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29320 .endd
29321 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29322 any address record is considered to be a match. For the moment, we assume
29323 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29324 describes how multiple records are handled.
29325
29326 More than one IP address may be given for checking, using a comma as a
29327 separator. These are alternatives &-- if any one of them matches, the
29328 &%dnslists%& condition is true. For example:
29329 .code
29330 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29331 .endd
29332 If you want to specify a constraining address list and also specify names or IP
29333 addresses to be looked up, the constraining address list must be specified
29334 first. For example:
29335 .code
29336 deny dnslists = dsn.rfc-ignorant.org\
29337                 =127.0.0.2/$sender_address_domain
29338 .endd
29339
29340 If the character &`&&`& is used instead of &`=`&, the comparison for each
29341 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29342 In other words, the listed addresses are used as bit masks. The comparison is
29343 true if all the bits in the mask are present in the address that is being
29344 tested. For example:
29345 .code
29346 dnslists = a.b.c&0.0.0.3
29347 .endd
29348 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29349 want to test whether one bit or another bit is present (as opposed to both
29350 being present), you must use multiple values. For example:
29351 .code
29352 dnslists = a.b.c&0.0.0.1,0.0.0.2
29353 .endd
29354 matches if the final component of the address is an odd number or two times
29355 an odd number.
29356
29357
29358
29359 .section "Negated DNS matching conditions" "SECID205"
29360 You can supply a negative list of IP addresses as part of a &%dnslists%&
29361 condition. Whereas
29362 .code
29363 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29364 .endd
29365 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29366 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29367 .code
29368 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29369 .endd
29370 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29371 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29372 words, the result of the test is inverted if an exclamation mark appears before
29373 the &`=`& (or the &`&&`&) sign.
29374
29375 &*Note*&: This kind of negation is not the same as negation in a domain,
29376 host, or address list (which is why the syntax is different).
29377
29378 If you are using just one list, the negation syntax does not gain you much. The
29379 previous example is precisely equivalent to
29380 .code
29381 deny  dnslists = a.b.c
29382      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29383 .endd
29384 However, if you are using multiple lists, the negation syntax is clearer.
29385 Consider this example:
29386 .code
29387 deny  dnslists = sbl.spamhaus.org : \
29388                  list.dsbl.org : \
29389                  dnsbl.njabl.org!=127.0.0.3 : \
29390                  relays.ordb.org
29391 .endd
29392 Using only positive lists, this would have to be:
29393 .code
29394 deny  dnslists = sbl.spamhaus.org : \
29395                  list.dsbl.org
29396 deny  dnslists = dnsbl.njabl.org
29397      !dnslists = dnsbl.njabl.org=127.0.0.3
29398 deny  dnslists = relays.ordb.org
29399 .endd
29400 which is less clear, and harder to maintain.
29401
29402
29403
29404
29405 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29406 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29407 thereby providing more than one IP address. When an item in a &%dnslists%& list
29408 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29409 the match to specific results from the DNS lookup, there are two ways in which
29410 the checking can be handled. For example, consider the condition:
29411 .code
29412 dnslists = a.b.c=127.0.0.1
29413 .endd
29414 What happens if the DNS lookup for the incoming IP address yields both
29415 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29416 condition true because at least one given value was found, or is it false
29417 because at least one of the found values was not listed? And how does this
29418 affect negated conditions? Both possibilities are provided for with the help of
29419 additional separators &`==`& and &`=&&`&.
29420
29421 .ilist
29422 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29423 IP addresses matches one of the listed addresses. For the example above, the
29424 condition is true because 127.0.0.1 matches.
29425 .next
29426 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29427 looked up IP addresses matches one of the listed addresses. If the condition is
29428 changed to:
29429 .code
29430 dnslists = a.b.c==127.0.0.1
29431 .endd
29432 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29433 false because 127.0.0.2 is not listed. You would need to have:
29434 .code
29435 dnslists = a.b.c==127.0.0.1,127.0.0.2
29436 .endd
29437 for the condition to be true.
29438 .endlist
29439
29440 When &`!`& is used to negate IP address matching, it inverts the result, giving
29441 the precise opposite of the behaviour above. Thus:
29442 .ilist
29443 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29444 addresses matches one of the listed addresses. Consider:
29445 .code
29446 dnslists = a.b.c!&0.0.0.1
29447 .endd
29448 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29449 false because 127.0.0.1 matches.
29450 .next
29451 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29452 looked up IP address that does not match. Consider:
29453 .code
29454 dnslists = a.b.c!=&0.0.0.1
29455 .endd
29456 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29457 true, because 127.0.0.2 does not match. You would need to have:
29458 .code
29459 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29460 .endd
29461 for the condition to be false.
29462 .endlist
29463 When the DNS lookup yields only a single IP address, there is no difference
29464 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29465
29466
29467
29468
29469 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29470 .cindex "DNS list" "information from merged"
29471 When the facility for restricting the matching IP values in a DNS list is used,
29472 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29473 the true reason for rejection. This happens when lists are merged and the IP
29474 address in the A record is used to distinguish them; unfortunately there is
29475 only one TXT record. One way round this is not to use merged lists, but that
29476 can be inefficient because it requires multiple DNS lookups where one would do
29477 in the vast majority of cases when the host of interest is not on any of the
29478 lists.
29479
29480 A less inefficient way of solving this problem is available. If
29481 two domain names, comma-separated, are given, the second is used first to
29482 do an initial check, making use of any IP value restrictions that are set.
29483 If there is a match, the first domain is used, without any IP value
29484 restrictions, to get the TXT record. As a byproduct of this, there is also
29485 a check that the IP being tested is indeed on the first list. The first
29486 domain is the one that is put in &$dnslist_domain$&. For example:
29487 .code
29488 reject message  = \
29489          rejected because $sender_host_address is blacklisted \
29490          at $dnslist_domain\n$dnslist_text
29491        dnslists = \
29492          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29493          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29494 .endd
29495 For the first blacklist item, this starts by doing a lookup in
29496 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29497 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29498 value, and as long as something is found, it looks for the corresponding TXT
29499 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29500 The second blacklist item is processed similarly.
29501
29502 If you are interested in more than one merged list, the same list must be
29503 given several times, but because the results of the DNS lookups are cached,
29504 the DNS calls themselves are not repeated. For example:
29505 .code
29506 reject dnslists = \
29507          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29508          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29509          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29510          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29511 .endd
29512 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29513 values matches (or if no record is found), this is the only lookup that is
29514 done. Only if there is a match is one of the more specific lists consulted.
29515
29516
29517
29518 .section "DNS lists and IPv6" "SECTmorednslistslast"
29519 .cindex "IPv6" "DNS black lists"
29520 .cindex "DNS list" "IPv6 usage"
29521 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29522 nibble by nibble. For example, if the calling host's IP address is
29523 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29524 .code
29525 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29526   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29527 .endd
29528 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29529 lists contain wildcard records, intended for IPv4, that interact badly with
29530 IPv6. For example, the DNS entry
29531 .code
29532 *.3.some.list.example.    A    127.0.0.1
29533 .endd
29534 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29535 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29536
29537 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29538 &%condition%& condition, as in this example:
29539 .code
29540 deny   condition = ${if isip4{$sender_host_address}}
29541        dnslists  = some.list.example
29542 .endd
29543
29544 If an explicit key is being used for a DNS lookup and it may be an IPv6
29545 address you should specify alternate list separators for both the outer
29546 (DNS list name) list and inner (lookup keys) list:
29547 .code
29548        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29549 .endd
29550
29551 .section "Rate limiting incoming messages" "SECTratelimiting"
29552 .cindex "rate limiting" "client sending"
29553 .cindex "limiting client sending rates"
29554 .oindex "&%smtp_ratelimit_*%&"
29555 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29556 which clients can send email. This is more powerful than the
29557 &%smtp_ratelimit_*%& options, because those options control the rate of
29558 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29559 works across all connections (concurrent and sequential) from the same client
29560 host. The syntax of the &%ratelimit%& condition is:
29561 .display
29562 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29563 .endd
29564 If the average client sending rate is less than &'m'& messages per time
29565 period &'p'& then the condition is false; otherwise it is true.
29566
29567 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29568 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29569 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29570 of &'p'&.
29571
29572 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29573 time interval, for example, &`8h`& for eight hours. A larger time constant
29574 means that it takes Exim longer to forget a client's past behaviour. The
29575 parameter &'m'& is the maximum number of messages that a client is permitted to
29576 send in each time interval. It also specifies the number of messages permitted
29577 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29578 constant, you can allow a client to send more messages in a burst without
29579 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29580 both small, messages must be sent at an even rate.
29581
29582 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29583 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29584 when deploying the &%ratelimit%& ACL condition. The script prints usage
29585 instructions when it is run with no arguments.
29586
29587 The key is used to look up the data for calculating the client's average
29588 sending rate. This data is stored in Exim's spool directory, alongside the
29589 retry and other hints databases. The default key is &$sender_host_address$&,
29590 which means Exim computes the sending rate of each client host IP address.
29591 By changing the key you can change how Exim identifies clients for the purpose
29592 of ratelimiting. For example, to limit the sending rate of each authenticated
29593 user, independent of the computer they are sending from, set the key to
29594 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29595 example, &$authenticated_id$& is only meaningful if the client has
29596 authenticated (which you can check with the &%authenticated%& ACL condition).
29597
29598 The lookup key does not have to identify clients: If you want to limit the
29599 rate at which a recipient receives messages, you can use the key
29600 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29601 ACL.
29602
29603 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29604 specifies what Exim measures the rate of, for example messages or recipients
29605 or bytes. You can adjust the measurement using the &%unique=%& and/or
29606 &%count=%& options. You can also control when Exim updates the recorded rate
29607 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29608 separated by a slash, like the other parameters. They may appear in any order.
29609
29610 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29611 any options that alter the meaning of the stored data. The limit &'m'& is not
29612 stored, so you can alter the configured maximum rate and Exim will still
29613 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29614 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29615 behaviour. The lookup key is not affected by changes to the update mode and
29616 the &%count=%& option.
29617
29618
29619 .section "Ratelimit options for what is being measured" "ratoptmea"
29620 .cindex "rate limiting" "per_* options"
29621 The &%per_conn%& option limits the client's connection rate. It is not
29622 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29623 &%acl_not_smtp_start%& ACLs.
29624
29625 The &%per_mail%& option limits the client's rate of sending messages. This is
29626 the default if none of the &%per_*%& options is specified. It can be used in
29627 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29628 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29629
29630 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29631 the same ACLs as the &%per_mail%& option, though it is best to use this option
29632 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29633 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29634 in its MAIL command, which may be inaccurate or completely missing. You can
29635 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29636 in kilobytes, megabytes, or gigabytes, respectively.
29637
29638 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29639 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29640 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29641 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29642 ACLs the rate is updated with the total recipient count in one go. Note that
29643 in either case the rate limiting engine will see a message with many
29644 recipients as a large high-speed burst.
29645
29646 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29647 number of different recipients that the client has sent messages to in the
29648 last time period. That is, if the client repeatedly sends messages to the same
29649 recipient, its measured rate is not increased. This option can only be used in
29650 &%acl_smtp_rcpt%&.
29651
29652 The &%per_cmd%& option causes Exim to recompute the rate every time the
29653 condition is processed. This can be used to limit the rate of any SMTP
29654 command. If it is used in multiple ACLs it can limit the aggregate rate of
29655 multiple different commands.
29656
29657 The &%count=%& option can be used to alter how much Exim adds to the client's
29658 measured rate. For example, the &%per_byte%& option is equivalent to
29659 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29660 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29661 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29662
29663 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29664
29665
29666 .section "Ratelimit update modes" "ratoptupd"
29667 .cindex "rate limiting" "reading data without updating"
29668 You can specify one of three options with the &%ratelimit%& condition to
29669 control when its database is updated. This section describes the &%readonly%&
29670 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29671
29672 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29673 previously-computed rate to check against the limit.
29674
29675 For example, you can test the client's sending rate and deny it access (when
29676 it is too fast) in the connect ACL. If the client passes this check then it
29677 can go on to send a message, in which case its recorded rate will be updated
29678 in the MAIL ACL. Subsequent connections from the same client will check this
29679 new rate.
29680 .code
29681 acl_check_connect:
29682  deny ratelimit = 100 / 5m / readonly
29683     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29684                   (max $sender_rate_limit)
29685 # ...
29686 acl_check_mail:
29687  warn ratelimit = 100 / 5m / strict
29688     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29689                   (max $sender_rate_limit)
29690 .endd
29691
29692 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29693 processing a message then it may increase the client's measured rate more than
29694 it should. For example, this will happen if you check the &%per_rcpt%& option
29695 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29696 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29697 multiple update problems by using the &%readonly%& option on later ratelimit
29698 checks.
29699
29700 The &%per_*%& options described above do not make sense in some ACLs. If you
29701 use a &%per_*%& option in an ACL where it is not normally permitted then the
29702 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29703 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29704 next section) so you must specify the &%readonly%& option explicitly.
29705
29706
29707 .section "Ratelimit options for handling fast clients" "ratoptfast"
29708 .cindex "rate limiting" "strict and leaky modes"
29709 If a client's average rate is greater than the maximum, the rate limiting
29710 engine can react in two possible ways, depending on the presence of the
29711 &%strict%& or &%leaky%& update modes. This is independent of the other
29712 counter-measures (such as rejecting the message) that may be specified by the
29713 rest of the ACL.
29714
29715 The &%leaky%& (default) option means that the client's recorded rate is not
29716 updated if it is above the limit. The effect of this is that Exim measures the
29717 client's average rate of successfully sent email, which cannot be greater than
29718 the maximum allowed. If the client is over the limit it may suffer some
29719 counter-measures (as specified in the ACL), but it will still be able to send
29720 email at the configured maximum rate, whatever the rate of its attempts. This
29721 is generally the better choice if you have clients that retry automatically.
29722 For example, it does not prevent a sender with an over-aggressive retry rate
29723 from getting any email through.
29724
29725 The &%strict%& option means that the client's recorded rate is always
29726 updated. The effect of this is that Exim measures the client's average rate
29727 of attempts to send email, which can be much higher than the maximum it is
29728 actually allowed. If the client is over the limit it may be subjected to
29729 counter-measures by the ACL. It must slow down and allow sufficient time to
29730 pass that its computed rate falls below the maximum before it can send email
29731 again. The time (the number of smoothing periods) it must wait and not
29732 attempt to send mail can be calculated with this formula:
29733 .code
29734         ln(peakrate/maxrate)
29735 .endd
29736
29737
29738 .section "Limiting the rate of different events" "ratoptuniq"
29739 .cindex "rate limiting" "counting unique events"
29740 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29741 rate of different events. For example, the &%per_addr%& option uses this
29742 mechanism to count the number of different recipients that the client has
29743 sent messages to in the last time period; it is equivalent to
29744 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29745 measure the rate that a client uses different sender addresses with the
29746 options &`per_mail/unique=$sender_address`&.
29747
29748 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29749 has seen for that key. The whole set is thrown away when it is older than the
29750 rate smoothing period &'p'&, so each different event is counted at most once
29751 per period. In the &%leaky%& update mode, an event that causes the client to
29752 go over the limit is not added to the set, in the same way that the client's
29753 recorded rate is not updated in the same situation.
29754
29755 When you combine the &%unique=%& and &%readonly%& options, the specific
29756 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29757 rate.
29758
29759 The &%unique=%& mechanism needs more space in the ratelimit database than the
29760 other &%ratelimit%& options in order to store the event set. The number of
29761 unique values is potentially as large as the rate limit, so the extra space
29762 required increases with larger limits.
29763
29764 The uniqueification is not perfect: there is a small probability that Exim
29765 will think a new event has happened before. If the sender's rate is less than
29766 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29767 the measured rate can go above the limit, in which case Exim may under-count
29768 events by a significant margin. Fortunately, if the rate is high enough (2.7
29769 times the limit) that the false positive rate goes above 9%, then Exim will
29770 throw away the over-full event set before the measured rate falls below the
29771 limit. Therefore the only harm should be that exceptionally high sending rates
29772 are logged incorrectly; any countermeasures you configure will be as effective
29773 as intended.
29774
29775
29776 .section "Using rate limiting" "useratlim"
29777 Exim's other ACL facilities are used to define what counter-measures are taken
29778 when the rate limit is exceeded. This might be anything from logging a warning
29779 (for example, while measuring existing sending rates in order to define
29780 policy), through time delays to slow down fast senders, up to rejecting the
29781 message. For example:
29782 .code
29783 # Log all senders' rates
29784 warn ratelimit = 0 / 1h / strict
29785      log_message = Sender rate $sender_rate / $sender_rate_period
29786
29787 # Slow down fast senders; note the need to truncate $sender_rate
29788 # at the decimal point.
29789 warn ratelimit = 100 / 1h / per_rcpt / strict
29790      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29791                    $sender_rate_limit }s
29792
29793 # Keep authenticated users under control
29794 deny authenticated = *
29795      ratelimit = 100 / 1d / strict / $authenticated_id
29796
29797 # System-wide rate limit
29798 defer message = Sorry, too busy. Try again later.
29799      ratelimit = 10 / 1s / $primary_hostname
29800
29801 # Restrict incoming rate from each host, with a default
29802 # set using a macro and special cases looked up in a table.
29803 defer message = Sender rate exceeds $sender_rate_limit \
29804                messages per $sender_rate_period
29805      ratelimit = ${lookup {$sender_host_address} \
29806                    cdb {DB/ratelimits.cdb} \
29807                    {$value} {RATELIMIT} }
29808 .endd
29809 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29810 especially with the &%per_rcpt%& option, you may suffer from a performance
29811 bottleneck caused by locking on the ratelimit hints database. Apart from
29812 making your ACLs less complicated, you can reduce the problem by using a
29813 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29814 this means that Exim will lose its hints data after a reboot (including retry
29815 hints, the callout cache, and ratelimit data).
29816
29817
29818
29819 .section "Address verification" "SECTaddressverification"
29820 .cindex "verifying address" "options for"
29821 .cindex "policy control" "address verification"
29822 Several of the &%verify%& conditions described in section
29823 &<<SECTaclconditions>>& cause addresses to be verified. Section
29824 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29825 The verification conditions can be followed by options that modify the
29826 verification process. The options are separated from the keyword and from each
29827 other by slashes, and some of them contain parameters. For example:
29828 .code
29829 verify = sender/callout
29830 verify = recipient/defer_ok/callout=10s,defer_ok
29831 .endd
29832 The first stage of address verification, which always happens, is to run the
29833 address through the routers, in &"verify mode"&. Routers can detect the
29834 difference between verification and routing for delivery, and their actions can
29835 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29836 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29837 The available options are as follows:
29838
29839 .ilist
29840 If the &%callout%& option is specified, successful routing to one or more
29841 remote hosts is followed by a &"callout"& to those hosts as an additional
29842 check. Callouts and their sub-options are discussed in the next section.
29843 .next
29844 If there is a defer error while doing verification routing, the ACL
29845 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29846 options, the condition is forced to be true instead. Note that this is a main
29847 verification option as well as a suboption for callouts.
29848 .next
29849 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29850 discusses the reporting of sender address verification failures.
29851 .next
29852 The &%success_on_redirect%& option causes verification always to succeed
29853 immediately after a successful redirection. By default, if a redirection
29854 generates just one address, that address is also verified. See further
29855 discussion in section &<<SECTredirwhilveri>>&.
29856 .endlist
29857
29858 .cindex "verifying address" "differentiating failures"
29859 .vindex "&$recipient_verify_failure$&"
29860 .vindex "&$sender_verify_failure$&"
29861 .vindex "&$acl_verify_message$&"
29862 After an address verification failure, &$acl_verify_message$& contains the
29863 error message that is associated with the failure. It can be preserved by
29864 coding like this:
29865 .code
29866 warn  !verify = sender
29867        set acl_m0 = $acl_verify_message
29868 .endd
29869 If you are writing your own custom rejection message or log message when
29870 denying access, you can use this variable to include information about the
29871 verification failure.
29872
29873 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29874 appropriate) contains one of the following words:
29875
29876 .ilist
29877 &%qualify%&: The address was unqualified (no domain), and the message
29878 was neither local nor came from an exempted host.
29879 .next
29880 &%route%&: Routing failed.
29881 .next
29882 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29883 occurred at or before the MAIL command (that is, on initial
29884 connection, HELO, or MAIL).
29885 .next
29886 &%recipient%&: The RCPT command in a callout was rejected.
29887 .next
29888 &%postmaster%&: The postmaster check in a callout was rejected.
29889 .endlist
29890
29891 The main use of these variables is expected to be to distinguish between
29892 rejections of MAIL and rejections of RCPT in callouts.
29893
29894
29895
29896
29897 .section "Callout verification" "SECTcallver"
29898 .cindex "verifying address" "by callout"
29899 .cindex "callout" "verification"
29900 .cindex "SMTP" "callout verification"
29901 For non-local addresses, routing verifies the domain, but is unable to do any
29902 checking of the local part. There are situations where some means of verifying
29903 the local part is desirable. One way this can be done is to make an SMTP
29904 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29905 a subsequent host for a recipient address, to see if the host accepts the
29906 address. We use the term &'callout'& to cover both cases. Note that for a
29907 sender address, the callback is not to the client host that is trying to
29908 deliver the message, but to one of the hosts that accepts incoming mail for the
29909 sender's domain.
29910
29911 Exim does not do callouts by default. If you want them to happen, you must
29912 request them by setting appropriate options on the &%verify%& condition, as
29913 described below. This facility should be used with care, because it can add a
29914 lot of resource usage to the cost of verifying an address. However, Exim does
29915 cache the results of callouts, which helps to reduce the cost. Details of
29916 caching are in section &<<SECTcallvercache>>&.
29917
29918 Recipient callouts are usually used only between hosts that are controlled by
29919 the same administration. For example, a corporate gateway host could use
29920 callouts to check for valid recipients on an internal mailserver. A successful
29921 callout does not guarantee that a real delivery to the address would succeed;
29922 on the other hand, a failing callout does guarantee that a delivery would fail.
29923
29924 If the &%callout%& option is present on a condition that verifies an address, a
29925 second stage of verification occurs if the address is successfully routed to
29926 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29927 &(manualroute)& router, where the router specifies the hosts. However, if a
29928 router that does not set up hosts routes to an &(smtp)& transport with a
29929 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29930 &%hosts_override%& set, its hosts are always used, whether or not the router
29931 supplies a host list.
29932 Callouts are only supported on &(smtp)& transports.
29933
29934 The port that is used is taken from the transport, if it is specified and is a
29935 remote transport. (For routers that do verification only, no transport need be
29936 specified.) Otherwise, the default SMTP port is used. If a remote transport
29937 specifies an outgoing interface, this is used; otherwise the interface is not
29938 specified. Likewise, the text that is used for the HELO command is taken from
29939 the transport's &%helo_data%& option; if there is no transport, the value of
29940 &$smtp_active_hostname$& is used.
29941
29942 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29943 test whether a bounce message could be delivered to the sender address. The
29944 following SMTP commands are sent:
29945 .display
29946 &`HELO `&<&'local host name'&>
29947 &`MAIL FROM:<>`&
29948 &`RCPT TO:`&<&'the address to be tested'&>
29949 &`QUIT`&
29950 .endd
29951 LHLO is used instead of HELO if the transport's &%protocol%& option is
29952 set to &"lmtp"&.
29953
29954 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29955 settings.
29956
29957 A recipient callout check is similar. By default, it also uses an empty address
29958 for the sender. This default is chosen because most hosts do not make use of
29959 the sender address when verifying a recipient. Using the same address means
29960 that a single cache entry can be used for each recipient. Some sites, however,
29961 do make use of the sender address when verifying. These are catered for by the
29962 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29963
29964 If the response to the RCPT command is a 2&'xx'& code, the verification
29965 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29966 Exim tries the next host, if any. If there is a problem with all the remote
29967 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29968 &%callout%& option is given, in which case the condition is forced to succeed.
29969
29970 .cindex "SMTP" "output flushing, disabling for callout"
29971 A callout may take a little time. For this reason, Exim normally flushes SMTP
29972 output before performing a callout in an ACL, to avoid unexpected timeouts in
29973 clients when the SMTP PIPELINING extension is in use. The flushing can be
29974 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29975
29976
29977
29978
29979 .section "Additional parameters for callouts" "CALLaddparcall"
29980 .cindex "callout" "additional parameters for"
29981 The &%callout%& option can be followed by an equals sign and a number of
29982 optional parameters, separated by commas. For example:
29983 .code
29984 verify = recipient/callout=10s,defer_ok
29985 .endd
29986 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29987 separate verify options, is retained for backwards compatibility, but is now
29988 deprecated. The additional parameters for &%callout%& are as follows:
29989
29990
29991 .vlist
29992 .vitem <&'a&~time&~interval'&>
29993 .cindex "callout" "timeout, specifying"
29994 This specifies the timeout that applies for the callout attempt to each host.
29995 For example:
29996 .code
29997 verify = sender/callout=5s
29998 .endd
29999 The default is 30 seconds. The timeout is used for each response from the
30000 remote host. It is also used for the initial connection, unless overridden by
30001 the &%connect%& parameter.
30002
30003
30004 .vitem &*connect&~=&~*&<&'time&~interval'&>
30005 .cindex "callout" "connection timeout, specifying"
30006 This parameter makes it possible to set a different (usually smaller) timeout
30007 for making the SMTP connection. For example:
30008 .code
30009 verify = sender/callout=5s,connect=1s
30010 .endd
30011 If not specified, this timeout defaults to the general timeout value.
30012
30013 .vitem &*defer_ok*&
30014 .cindex "callout" "defer, action on"
30015 When this parameter is present, failure to contact any host, or any other kind
30016 of temporary error, is treated as success by the ACL. However, the cache is not
30017 updated in this circumstance.
30018
30019 .vitem &*fullpostmaster*&
30020 .cindex "callout" "full postmaster check"
30021 This operates like the &%postmaster%& option (see below), but if the check for
30022 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30023 accordance with the specification in RFC 2821. The RFC states that the
30024 unqualified address &'postmaster'& should be accepted.
30025
30026
30027 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30028 .cindex "callout" "sender when verifying header"
30029 When verifying addresses in header lines using the &%header_sender%&
30030 verification option, Exim behaves by default as if the addresses are envelope
30031 sender addresses from a message. Callout verification therefore tests to see
30032 whether a bounce message could be delivered, by using an empty address in the
30033 MAIL command. However, it is arguable that these addresses might never be used
30034 as envelope senders, and could therefore justifiably reject bounce messages
30035 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30036 address to use in the MAIL command. For example:
30037 .code
30038 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30039 .endd
30040 This parameter is available only for the &%header_sender%& verification option.
30041
30042
30043 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30044 .cindex "callout" "overall timeout, specifying"
30045 This parameter sets an overall timeout for performing a callout verification.
30046 For example:
30047 .code
30048 verify = sender/callout=5s,maxwait=30s
30049 .endd
30050 This timeout defaults to four times the callout timeout for individual SMTP
30051 commands. The overall timeout applies when there is more than one host that can
30052 be tried. The timeout is checked before trying the next host. This prevents
30053 very long delays if there are a large number of hosts and all are timing out
30054 (for example, when network connections are timing out).
30055
30056
30057 .vitem &*no_cache*&
30058 .cindex "callout" "cache, suppressing"
30059 .cindex "caching callout, suppressing"
30060 When this parameter is given, the callout cache is neither read nor updated.
30061
30062 .vitem &*postmaster*&
30063 .cindex "callout" "postmaster; checking"
30064 When this parameter is set, a successful callout check is followed by a similar
30065 check for the local part &'postmaster'& at the same domain. If this address is
30066 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30067 the postmaster check is recorded in a cache record; if it is a failure, this is
30068 used to fail subsequent callouts for the domain without a connection being
30069 made, until the cache record expires.
30070
30071 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30072 The postmaster check uses an empty sender in the MAIL command by default.
30073 You can use this parameter to do a postmaster check using a different address.
30074 For example:
30075 .code
30076 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30077 .endd
30078 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30079 one overrides. The &%postmaster%& parameter is equivalent to this example:
30080 .code
30081 require  verify = sender/callout=postmaster_mailfrom=
30082 .endd
30083 &*Warning*&: The caching arrangements for postmaster checking do not take
30084 account of the sender address. It is assumed that either the empty address or
30085 a fixed non-empty address will be used. All that Exim remembers is that the
30086 postmaster check for the domain succeeded or failed.
30087
30088
30089 .vitem &*random*&
30090 .cindex "callout" "&""random""& check"
30091 When this parameter is set, before doing the normal callout check, Exim does a
30092 check for a &"random"& local part at the same domain. The local part is not
30093 really random &-- it is defined by the expansion of the option
30094 &%callout_random_local_part%&, which defaults to
30095 .code
30096 $primary_hostname-$tod_epoch-testing
30097 .endd
30098 The idea here is to try to determine whether the remote host accepts all local
30099 parts without checking. If it does, there is no point in doing callouts for
30100 specific local parts. If the &"random"& check succeeds, the result is saved in
30101 a cache record, and used to force the current and subsequent callout checks to
30102 succeed without a connection being made, until the cache record expires.
30103
30104 .vitem &*use_postmaster*&
30105 .cindex "callout" "sender for recipient check"
30106 This parameter applies to recipient callouts only. For example:
30107 .code
30108 deny  !verify = recipient/callout=use_postmaster
30109 .endd
30110 .vindex "&$qualify_domain$&"
30111 It causes a non-empty postmaster address to be used in the MAIL command when
30112 performing the callout for the recipient, and also for a &"random"& check if
30113 that is configured. The local part of the address is &`postmaster`& and the
30114 domain is the contents of &$qualify_domain$&.
30115
30116 .vitem &*use_sender*&
30117 This option applies to recipient callouts only. For example:
30118 .code
30119 require  verify = recipient/callout=use_sender
30120 .endd
30121 It causes the message's actual sender address to be used in the MAIL
30122 command when performing the callout, instead of an empty address. There is no
30123 need to use this option unless you know that the called hosts make use of the
30124 sender when checking recipients. If used indiscriminately, it reduces the
30125 usefulness of callout caching.
30126 .endlist
30127
30128 If you use any of the parameters that set a non-empty sender for the MAIL
30129 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30130 &%use_sender%&), you should think about possible loops. Recipient checking is
30131 usually done between two hosts that are under the same management, and the host
30132 that receives the callouts is not normally configured to do callouts itself.
30133 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30134 these circumstances.
30135
30136 However, if you use a non-empty sender address for a callout to an arbitrary
30137 host, there is the likelihood that the remote host will itself initiate a
30138 callout check back to your host. As it is checking what appears to be a message
30139 sender, it is likely to use an empty address in MAIL, thus avoiding a
30140 callout loop. However, to be on the safe side it would be best to set up your
30141 own ACLs so that they do not do sender verification checks when the recipient
30142 is the address you use for header sender or postmaster callout checking.
30143
30144 Another issue to think about when using non-empty senders for callouts is
30145 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30146 by the sender/recipient combination; thus, for any given recipient, many more
30147 actual callouts are performed than when an empty sender or postmaster is used.
30148
30149
30150
30151
30152 .section "Callout caching" "SECTcallvercache"
30153 .cindex "hints database" "callout cache"
30154 .cindex "callout" "cache, description of"
30155 .cindex "caching" "callout"
30156 Exim caches the results of callouts in order to reduce the amount of resources
30157 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30158 option. A hints database called &"callout"& is used for the cache. Two
30159 different record types are used: one records the result of a callout check for
30160 a specific address, and the other records information that applies to the
30161 entire domain (for example, that it accepts the local part &'postmaster'&).
30162
30163 When an original callout fails, a detailed SMTP error message is given about
30164 the failure. However, for subsequent failures use the cache data, this message
30165 is not available.
30166
30167 The expiry times for negative and positive address cache records are
30168 independent, and can be set by the global options &%callout_negative_expire%&
30169 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30170
30171 If a host gives a negative response to an SMTP connection, or rejects any
30172 commands up to and including
30173 .code
30174 MAIL FROM:<>
30175 .endd
30176 (but not including the MAIL command with a non-empty address),
30177 any callout attempt is bound to fail. Exim remembers such failures in a
30178 domain cache record, which it uses to fail callouts for the domain without
30179 making new connections, until the domain record times out. There are two
30180 separate expiry times for domain cache records:
30181 &%callout_domain_negative_expire%& (default 3h) and
30182 &%callout_domain_positive_expire%& (default 7d).
30183
30184 Domain records expire when the negative expiry time is reached if callouts
30185 cannot be made for the domain, or if the postmaster check failed.
30186 Otherwise, they expire when the positive expiry time is reached. This
30187 ensures that, for example, a host that stops accepting &"random"& local parts
30188 will eventually be noticed.
30189
30190 The callout caching mechanism is based on the domain of the address that is
30191 being tested. If the domain routes to several hosts, it is assumed that their
30192 behaviour will be the same.
30193
30194
30195
30196 .section "Sender address verification reporting" "SECTsenaddver"
30197 .cindex "verifying" "suppressing error details"
30198 See section &<<SECTaddressverification>>& for a general discussion of
30199 verification. When sender verification fails in an ACL, the details of the
30200 failure are given as additional output lines before the 550 response to the
30201 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30202 you might see:
30203 .code
30204 MAIL FROM:<xyz@abc.example>
30205 250 OK
30206 RCPT TO:<pqr@def.example>
30207 550-Verification failed for <xyz@abc.example>
30208 550-Called:   192.168.34.43
30209 550-Sent:     RCPT TO:<xyz@abc.example>
30210 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30211 550 Sender verification failed
30212 .endd
30213 If more than one RCPT command fails in the same way, the details are given
30214 only for the first of them. However, some administrators do not want to send
30215 out this much information. You can suppress the details by adding
30216 &`/no_details`& to the ACL statement that requests sender verification. For
30217 example:
30218 .code
30219 verify = sender/no_details
30220 .endd
30221
30222 .section "Redirection while verifying" "SECTredirwhilveri"
30223 .cindex "verifying" "redirection while"
30224 .cindex "address redirection" "while verifying"
30225 A dilemma arises when a local address is redirected by aliasing or forwarding
30226 during verification: should the generated addresses themselves be verified,
30227 or should the successful expansion of the original address be enough to verify
30228 it? By default, Exim takes the following pragmatic approach:
30229
30230 .ilist
30231 When an incoming address is redirected to just one child address, verification
30232 continues with the child address, and if that fails to verify, the original
30233 verification also fails.
30234 .next
30235 When an incoming address is redirected to more than one child address,
30236 verification does not continue. A success result is returned.
30237 .endlist
30238
30239 This seems the most reasonable behaviour for the common use of aliasing as a
30240 way of redirecting different local parts to the same mailbox. It means, for
30241 example, that a pair of alias entries of the form
30242 .code
30243 A.Wol:   aw123
30244 aw123:   :fail: Gone away, no forwarding address
30245 .endd
30246 work as expected, with both local parts causing verification failure. When a
30247 redirection generates more than one address, the behaviour is more like a
30248 mailing list, where the existence of the alias itself is sufficient for
30249 verification to succeed.
30250
30251 It is possible, however, to change the default behaviour so that all successful
30252 redirections count as successful verifications, however many new addresses are
30253 generated. This is specified by the &%success_on_redirect%& verification
30254 option. For example:
30255 .code
30256 require verify = recipient/success_on_redirect/callout=10s
30257 .endd
30258 In this example, verification succeeds if a router generates a new address, and
30259 the callout does not occur, because no address was routed to a remote host.
30260
30261 When verification is being tested via the &%-bv%& option, the treatment of
30262 redirections is as just described, unless the &%-v%& or any debugging option is
30263 also specified. In that case, full verification is done for every generated
30264 address and a report is output for each of them.
30265
30266
30267
30268 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30269 .cindex "CSA" "verifying"
30270 Client SMTP Authorization is a system that allows a site to advertise
30271 which machines are and are not permitted to send email. This is done by placing
30272 special SRV records in the DNS; these are looked up using the client's HELO
30273 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30274 Authorization checks in Exim are performed by the ACL condition:
30275 .code
30276 verify = csa
30277 .endd
30278 This fails if the client is not authorized. If there is a DNS problem, or if no
30279 valid CSA SRV record is found, or if the client is authorized, the condition
30280 succeeds. These three cases can be distinguished using the expansion variable
30281 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30282 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30283 be likely to cause problems for legitimate email.
30284
30285 The error messages produced by the CSA code include slightly more
30286 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30287 looking up the CSA SRV record, or problems looking up the CSA target
30288 address record. There are four reasons for &$csa_status$& being &"fail"&:
30289
30290 .ilist
30291 The client's host name is explicitly not authorized.
30292 .next
30293 The client's IP address does not match any of the CSA target IP addresses.
30294 .next
30295 The client's host name is authorized but it has no valid target IP addresses
30296 (for example, the target's addresses are IPv6 and the client is using IPv4).
30297 .next
30298 The client's host name has no CSA SRV record but a parent domain has asserted
30299 that all subdomains must be explicitly authorized.
30300 .endlist
30301
30302 The &%csa%& verification condition can take an argument which is the domain to
30303 use for the DNS query. The default is:
30304 .code
30305 verify = csa/$sender_helo_name
30306 .endd
30307 This implementation includes an extension to CSA. If the query domain
30308 is an address literal such as [192.0.2.95], or if it is a bare IP
30309 address, Exim searches for CSA SRV records in the reverse DNS as if
30310 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30311 meaningful to say:
30312 .code
30313 verify = csa/$sender_host_address
30314 .endd
30315 In fact, this is the check that Exim performs if the client does not say HELO.
30316 This extension can be turned off by setting the main configuration option
30317 &%dns_csa_use_reverse%& to be false.
30318
30319 If a CSA SRV record is not found for the domain itself, a search
30320 is performed through its parent domains for a record which might be
30321 making assertions about subdomains. The maximum depth of this search is limited
30322 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30323 default. Exim does not look for CSA SRV records in a top level domain, so the
30324 default settings handle HELO domains as long as seven
30325 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30326 of legitimate HELO domains.
30327
30328 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30329 direct SRV lookups, this is not sufficient because of the extra parent domain
30330 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30331 addresses into lookups in the reverse DNS space. The result of a successful
30332 lookup such as:
30333 .code
30334 ${lookup dnsdb {csa=$sender_helo_name}}
30335 .endd
30336 has two space-separated fields: an authorization code and a target host name.
30337 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30338 authorization required but absent, or &"?"& for unknown.
30339
30340
30341
30342
30343 .section "Bounce address tag validation" "SECTverifyPRVS"
30344 .cindex "BATV, verifying"
30345 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30346 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30347 Genuine incoming bounce messages should therefore always be addressed to
30348 recipients that have a valid tag. This scheme is a way of detecting unwanted
30349 bounce messages caused by sender address forgeries (often called &"collateral
30350 spam"&), because the recipients of such messages do not include valid tags.
30351
30352 There are two expansion items to help with the implementation of the BATV
30353 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30354 the original envelope sender address by using a simple key to add a hash of the
30355 address and some time-based randomizing information. The &%prvs%& expansion
30356 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30357 The syntax of these expansion items is described in section
30358 &<<SECTexpansionitems>>&.
30359
30360 As an example, suppose the secret per-address keys are stored in an MySQL
30361 database. A query to look up the key for an address could be defined as a macro
30362 like this:
30363 .code
30364 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30365                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30366                 }{$value}}
30367 .endd
30368 Suppose also that the senders who make use of BATV are defined by an address
30369 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30370 use this:
30371 .code
30372 # Bounces: drop unsigned addresses for BATV senders
30373 deny message = This address does not send an unsigned reverse path
30374      senders = :
30375      recipients = +batv_senders
30376
30377 # Bounces: In case of prvs-signed address, check signature.
30378 deny message = Invalid reverse path signature.
30379      senders = :
30380      condition  = ${prvscheck {$local_part@$domain}\
30381                   {PRVSCHECK_SQL}{1}}
30382      !condition = $prvscheck_result
30383 .endd
30384 The first statement rejects recipients for bounce messages that are addressed
30385 to plain BATV sender addresses, because it is known that BATV senders do not
30386 send out messages with plain sender addresses. The second statement rejects
30387 recipients that are prvs-signed, but with invalid signatures (either because
30388 the key is wrong, or the signature has timed out).
30389
30390 A non-prvs-signed address is not rejected by the second statement, because the
30391 &%prvscheck%& expansion yields an empty string if its first argument is not a
30392 prvs-signed address, thus causing the &%condition%& condition to be false. If
30393 the first argument is a syntactically valid prvs-signed address, the yield is
30394 the third string (in this case &"1"&), whether or not the cryptographic and
30395 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30396 of the checks (empty for failure, &"1"& for success).
30397
30398 There is one more issue you must consider when implementing prvs-signing:
30399 you have to ensure that the routers accept prvs-signed addresses and
30400 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30401 router to remove the signature with a configuration along these lines:
30402 .code
30403 batv_redirect:
30404   driver = redirect
30405   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30406 .endd
30407 This works because, if the third argument of &%prvscheck%& is empty, the result
30408 of the expansion of a prvs-signed address is the decoded value of the original
30409 address. This router should probably be the first of your routers that handles
30410 local addresses.
30411
30412 To create BATV-signed addresses in the first place, a transport of this form
30413 can be used:
30414 .code
30415 external_smtp_batv:
30416   driver = smtp
30417   return_path = ${prvs {$return_path} \
30418                        {${lookup mysql{SELECT \
30419                        secret FROM batv_prvs WHERE \
30420                        sender='${quote_mysql:$sender_address}'} \
30421                        {$value}fail}}}
30422 .endd
30423 If no key can be found for the existing return path, no signing takes place.
30424
30425
30426
30427 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30428 .cindex "&ACL;" "relay control"
30429 .cindex "relaying" "control by ACL"
30430 .cindex "policy control" "relay control"
30431 An MTA is said to &'relay'& a message if it receives it from some host and
30432 delivers it directly to another host as a result of a remote address contained
30433 within it. Redirecting a local address via an alias or forward file and then
30434 passing the message on to another host is not relaying,
30435 .cindex "&""percent hack""&"
30436 but a redirection as a result of the &"percent hack"& is.
30437
30438 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30439 A host which is acting as a gateway or an MX backup is concerned with incoming
30440 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30441 a host which is acting as a smart host for a number of clients is concerned
30442 with outgoing relaying from those clients to the Internet at large. Often the
30443 same host is fulfilling both functions,
30444 . ///
30445 . as illustrated in the diagram below,
30446 . ///
30447 but in principle these two kinds of relaying are entirely independent. What is
30448 not wanted is the transmission of mail from arbitrary remote hosts through your
30449 system to arbitrary domains.
30450
30451
30452 You can implement relay control by means of suitable statements in the ACL that
30453 runs for each RCPT command. For convenience, it is often easiest to use
30454 Exim's named list facility to define the domains and hosts involved. For
30455 example, suppose you want to do the following:
30456
30457 .ilist
30458 Deliver a number of domains to mailboxes on the local host (or process them
30459 locally in some other way). Let's say these are &'my.dom1.example'& and
30460 &'my.dom2.example'&.
30461 .next
30462 Relay mail for a number of other domains for which you are the secondary MX.
30463 These might be &'friend1.example'& and &'friend2.example'&.
30464 .next
30465 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30466 Suppose your LAN is 192.168.45.0/24.
30467 .endlist
30468
30469
30470 In the main part of the configuration, you put the following definitions:
30471 .code
30472 domainlist local_domains    = my.dom1.example : my.dom2.example
30473 domainlist relay_to_domains = friend1.example : friend2.example
30474 hostlist   relay_from_hosts = 192.168.45.0/24
30475 .endd
30476 Now you can use these definitions in the ACL that is run for every RCPT
30477 command:
30478 .code
30479 acl_check_rcpt:
30480   accept domains = +local_domains : +relay_to_domains
30481   accept hosts   = +relay_from_hosts
30482 .endd
30483 The first statement accepts any RCPT command that contains an address in
30484 the local or relay domains. For any other domain, control passes to the second
30485 statement, which accepts the command only if it comes from one of the relay
30486 hosts. In practice, you will probably want to make your ACL more sophisticated
30487 than this, for example, by including sender and recipient verification. The
30488 default configuration includes a more comprehensive example, which is described
30489 in chapter &<<CHAPdefconfil>>&.
30490
30491
30492
30493 .section "Checking a relay configuration" "SECTcheralcon"
30494 .cindex "relaying" "checking control of"
30495 You can check the relay characteristics of your configuration in the same way
30496 that you can test any ACL behaviour for an incoming SMTP connection, by using
30497 the &%-bh%& option to run a fake SMTP session with which you interact.
30498
30499 For specifically testing for unwanted relaying, the host
30500 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30501 host from the host on which Exim is running, using the normal telnet port, you
30502 will see a normal telnet connection message and then quite a long delay. Be
30503 patient. The remote host is making an SMTP connection back to your host, and
30504 trying a number of common probes to test for open relay vulnerability. The
30505 results of the tests will eventually appear on your terminal.
30506 .ecindex IIDacl
30507
30508
30509
30510 . ////////////////////////////////////////////////////////////////////////////
30511 . ////////////////////////////////////////////////////////////////////////////
30512
30513 .chapter "Content scanning at ACL time" "CHAPexiscan"
30514 .scindex IIDcosca "content scanning" "at ACL time"
30515 The extension of Exim to include content scanning at ACL time, formerly known
30516 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30517 was integrated into the main source for Exim release 4.50, and Tom continues to
30518 maintain it. Most of the wording of this chapter is taken from Tom's
30519 specification.
30520
30521 It is also possible to scan the content of messages at other times. The
30522 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30523 scanning after all the ACLs have run. A transport filter can be used to scan
30524 messages at delivery time (see the &%transport_filter%& option, described in
30525 chapter &<<CHAPtransportgeneric>>&).
30526
30527 If you want to include the ACL-time content-scanning features when you compile
30528 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30529 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30530
30531 .ilist
30532 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30533 for all MIME parts for SMTP and non-SMTP messages, respectively.
30534 .next
30535 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30536 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30537 run at the end of message reception (the &%acl_smtp_data%& ACL).
30538 .next
30539 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30540 of messages, or parts of messages, for debugging purposes.
30541 .next
30542 Additional expansion variables that are set in the new ACL and by the new
30543 conditions.
30544 .next
30545 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30546 .endlist
30547
30548 There is another content-scanning configuration option for &_Local/Makefile_&,
30549 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30550 condition is compiled, in addition to all the other content-scanning features.
30551
30552 Content-scanning is continually evolving, and new features are still being
30553 added. While such features are still unstable and liable to incompatible
30554 changes, they are made available in Exim by setting options whose names begin
30555 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30556 this manual. You can find out about them by reading the file called
30557 &_doc/experimental.txt_&.
30558
30559 All the content-scanning facilities work on a MBOX copy of the message that is
30560 temporarily created in a file called:
30561 .display
30562 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30563 .endd
30564 The &_.eml_& extension is a friendly hint to virus scanners that they can
30565 expect an MBOX-like structure inside that file. The file is created when the
30566 first content scanning facility is called. Subsequent calls to content
30567 scanning conditions open the same file again. The directory is recursively
30568 removed when the &%acl_smtp_data%& ACL has finished running, unless
30569 .code
30570 control = no_mbox_unspool
30571 .endd
30572 has been encountered. When the MIME ACL decodes files, they are put into the
30573 same directory by default.
30574
30575
30576
30577 .section "Scanning for viruses" "SECTscanvirus"
30578 .cindex "virus scanning"
30579 .cindex "content scanning" "for viruses"
30580 .cindex "content scanning" "the &%malware%& condition"
30581 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30582 It supports a &"generic"& interface to scanners called via the shell, and
30583 specialized interfaces for &"daemon"& type virus scanners, which are resident
30584 in memory and thus are much faster.
30585
30586 .new
30587 A timeout of 2 minutes is applied to a scanner call (by default);
30588 if it expires then a defer action is taken.
30589 .wen
30590
30591 .oindex "&%av_scanner%&"
30592 You can set the &%av_scanner%& option in the main part of the configuration
30593 to specify which scanner to use, together with any additional options that
30594 are needed. The basic syntax is as follows:
30595 .display
30596 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30597 .endd
30598 If you do not set &%av_scanner%&, it defaults to
30599 .code
30600 av_scanner = sophie:/var/run/sophie
30601 .endd
30602 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30603 before use.
30604 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30605 The following scanner types are supported in this release:
30606
30607 .vlist
30608 .new
30609 .vitem &%avast%&
30610 .cindex "virus scanners" "avast"
30611 This is the scanner daemon of Avast. It has been tested with Avast Core
30612 Security (currenty at version 1.1.7).
30613 You can get a trial version at &url(http://www.avast.com) or for Linux
30614 at &url(http://www.avast.com/linux-server-antivirus).
30615 This scanner type takes one option,
30616 which can be either a full path to a UNIX socket,
30617 or host and port specifiers separated by white space.
30618 The host may be a name or an IP address; the port is either a
30619 single number or a pair of numbers with a dash between.
30620 Any further options are given, on separate lines,
30621 to the daemon as options before the main scan command.
30622 For example:
30623 .code
30624 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30625 av_scanner = avast:192.168.2.22 5036
30626 .endd
30627 If you omit the argument, the default path
30628 &_/var/run/avast/scan.sock_&
30629 is used.
30630 If you use a remote host,
30631 you need to make Exim's spool directory available to it,
30632 as the scanner is passed a file path, not file contents.
30633 For information about available commands and their options you may use 
30634 .code
30635 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30636     FLAGS
30637     SENSITIVITY
30638     PACK
30639 .endd
30640 .wen
30641
30642
30643 .vitem &%aveserver%&
30644 .cindex "virus scanners" "Kaspersky"
30645 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30646 at &url(http://www.kaspersky.com). This scanner type takes one option,
30647 which is the path to the daemon's UNIX socket. The default is shown in this
30648 example:
30649 .code
30650 av_scanner = aveserver:/var/run/aveserver
30651 .endd
30652
30653
30654 .vitem &%clamd%&
30655 .cindex "virus scanners" "clamd"
30656 This daemon-type scanner is GPL and free. You can get it at
30657 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30658 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30659 in the MIME ACL. This is no longer believed to be necessary.
30660
30661 The options are a list of server specifiers, which may be
30662 a UNIX socket specification,
30663 a TCP socket specification,
30664 or a (global) option.
30665
30666 A socket specification consists of a space-separated list.
30667 For a Unix socket the first element is a full path for the socket,
30668 for a TCP socket the first element is the IP address
30669 and the second a port number,
30670 Any further elements are per-server (non-global) options.
30671 These per-server options are supported:
30672 .code
30673 retry=<timespec>        Retry on connect fail
30674 .endd
30675
30676 The &`retry`& option specifies a time after which a single retry for
30677 a failed connect is made.  The default is to not retry.
30678
30679 If a Unix socket file is specified, only one server is supported.
30680
30681 Examples:
30682 .code
30683 av_scanner = clamd:/opt/clamd/socket
30684 av_scanner = clamd:192.0.2.3 1234
30685 av_scanner = clamd:192.0.2.3 1234:local
30686 av_scanner = clamd:192.0.2.3 1234 retry=10s
30687 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30688 .endd
30689 If the value of av_scanner points to a UNIX socket file or contains the
30690 &`local`&
30691 option, then the ClamAV interface will pass a filename containing the data
30692 to be scanned, which will should normally result in less I/O happening and be
30693 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30694 Exim does not assume that there is a common filesystem with the remote host.
30695 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30696 you be running a version of ClamAV prior to 0.95.
30697
30698 The final example shows that multiple TCP targets can be specified.  Exim will
30699 randomly use one for each incoming email (i.e. it load balances them).  Note
30700 that only TCP targets may be used if specifying a list of scanners; a UNIX
30701 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30702 unavailable, Exim will try the remaining one(s) until it finds one that works.
30703 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30704 not keep track of scanner state between multiple messages, and the scanner
30705 selection is random, so the message will get logged in the mainlog for each
30706 email that the down scanner gets chosen first (message wrapped to be readable):
30707 .code
30708 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30709    clamd: connection to localhost, port 3310 failed
30710    (Connection refused)
30711 .endd
30712
30713 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30714 contributing the code for this scanner.
30715
30716 .vitem &%cmdline%&
30717 .cindex "virus scanners" "command line interface"
30718 This is the keyword for the generic command line scanner interface. It can be
30719 used to attach virus scanners that are invoked from the shell. This scanner
30720 type takes 3 mandatory options:
30721
30722 .olist
30723 The full path and name of the scanner binary, with all command line options,
30724 and a placeholder (&`%s`&) for the directory to scan.
30725
30726 .next
30727 A regular expression to match against the STDOUT and STDERR output of the
30728 virus scanner. If the expression matches, a virus was found. You must make
30729 absolutely sure that this expression matches on &"virus found"&. This is called
30730 the &"trigger"& expression.
30731
30732 .next
30733 Another regular expression, containing exactly one pair of parentheses, to
30734 match the name of the virus found in the scanners output. This is called the
30735 &"name"& expression.
30736 .endlist olist
30737
30738 For example, Sophos Sweep reports a virus on a line like this:
30739 .code
30740 Virus 'W32/Magistr-B' found in file ./those.bat
30741 .endd
30742 For the trigger expression, we can match the phrase &"found in file"&. For the
30743 name expression, we want to extract the W32/Magistr-B string, so we can match
30744 for the single quotes left and right of it. Altogether, this makes the
30745 configuration setting:
30746 .code
30747 av_scanner = cmdline:\
30748              /path/to/sweep -ss -all -rec -archive %s:\
30749              found in file:'(.+)'
30750 .endd
30751 .vitem &%drweb%&
30752 .cindex "virus scanners" "DrWeb"
30753 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30754 takes one option,
30755 either a full path to a UNIX socket,
30756 or host and port specifiers separated by white space.
30757 The host may be a name or an IP address; the port is either a
30758 single number or a pair of numbers with a dash between.
30759 For example:
30760 .code
30761 av_scanner = drweb:/var/run/drwebd.sock
30762 av_scanner = drweb:192.168.2.20 31337
30763 .endd
30764 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30765 is used. Thanks to Alex Miller for contributing the code for this scanner.
30766
30767 .vitem &%f-protd%&
30768 .cindex "virus scanners" "f-protd"
30769 The f-protd scanner is accessed via HTTP over TCP.
30770 One argument is taken, being a space-separated hostname and port number
30771 (or port-range).
30772 For example:
30773 .code
30774 av_scanner = f-protd:localhost 10200-10204
30775 .endd
30776 If you omit the argument, the default values show above are used.
30777
30778 .vitem &%fsecure%&
30779 .cindex "virus scanners" "F-Secure"
30780 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30781 argument which is the path to a UNIX socket. For example:
30782 .code
30783 av_scanner = fsecure:/path/to/.fsav
30784 .endd
30785 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30786 Thelmen for contributing the code for this scanner.
30787
30788 .vitem &%kavdaemon%&
30789 .cindex "virus scanners" "Kaspersky"
30790 This is the scanner daemon of Kaspersky Version 4. This version of the
30791 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30792 scanner type takes one option, which is the path to the daemon's UNIX socket.
30793 For example:
30794 .code
30795 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30796 .endd
30797 The default path is &_/var/run/AvpCtl_&.
30798
30799 .vitem &%mksd%&
30800 .cindex "virus scanners" "mksd"
30801 This is a daemon type scanner that is aimed mainly at Polish users, though some
30802 parts of documentation are now available in English. You can get it at
30803 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30804 the maximum number of processes used simultaneously to scan the attachments,
30805 provided that the demime facility is employed and also provided that mksd has
30806 been run with at least the same number of child processes. For example:
30807 .code
30808 av_scanner = mksd:2
30809 .endd
30810 You can safely omit this option (the default value is 1).
30811
30812 .vitem &%sock%&
30813 .cindex "virus scanners" "simple socket-connected"
30814 This is a general-purpose way of talking to simple scanner daemons
30815 running on the local machine.
30816 There are four options:
30817 an address (which may be an IP addres and port, or the path of a Unix socket),
30818 a commandline to send (may include a single %s which will be replaced with
30819 the path to the mail file to be scanned),
30820 an RE to trigger on from the returned data,
30821 an RE to extract malware_name from the returned data.
30822 For example:
30823 .code
30824 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30825 .endd
30826 Default for the socket specifier is &_/tmp/malware.sock_&.
30827 Default for the commandline is &_%s\n_&.
30828 Both regular-expressions are required.
30829
30830 .vitem &%sophie%&
30831 .cindex "virus scanners" "Sophos and Sophie"
30832 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30833 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30834 for this scanner type is the path to the UNIX socket that Sophie uses for
30835 client communication. For example:
30836 .code
30837 av_scanner = sophie:/tmp/sophie
30838 .endd
30839 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30840 the option.
30841 .endlist
30842
30843 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30844 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30845 ACL.
30846
30847 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30848 makes it possible to use different scanners. See further below for an example.
30849 The &%malware%& condition caches its results, so when you use it multiple times
30850 for the same message, the actual scanning process is only carried out once.
30851 However, using expandable items in &%av_scanner%& disables this caching, in
30852 which case each use of the &%malware%& condition causes a new scan of the
30853 message.
30854
30855 The &%malware%& condition takes a right-hand argument that is expanded before
30856 .new
30857 use and taken as a list, slash-separated by default.
30858 .wen
30859 The first element can then be one of
30860
30861 .ilist
30862 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30863 The condition succeeds if a virus was found, and fail otherwise. This is the
30864 recommended usage.
30865 .next
30866 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30867 the condition fails immediately.
30868 .next
30869 A regular expression, in which case the message is scanned for viruses. The
30870 condition succeeds if a virus is found and its name matches the regular
30871 expression. This allows you to take special actions on certain types of virus.
30872 .new
30873 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30874 unless the separator is changed (in the usual way).
30875 .wen
30876 .endlist
30877
30878 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30879 messages even if there is a problem with the virus scanner.
30880 Otherwise, such a problem causes the ACL to defer.
30881
30882 .new
30883 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30884 specify a non-default timeout.  The default is two minutes.
30885 For example:
30886 .code
30887 malware = * / defer_ok / tmo=10s
30888 .endd
30889 A timeout causes the ACL to defer.
30890 .wen
30891
30892 .vindex "&$malware_name$&"
30893 When a virus is found, the condition sets up an expansion variable called
30894 &$malware_name$& that contains the name of the virus. You can use it in a
30895 &%message%& modifier that specifies the error returned to the sender, and/or in
30896 logging data.
30897
30898 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30899 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30900 &%malware%& condition.
30901
30902 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30903 imposed by your anti-virus scanner.
30904
30905 Here is a very simple scanning example:
30906 .code
30907 deny message = This message contains malware ($malware_name)
30908      demime = *
30909      malware = *
30910 .endd
30911 The next example accepts messages when there is a problem with the scanner:
30912 .code
30913 deny message = This message contains malware ($malware_name)
30914      demime = *
30915      malware = */defer_ok
30916 .endd
30917 The next example shows how to use an ACL variable to scan with both sophie and
30918 aveserver. It assumes you have set:
30919 .code
30920 av_scanner = $acl_m0
30921 .endd
30922 in the main Exim configuration.
30923 .code
30924 deny message = This message contains malware ($malware_name)
30925      set acl_m0 = sophie
30926      malware = *
30927
30928 deny message = This message contains malware ($malware_name)
30929      set acl_m0 = aveserver
30930      malware = *
30931 .endd
30932
30933
30934 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
30935 .cindex "content scanning" "for spam"
30936 .cindex "spam scanning"
30937 .cindex "SpamAssassin"
30938 .cindex "Rspamd"
30939 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30940 score and a report for the message.
30941 .new
30942 Support is also provided for Rspamd.
30943
30944 For more information about installation and configuration of SpamAssassin or 
30945 Rspamd refer to their respective websites at
30946 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
30947 .wen
30948
30949 SpamAssassin can be installed with CPAN by running:
30950 .code
30951 perl -MCPAN -e 'install Mail::SpamAssassin'
30952 .endd
30953 SpamAssassin has its own set of configuration files. Please review its
30954 documentation to see how you can tweak it. The default installation should work
30955 nicely, however.
30956
30957 .oindex "&%spamd_address%&"
30958 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you 
30959 intend to use an instance running on the local host you do not need to set
30960 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
30961 you must set the &%spamd_address%& option in the global part of the Exim
30962 configuration as follows (example):
30963 .code
30964 spamd_address = 192.168.99.45 387
30965 .endd
30966
30967 .new
30968 To use Rspamd (which by default listens on all local addresses
30969 on TCP port 11333)
30970 you should add &%variant=rspamd%& after the address/port pair, for example:
30971 .code
30972 spamd_address = 127.0.0.1 11333 variant=rspamd
30973 .endd
30974 .wen
30975
30976 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
30977 sockets. If you want to us these, supply &%spamd_address%& with an absolute
30978 file name instead of an address/port pair:
30979 .code
30980 spamd_address = /var/run/spamd_socket
30981 .endd
30982 You can have multiple &%spamd%& servers to improve scalability. These can
30983 reside on other hardware reachable over the network. To specify multiple
30984 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30985 option, separated with colons (the separator can be changed in the usual way):
30986 .code
30987 spamd_address = 192.168.2.10 783 : \
30988                 192.168.2.11 783 : \
30989                 192.168.2.12 783
30990 .endd
30991 Up to 32 &%spamd%& servers are supported.
30992 When a server fails to respond to the connection attempt, all other
30993 servers are tried until one succeeds. If no server responds, the &%spam%&
30994 condition defers.
30995
30996 .new
30997 Unix and TCP socket specifications may be mixed in any order.
30998 Each element of the list is a list itself, space-separated by default
30999 and changeable in the usual way.
31000
31001 For TCP socket specifications a host name or IP (v4 or v6, but
31002 subject to list-separator quoting rules) address can be used,
31003 and the port can be one or a dash-separated pair.
31004 In the latter case, the range is tried in strict order.
31005
31006 Elements after the first for Unix sockets, or second for TCP socket,
31007 are options.
31008 The supported option are:
31009 .code
31010 pri=<priority>      Selection priority
31011 weight=<value>      Selection bias
31012 time=<start>-<end>  Use only between these times of day
31013 retry=<timespec>    Retry on connect fail
31014 tmo=<timespec>      Connection time limit
31015 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31016 .endd
31017
31018 The &`pri`& option specifies a priority for the server within the list,
31019 higher values being tried first.
31020 The deafult priority is 1.
31021
31022 The &`weight`& option specifies a selection bias.
31023 Within a priority set
31024 servers are queried in a random fashion, weighted by this value.
31025 The default value for selection bias is 1.
31026
31027 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31028 in the local time zone; each element being one or more digits.
31029 Either the seconds or both minutes and seconds, plus the leading &`.`&
31030 characters, may be omitted and will be taken as zero.
31031
31032 Timeout specifications for the &`retry`& and &`tmo`& options
31033 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
31034
31035 The &`tmo`& option specifies an overall timeout for communication.
31036 The default value is two minutes.
31037
31038 The &`retry`& option specifies a time after which a single retry for
31039 a failed connect is made.
31040 The default is to not retry.
31041 .wen
31042
31043 The &%spamd_address%& variable is expanded before use if it starts with
31044 a dollar sign. In this case, the expansion may return a string that is
31045 used as the list so that multiple spamd servers can be the result of an
31046 expansion.
31047
31048 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31049 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31050 .code
31051 deny message = This message was classified as SPAM
31052      spam = joe
31053 .endd
31054 The right-hand side of the &%spam%& condition specifies a name. This is
31055 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31056 to scan using a specific profile, but rather use the SpamAssassin system-wide
31057 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31058 .new
31059 Rspamd does not use this setting. However, you must put something on the
31060 right-hand side.
31061 .wen
31062
31063 The name allows you to use per-domain or per-user antispam profiles in
31064 principle, but this is not straightforward in practice, because a message may
31065 have multiple recipients, not necessarily all in the same domain. Because the
31066 &%spam%& condition has to be called from a DATA ACL in order to be able to
31067 read the contents of the message, the variables &$local_part$& and &$domain$&
31068 are not set.
31069 Careful enforcement of single-recipient messages
31070 (eg. by responding with defer in the recipient ACL for all recipients
31071 after the first),
31072 or the use of PRDR,
31073 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31074 are needed to use this feature.
31075
31076 The right-hand side of the &%spam%& condition is expanded before being used, so
31077 you can put lookups or conditions there. When the right-hand side evaluates to
31078 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31079
31080
31081 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31082 large ones may cause significant performance degradation. As most spam messages
31083 are quite small, it is recommended that you do not scan the big ones. For
31084 example:
31085 .code
31086 deny message = This message was classified as SPAM
31087      condition = ${if < {$message_size}{10K}}
31088      spam = nobody
31089 .endd
31090
31091 The &%spam%& condition returns true if the threshold specified in the user's
31092 SpamAssassin profile has been matched or exceeded. If you want to use the
31093 &%spam%& condition for its side effects (see the variables below), you can make
31094 it always return &"true"& by appending &`:true`& to the username.
31095
31096 .cindex "spam scanning" "returned variables"
31097 When the &%spam%& condition is run, it sets up a number of expansion
31098 variables. These variables are saved with the received message, thus they are
31099 available for use at delivery time.
31100
31101 .vlist
31102 .vitem &$spam_score$&
31103 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31104 for inclusion in log or reject messages.
31105
31106 .vitem &$spam_score_int$&
31107 The spam score of the message, multiplied by ten, as an integer value. For
31108 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31109 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31110 The integer value is useful for numeric comparisons in conditions.
31111
31112 .vitem &$spam_bar$&
31113 A string consisting of a number of &"+"& or &"-"& characters, representing the
31114 integer part of the spam score value. A spam score of 4.4 would have a
31115 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31116 headers, since MUAs can match on such strings.
31117
31118 .vitem &$spam_report$&
31119 A multiline text table, containing the full SpamAssassin report for the
31120 message. Useful for inclusion in headers or reject messages.
31121
31122 .new
31123 .vitem &$spam_action$&
31124 For SpamAssassin either 'reject' or 'no action' depending on the
31125 spam score versus threshold.
31126 For Rspamd, the recommended action.
31127 .wen
31128
31129 .endlist
31130
31131 The &%spam%& condition caches its results unless expansion in
31132 spamd_address was used. If you call it again with the same user name, it
31133 does not scan again, but rather returns the same values as before.
31134
31135 The &%spam%& condition returns DEFER if there is any error while running
31136 the message through SpamAssassin or if the expansion of spamd_address
31137 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31138 statement block), append &`/defer_ok`& to the right-hand side of the
31139 spam condition, like this:
31140 .code
31141 deny message = This message was classified as SPAM
31142      spam    = joe/defer_ok
31143 .endd
31144 This causes messages to be accepted even if there is a problem with &%spamd%&.
31145
31146 Here is a longer, commented example of the use of the &%spam%&
31147 condition:
31148 .code
31149 # put headers in all messages (no matter if spam or not)
31150 warn  spam = nobody:true
31151       add_header = X-Spam-Score: $spam_score ($spam_bar)
31152       add_header = X-Spam-Report: $spam_report
31153
31154 # add second subject line with *SPAM* marker when message
31155 # is over threshold
31156 warn  spam = nobody
31157       add_header = Subject: *SPAM* $h_Subject:
31158
31159 # reject spam at high scores (> 12)
31160 deny  message = This message scored $spam_score spam points.
31161       spam = nobody:true
31162       condition = ${if >{$spam_score_int}{120}{1}{0}}
31163 .endd
31164
31165
31166
31167 .section "Scanning MIME parts" "SECTscanmimepart"
31168 .cindex "content scanning" "MIME parts"
31169 .cindex "MIME content scanning"
31170 .oindex "&%acl_smtp_mime%&"
31171 .oindex "&%acl_not_smtp_mime%&"
31172 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31173 each MIME part of an SMTP message, including multipart types, in the sequence
31174 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31175 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31176 options may both refer to the same ACL if you want the same processing in both
31177 cases.
31178
31179 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31180 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31181 the case of a non-SMTP message. However, a MIME ACL is called only if the
31182 message contains a &'Content-Type:'& header line. When a call to a MIME
31183 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31184 result code is sent to the client. In the case of an SMTP message, the
31185 &%acl_smtp_data%& ACL is not called when this happens.
31186
31187 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31188 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31189 condition to match against the raw MIME part. You can also use the
31190 &%mime_regex%& condition to match against the decoded MIME part (see section
31191 &<<SECTscanregex>>&).
31192
31193 At the start of a MIME ACL, a number of variables are set from the header
31194 information for the relevant MIME part. These are described below. The contents
31195 of the MIME part are not by default decoded into a disk file except for MIME
31196 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31197 part into a disk file, you can use the &%decode%& condition. The general
31198 syntax is:
31199 .display
31200 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31201 .endd
31202 The right hand side is expanded before use. After expansion,
31203 the value can be:
31204
31205 .olist
31206 &"0"& or &"false"&, in which case no decoding is done.
31207 .next
31208 The string &"default"&. In that case, the file is put in the temporary
31209 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31210 a sequential file name consisting of the message id and a sequence number. The
31211 full path and name is available in &$mime_decoded_filename$& after decoding.
31212 .next
31213 A full path name starting with a slash. If the full name is an existing
31214 directory, it is used as a replacement for the default directory. The filename
31215 is then sequentially assigned. If the path does not exist, it is used as
31216 the full path and file name.
31217 .next
31218 If the string does not start with a slash, it is used as the
31219 filename, and the default path is then used.
31220 .endlist
31221 The &%decode%& condition normally succeeds. It is only false for syntax
31222 errors or unusual circumstances such as memory shortages. You can easily decode
31223 a file with its original, proposed filename using
31224 .code
31225 decode = $mime_filename
31226 .endd
31227 However, you should keep in mind that &$mime_filename$& might contain
31228 anything. If you place files outside of the default path, they are not
31229 automatically unlinked.
31230
31231 For RFC822 attachments (these are messages attached to messages, with a
31232 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31233 as for the primary message, only that the &$mime_is_rfc822$& expansion
31234 variable is set (see below). Attached messages are always decoded to disk
31235 before being checked, and the files are unlinked once the check is done.
31236
31237 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31238 used to match regular expressions against raw and decoded MIME parts,
31239 respectively. They are described in section &<<SECTscanregex>>&.
31240
31241 .cindex "MIME content scanning" "returned variables"
31242 The following list describes all expansion variables that are
31243 available in the MIME ACL:
31244
31245 .vlist
31246 .vitem &$mime_boundary$&
31247 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31248 have a boundary string, which is stored in this variable. If the current part
31249 has no boundary parameter in the &'Content-Type:'& header, this variable
31250 contains the empty string.
31251
31252 .vitem &$mime_charset$&
31253 This variable contains the character set identifier, if one was found in the
31254 &'Content-Type:'& header. Examples for charset identifiers are:
31255 .code
31256 us-ascii
31257 gb2312 (Chinese)
31258 iso-8859-1
31259 .endd
31260 Please note that this value is not normalized, so you should do matches
31261 case-insensitively.
31262
31263 .vitem &$mime_content_description$&
31264 This variable contains the normalized content of the &'Content-Description:'&
31265 header. It can contain a human-readable description of the parts content. Some
31266 implementations repeat the filename for attachments here, but they are usually
31267 only used for display purposes.
31268
31269 .vitem &$mime_content_disposition$&
31270 This variable contains the normalized content of the &'Content-Disposition:'&
31271 header. You can expect strings like &"attachment"& or &"inline"& here.
31272
31273 .vitem &$mime_content_id$&
31274 This variable contains the normalized content of the &'Content-ID:'& header.
31275 This is a unique ID that can be used to reference a part from another part.
31276
31277 .vitem &$mime_content_size$&
31278 This variable is set only after the &%decode%& modifier (see above) has been
31279 successfully run. It contains the size of the decoded part in kilobytes. The
31280 size is always rounded up to full kilobytes, so only a completely empty part
31281 has a &$mime_content_size$& of zero.
31282
31283 .vitem &$mime_content_transfer_encoding$&
31284 This variable contains the normalized content of the
31285 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31286 type. Typical values are &"base64"& and &"quoted-printable"&.
31287
31288 .vitem &$mime_content_type$&
31289 If the MIME part has a &'Content-Type:'& header, this variable contains its
31290 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31291 are some examples of popular MIME types, as they may appear in this variable:
31292 .code
31293 text/plain
31294 text/html
31295 application/octet-stream
31296 image/jpeg
31297 audio/midi
31298 .endd
31299 If the MIME part has no &'Content-Type:'& header, this variable contains the
31300 empty string.
31301
31302 .vitem &$mime_decoded_filename$&
31303 This variable is set only after the &%decode%& modifier (see above) has been
31304 successfully run. It contains the full path and file name of the file
31305 containing the decoded data.
31306 .endlist
31307
31308 .cindex "RFC 2047"
31309 .vlist
31310 .vitem &$mime_filename$&
31311 This is perhaps the most important of the MIME variables. It contains a
31312 proposed filename for an attachment, if one was found in either the
31313 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31314 RFC2047 or RFC2231 decoded, but no additional sanity checks are done.
31315  If no filename was
31316 found, this variable contains the empty string.
31317
31318 .vitem &$mime_is_coverletter$&
31319 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31320 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31321 content in the cover letter, while not restricting attachments at all.
31322
31323 The variable contains 1 (true) for a MIME part believed to be part of the
31324 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31325 follows:
31326
31327 .olist
31328 The outermost MIME part of a message is always a cover letter.
31329
31330 .next
31331 If a multipart/alternative or multipart/related MIME part is a cover letter,
31332 so are all MIME subparts within that multipart.
31333
31334 .next
31335 If any other multipart is a cover letter, the first subpart is a cover letter,
31336 and the rest are attachments.
31337
31338 .next
31339 All parts contained within an attachment multipart are attachments.
31340 .endlist olist
31341
31342 As an example, the following will ban &"HTML mail"& (including that sent with
31343 alternative plain text), while allowing HTML files to be attached. HTML
31344 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31345 .code
31346 deny message = HTML mail is not accepted here
31347 !condition = $mime_is_rfc822
31348 condition = $mime_is_coverletter
31349 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31350 .endd
31351 .vitem &$mime_is_multipart$&
31352 This variable has the value 1 (true) when the current part has the main type
31353 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31354 Since multipart entities only serve as containers for other parts, you may not
31355 want to carry out specific actions on them.
31356
31357 .vitem &$mime_is_rfc822$&
31358 This variable has the value 1 (true) if the current part is not a part of the
31359 checked message itself, but part of an attached message. Attached message
31360 decoding is fully recursive.
31361
31362 .vitem &$mime_part_count$&
31363 This variable is a counter that is raised for each processed MIME part. It
31364 starts at zero for the very first part (which is usually a multipart). The
31365 counter is per-message, so it is reset when processing RFC822 attachments (see
31366 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31367 complete, so you can use it in the DATA ACL to determine the number of MIME
31368 parts of a message. For non-MIME messages, this variable contains the value -1.
31369 .endlist
31370
31371
31372
31373 .section "Scanning with regular expressions" "SECTscanregex"
31374 .cindex "content scanning" "with regular expressions"
31375 .cindex "regular expressions" "content scanning with"
31376 You can specify your own custom regular expression matches on the full body of
31377 the message, or on individual MIME parts.
31378
31379 The &%regex%& condition takes one or more regular expressions as arguments and
31380 matches them against the full message (when called in the DATA ACL) or a raw
31381 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31382 linewise, with a maximum line length of 32K characters. That means you cannot
31383 have multiline matches with the &%regex%& condition.
31384
31385 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31386 to 32K of decoded content (the whole content at once, not linewise). If the
31387 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31388 is decoded automatically when &%mime_regex%& is executed (using default path
31389 and filename values). If the decoded data is larger than  32K, only the first
31390 32K characters are checked.
31391
31392 The regular expressions are passed as a colon-separated list. To include a
31393 literal colon, you must double it. Since the whole right-hand side string is
31394 expanded before being used, you must also escape dollar signs and backslashes
31395 with more backslashes, or use the &`\N`& facility to disable expansion.
31396 Here is a simple example that contains two regular expressions:
31397 .code
31398 deny message = contains blacklisted regex ($regex_match_string)
31399      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31400 .endd
31401 The conditions returns true if any one of the regular expressions matches. The
31402 &$regex_match_string$& expansion variable is then set up and contains the
31403 matching regular expression.
31404
31405 &*Warning*&: With large messages, these conditions can be fairly
31406 CPU-intensive.
31407
31408
31409
31410
31411 .section "The demime condition" "SECTdemimecond"
31412 .cindex "content scanning" "MIME checking"
31413 .cindex "MIME content scanning"
31414 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31415 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31416 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31417 ACL functionality, but provides no additional facilities. Please note that this
31418 condition is deprecated and kept only for backward compatibility. You must set
31419 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31420 use the &%demime%& condition.
31421
31422 The &%demime%& condition unpacks MIME containers in the message. It detects
31423 errors in MIME containers and can match file extensions found in the message
31424 against a list. Using this facility produces files containing the unpacked MIME
31425 parts of the message in the temporary scan directory. If you do antivirus
31426 scanning, it is recommended that you use the &%demime%& condition before the
31427 antivirus (&%malware%&) condition.
31428
31429 On the right-hand side of the &%demime%& condition you can pass a
31430 colon-separated list of file extensions that it should match against. For
31431 example:
31432 .code
31433 deny message = Found blacklisted file attachment
31434      demime  = vbs:com:bat:pif:prf:lnk
31435 .endd
31436 If one of the file extensions is found, the condition is true, otherwise it is
31437 false. If there is a temporary error while demimeing (for example, &"disk
31438 full"&), the condition defers, and the message is temporarily rejected (unless
31439 the condition is on a &%warn%& verb).
31440
31441 The right-hand side is expanded before being treated as a list, so you can have
31442 conditions and lookups there. If it expands to an empty string, &"false"&, or
31443 zero (&"0"&), no demimeing is done and the condition is false.
31444
31445 The &%demime%& condition set the following variables:
31446
31447 .vlist
31448 .vitem &$demime_errorlevel$&
31449 .vindex "&$demime_errorlevel$&"
31450 When an error is detected in a MIME container, this variable contains the
31451 severity of the error, as an integer number. The higher the value, the more
31452 severe the error (the current maximum value is 3). If this variable is unset or
31453 zero, no error occurred.
31454
31455 .vitem &$demime_reason$&
31456 .vindex "&$demime_reason$&"
31457 When &$demime_errorlevel$& is greater than zero, this variable contains a
31458 human-readable text string describing the MIME error that occurred.
31459 .endlist
31460
31461 .vlist
31462 .vitem &$found_extension$&
31463 .vindex "&$found_extension$&"
31464 When the &%demime%& condition is true, this variable contains the file
31465 extension it found.
31466 .endlist
31467
31468 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31469 the &%demime%& condition, and are not changed on subsequent calls.
31470
31471 If you do not want to check for file extensions, but rather use the &%demime%&
31472 condition for unpacking or error checking purposes, pass &"*"& as the
31473 right-hand side value. Here is a more elaborate example of how to use this
31474 facility:
31475 .code
31476 # Reject messages with serious MIME container errors
31477 deny  message = Found MIME error ($demime_reason).
31478       demime = *
31479       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31480
31481 # Reject known virus spreading file extensions.
31482 # Accepting these is pretty much braindead.
31483 deny  message = contains $found_extension file (blacklisted).
31484       demime  = com:vbs:bat:pif:scr
31485
31486 # Freeze .exe and .doc files. Postmaster can
31487 # examine them and eventually thaw them.
31488 deny  log_message = Another $found_extension file.
31489       demime = exe:doc
31490       control = freeze
31491 .endd
31492 .ecindex IIDcosca
31493
31494
31495
31496
31497 . ////////////////////////////////////////////////////////////////////////////
31498 . ////////////////////////////////////////////////////////////////////////////
31499
31500 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31501          "Local scan function"
31502 .scindex IIDlosca "&[local_scan()]& function" "description of"
31503 .cindex "customizing" "input scan using C function"
31504 .cindex "policy control" "by local scan function"
31505 In these days of email worms, viruses, and ever-increasing spam, some sites
31506 want to apply a lot of checking to messages before accepting them.
31507
31508 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31509 passing messages to external virus and spam scanning software. You can also do
31510 a certain amount in Exim itself through string expansions and the &%condition%&
31511 condition in the ACL that runs after the SMTP DATA command or the ACL for
31512 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31513
31514 To allow for further customization to a site's own requirements, there is the
31515 possibility of linking Exim with a private message scanning function, written
31516 in C. If you want to run code that is written in something other than C, you
31517 can of course use a little C stub to call it.
31518
31519 The local scan function is run once for every incoming message, at the point
31520 when Exim is just about to accept the message.
31521 It can therefore be used to control non-SMTP messages from local processes as
31522 well as messages arriving via SMTP.
31523
31524 Exim applies a timeout to calls of the local scan function, and there is an
31525 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31526 Zero means &"no timeout"&.
31527 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31528 before calling the local scan function, so that the most common types of crash
31529 are caught. If the timeout is exceeded or one of those signals is caught, the
31530 incoming message is rejected with a temporary error if it is an SMTP message.
31531 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31532 code. The incident is logged on the main and reject logs.
31533
31534
31535
31536 .section "Building Exim to use a local scan function" "SECID207"
31537 .cindex "&[local_scan()]& function" "building Exim to use"
31538 To make use of the local scan function feature, you must tell Exim where your
31539 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31540 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31541 directory, so you might set
31542 .code
31543 LOCAL_SCAN_SOURCE=Local/local_scan.c
31544 .endd
31545 for example. The function must be called &[local_scan()]&. It is called by
31546 Exim after it has received a message, when the success return code is about to
31547 be sent. This is after all the ACLs have been run. The return code from your
31548 function controls whether the message is actually accepted or not. There is a
31549 commented template function (that just accepts the message) in the file
31550 _src/local_scan.c_.
31551
31552 If you want to make use of Exim's run time configuration file to set options
31553 for your &[local_scan()]& function, you must also set
31554 .code
31555 LOCAL_SCAN_HAS_OPTIONS=yes
31556 .endd
31557 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31558
31559
31560
31561
31562 .section "API for local_scan()" "SECTapiforloc"
31563 .cindex "&[local_scan()]& function" "API description"
31564 You must include this line near the start of your code:
31565 .code
31566 #include "local_scan.h"
31567 .endd
31568 This header file defines a number of variables and other values, and the
31569 prototype for the function itself. Exim is coded to use unsigned char values
31570 almost exclusively, and one of the things this header defines is a shorthand
31571 for &`unsigned char`& called &`uschar`&.
31572 It also contains the following macro definitions, to simplify casting character
31573 strings and pointers to character strings:
31574 .code
31575 #define CS   (char *)
31576 #define CCS  (const char *)
31577 #define CSS  (char **)
31578 #define US   (unsigned char *)
31579 #define CUS  (const unsigned char *)
31580 #define USS  (unsigned char **)
31581 .endd
31582 The function prototype for &[local_scan()]& is:
31583 .code
31584 extern int local_scan(int fd, uschar **return_text);
31585 .endd
31586 The arguments are as follows:
31587
31588 .ilist
31589 &%fd%& is a file descriptor for the file that contains the body of the message
31590 (the -D file). The file is open for reading and writing, but updating it is not
31591 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31592
31593 The descriptor is positioned at character 19 of the file, which is the first
31594 character of the body itself, because the first 19 characters are the message
31595 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31596 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31597 case this changes in some future version.
31598 .next
31599 &%return_text%& is an address which you can use to return a pointer to a text
31600 string at the end of the function. The value it points to on entry is NULL.
31601 .endlist
31602
31603 The function must return an &%int%& value which is one of the following macros:
31604
31605 .vlist
31606 .vitem &`LOCAL_SCAN_ACCEPT`&
31607 .vindex "&$local_scan_data$&"
31608 The message is accepted. If you pass back a string of text, it is saved with
31609 the message, and made available in the variable &$local_scan_data$&. No
31610 newlines are permitted (if there are any, they are turned into spaces) and the
31611 maximum length of text is 1000 characters.
31612
31613 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31614 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31615 queued without immediate delivery, and is frozen.
31616
31617 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31618 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31619 queued without immediate delivery.
31620
31621 .vitem &`LOCAL_SCAN_REJECT`&
31622 The message is rejected; the returned text is used as an error message which is
31623 passed back to the sender and which is also logged. Newlines are permitted &--
31624 they cause a multiline response for SMTP rejections, but are converted to
31625 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31626 used.
31627
31628 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31629 The message is temporarily rejected; the returned text is used as an error
31630 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31631 problem"& is used.
31632
31633 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31634 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31635 message is not written to the reject log. It has the effect of unsetting the
31636 &%rejected_header%& log selector for just this rejection. If
31637 &%rejected_header%& is already unset (see the discussion of the
31638 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31639 same as LOCAL_SCAN_REJECT.
31640
31641 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31642 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31643 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31644 .endlist
31645
31646 If the message is not being received by interactive SMTP, rejections are
31647 reported by writing to &%stderr%& or by sending an email, as configured by the
31648 &%-oe%& command line options.
31649
31650
31651
31652 .section "Configuration options for local_scan()" "SECTconoptloc"
31653 .cindex "&[local_scan()]& function" "configuration options"
31654 It is possible to have option settings in the main configuration file
31655 that set values in static variables in the &[local_scan()]& module. If you
31656 want to do this, you must have the line
31657 .code
31658 LOCAL_SCAN_HAS_OPTIONS=yes
31659 .endd
31660 in your &_Local/Makefile_& when you build Exim. (This line is in
31661 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31662 file, you must define static variables to hold the option values, and a table
31663 to define them.
31664
31665 The table must be a vector called &%local_scan_options%&, of type
31666 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31667 and a pointer to the variable that holds the value. The entries must appear in
31668 alphabetical order. Following &%local_scan_options%& you must also define a
31669 variable called &%local_scan_options_count%& that contains the number of
31670 entries in the table. Here is a short example, showing two kinds of option:
31671 .code
31672 static int my_integer_option = 42;
31673 static uschar *my_string_option = US"a default string";
31674
31675 optionlist local_scan_options[] = {
31676   { "my_integer", opt_int,       &my_integer_option },
31677   { "my_string",  opt_stringptr, &my_string_option }
31678 };
31679
31680 int local_scan_options_count =
31681   sizeof(local_scan_options)/sizeof(optionlist);
31682 .endd
31683 The values of the variables can now be changed from Exim's runtime
31684 configuration file by including a local scan section as in this example:
31685 .code
31686 begin local_scan
31687 my_integer = 99
31688 my_string = some string of text...
31689 .endd
31690 The available types of option data are as follows:
31691
31692 .vlist
31693 .vitem &*opt_bool*&
31694 This specifies a boolean (true/false) option. The address should point to a
31695 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31696 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31697 whether such a variable has been set at all, you can initialize it to
31698 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31699 values.)
31700
31701 .vitem &*opt_fixed*&
31702 This specifies a fixed point number, such as is used for load averages.
31703 The address should point to a variable of type &`int`&. The value is stored
31704 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31705
31706 .vitem &*opt_int*&
31707 This specifies an integer; the address should point to a variable of type
31708 &`int`&. The value may be specified in any of the integer formats accepted by
31709 Exim.
31710
31711 .vitem &*opt_mkint*&
31712 This is the same as &%opt_int%&, except that when such a value is output in a
31713 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31714 printed with the suffix K or M.
31715
31716 .vitem &*opt_octint*&
31717 This also specifies an integer, but the value is always interpreted as an
31718 octal integer, whether or not it starts with the digit zero, and it is
31719 always output in octal.
31720
31721 .vitem &*opt_stringptr*&
31722 This specifies a string value; the address must be a pointer to a
31723 variable that points to a string (for example, of type &`uschar *`&).
31724
31725 .vitem &*opt_time*&
31726 This specifies a time interval value. The address must point to a variable of
31727 type &`int`&. The value that is placed there is a number of seconds.
31728 .endlist
31729
31730 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31731 out the values of all the &[local_scan()]& options.
31732
31733
31734
31735 .section "Available Exim variables" "SECID208"
31736 .cindex "&[local_scan()]& function" "available Exim variables"
31737 The header &_local_scan.h_& gives you access to a number of C variables. These
31738 are the only ones that are guaranteed to be maintained from release to release.
31739 Note, however, that you can obtain the value of any Exim expansion variable,
31740 including &$recipients$&, by calling &'expand_string()'&. The exported
31741 C variables are as follows:
31742
31743 .vlist
31744 .vitem &*int&~body_linecount*&
31745 This variable contains the number of lines in the message's body.
31746
31747 .vitem &*int&~body_zerocount*&
31748 This variable contains the number of binary zero bytes in the message's body.
31749
31750 .vitem &*unsigned&~int&~debug_selector*&
31751 This variable is set to zero when no debugging is taking place. Otherwise, it
31752 is a bitmap of debugging selectors. Two bits are identified for use in
31753 &[local_scan()]&; they are defined as macros:
31754
31755 .ilist
31756 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31757 testing option that is not privileged &-- any caller may set it. All the
31758 other selector bits can be set only by admin users.
31759
31760 .next
31761 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31762 by the &`+local_scan`& debug selector. It is not included in the default set
31763 of debugging bits.
31764 .endlist ilist
31765
31766 Thus, to write to the debugging output only when &`+local_scan`& has been
31767 selected, you should use code like this:
31768 .code
31769 if ((debug_selector & D_local_scan) != 0)
31770   debug_printf("xxx", ...);
31771 .endd
31772 .vitem &*uschar&~*expand_string_message*&
31773 After a failing call to &'expand_string()'& (returned value NULL), the
31774 variable &%expand_string_message%& contains the error message, zero-terminated.
31775
31776 .vitem &*header_line&~*header_list*&
31777 A pointer to a chain of header lines. The &%header_line%& structure is
31778 discussed below.
31779
31780 .vitem &*header_line&~*header_last*&
31781 A pointer to the last of the header lines.
31782
31783 .vitem &*uschar&~*headers_charset*&
31784 The value of the &%headers_charset%& configuration option.
31785
31786 .vitem &*BOOL&~host_checking*&
31787 This variable is TRUE during a host checking session that is initiated by the
31788 &%-bh%& command line option.
31789
31790 .vitem &*uschar&~*interface_address*&
31791 The IP address of the interface that received the message, as a string. This
31792 is NULL for locally submitted messages.
31793
31794 .vitem &*int&~interface_port*&
31795 The port on which this message was received. When testing with the &%-bh%&
31796 command line option, the value of this variable is -1 unless a port has been
31797 specified via the &%-oMi%& option.
31798
31799 .vitem &*uschar&~*message_id*&
31800 This variable contains Exim's message id for the incoming message (the value of
31801 &$message_exim_id$&) as a zero-terminated string.
31802
31803 .vitem &*uschar&~*received_protocol*&
31804 The name of the protocol by which the message was received.
31805
31806 .vitem &*int&~recipients_count*&
31807 The number of accepted recipients.
31808
31809 .vitem &*recipient_item&~*recipients_list*&
31810 .cindex "recipient" "adding in local scan"
31811 .cindex "recipient" "removing in local scan"
31812 The list of accepted recipients, held in a vector of length
31813 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31814 can add additional recipients by calling &'receive_add_recipient()'& (see
31815 below). You can delete recipients by removing them from the vector and
31816 adjusting the value in &%recipients_count%&. In particular, by setting
31817 &%recipients_count%& to zero you remove all recipients. If you then return the
31818 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31819 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31820 and then call &'receive_add_recipient()'& as often as needed.
31821
31822 .vitem &*uschar&~*sender_address*&
31823 The envelope sender address. For bounce messages this is the empty string.
31824
31825 .vitem &*uschar&~*sender_host_address*&
31826 The IP address of the sending host, as a string. This is NULL for
31827 locally-submitted messages.
31828
31829 .vitem &*uschar&~*sender_host_authenticated*&
31830 The name of the authentication mechanism that was used, or NULL if the message
31831 was not received over an authenticated SMTP connection.
31832
31833 .vitem &*uschar&~*sender_host_name*&
31834 The name of the sending host, if known.
31835
31836 .vitem &*int&~sender_host_port*&
31837 The port on the sending host.
31838
31839 .vitem &*BOOL&~smtp_input*&
31840 This variable is TRUE for all SMTP input, including BSMTP.
31841
31842 .vitem &*BOOL&~smtp_batched_input*&
31843 This variable is TRUE for BSMTP input.
31844
31845 .vitem &*int&~store_pool*&
31846 The contents of this variable control which pool of memory is used for new
31847 requests. See section &<<SECTmemhanloc>>& for details.
31848 .endlist
31849
31850
31851 .section "Structure of header lines" "SECID209"
31852 The &%header_line%& structure contains the members listed below.
31853 You can add additional header lines by calling the &'header_add()'& function
31854 (see below). You can cause header lines to be ignored (deleted) by setting
31855 their type to *.
31856
31857
31858 .vlist
31859 .vitem &*struct&~header_line&~*next*&
31860 A pointer to the next header line, or NULL for the last line.
31861
31862 .vitem &*int&~type*&
31863 A code identifying certain headers that Exim recognizes. The codes are printing
31864 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31865 Notice in particular that any header line whose type is * is not transmitted
31866 with the message. This flagging is used for header lines that have been
31867 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31868 lines.) Effectively, * means &"deleted"&.
31869
31870 .vitem &*int&~slen*&
31871 The number of characters in the header line, including the terminating and any
31872 internal newlines.
31873
31874 .vitem &*uschar&~*text*&
31875 A pointer to the text of the header. It always ends with a newline, followed by
31876 a zero byte. Internal newlines are preserved.
31877 .endlist
31878
31879
31880
31881 .section "Structure of recipient items" "SECID210"
31882 The &%recipient_item%& structure contains these members:
31883
31884 .vlist
31885 .vitem &*uschar&~*address*&
31886 This is a pointer to the recipient address as it was received.
31887
31888 .vitem &*int&~pno*&
31889 This is used in later Exim processing when top level addresses are created by
31890 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31891 and must always contain -1 at this stage.
31892
31893 .vitem &*uschar&~*errors_to*&
31894 If this value is not NULL, bounce messages caused by failing to deliver to the
31895 recipient are sent to the address it contains. In other words, it overrides the
31896 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31897 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31898 an unqualified address, Exim qualifies it using the domain from
31899 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31900 is NULL for all recipients.
31901 .endlist
31902
31903
31904
31905 .section "Available Exim functions" "SECID211"
31906 .cindex "&[local_scan()]& function" "available Exim functions"
31907 The header &_local_scan.h_& gives you access to a number of Exim functions.
31908 These are the only ones that are guaranteed to be maintained from release to
31909 release:
31910
31911 .vlist
31912 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31913        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31914
31915 This function creates a child process that runs the command specified by
31916 &%argv%&. The environment for the process is specified by &%envp%&, which can
31917 be NULL if no environment variables are to be passed. A new umask is supplied
31918 for the process in &%newumask%&.
31919
31920 Pipes to the standard input and output of the new process are set up
31921 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31922 standard error is cloned to the standard output. If there are any file
31923 descriptors &"in the way"& in the new process, they are closed. If the final
31924 argument is TRUE, the new process is made into a process group leader.
31925
31926 The function returns the pid of the new process, or -1 if things go wrong.
31927
31928 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31929 This function waits for a child process to terminate, or for a timeout (in
31930 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31931 return value is as follows:
31932
31933 .ilist
31934 >= 0
31935
31936 The process terminated by a normal exit and the value is the process
31937 ending status.
31938
31939 .next
31940 < 0 and > &--256
31941
31942 The process was terminated by a signal and the value is the negation of the
31943 signal number.
31944
31945 .next
31946 &--256
31947
31948 The process timed out.
31949 .next
31950 &--257
31951
31952 The was some other error in wait(); &%errno%& is still set.
31953 .endlist
31954
31955 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31956 This function provide you with a means of submitting a new message to
31957 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31958 want, but this packages it all up for you.) The function creates a pipe,
31959 forks a subprocess that is running
31960 .code
31961 exim -t -oem -oi -f <>
31962 .endd
31963 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31964 that is connected to the standard input. The yield of the function is the PID
31965 of the subprocess. You can then write a message to the file descriptor, with
31966 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31967
31968 When you have finished, call &'child_close()'& to wait for the process to
31969 finish and to collect its ending status. A timeout value of zero is usually
31970 fine in this circumstance. Unless you have made a mistake with the recipient
31971 addresses, you should get a return code of zero.
31972
31973
31974 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31975        *sender_authentication)*&
31976 This function is a more sophisticated version of &'child_open()'&. The command
31977 that it runs is:
31978 .display
31979 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31980 .endd
31981 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31982
31983
31984 .vitem &*void&~debug_printf(char&~*,&~...)*&
31985 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31986 output is written to the standard error stream. If no debugging is selected,
31987 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31988 conditional on the &`local_scan`& debug selector by coding like this:
31989 .code
31990 if ((debug_selector & D_local_scan) != 0)
31991   debug_printf("xxx", ...);
31992 .endd
31993
31994 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31995 This is an interface to Exim's string expansion code. The return value is the
31996 expanded string, or NULL if there was an expansion failure.
31997 The C variable &%expand_string_message%& contains an error message after an
31998 expansion failure. If expansion does not change the string, the return value is
31999 the pointer to the input string. Otherwise, the return value points to a new
32000 block of memory that was obtained by a call to &'store_get()'&. See section
32001 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32002
32003 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32004 This function allows you to an add additional header line at the end of the
32005 existing ones. The first argument is the type, and should normally be a space
32006 character. The second argument is a format string and any number of
32007 substitution arguments as for &[sprintf()]&. You may include internal newlines
32008 if you want, and you must ensure that the string ends with a newline.
32009
32010 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32011         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32012 This function adds a new header line at a specified point in the header
32013 chain. The header itself is specified as for &'header_add()'&.
32014
32015 If &%name%& is NULL, the new header is added at the end of the chain if
32016 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32017 NULL, the header lines are searched for the first non-deleted header that
32018 matches the name. If one is found, the new header is added before it if
32019 &%after%& is false. If &%after%& is true, the new header is added after the
32020 found header and any adjacent subsequent ones with the same name (even if
32021 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32022 option controls where the header is added. If it is true, addition is at the
32023 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32024 headers, or at the top if there are no &'Received:'& headers, you could use
32025 .code
32026 header_add_at_position(TRUE, US"Received", TRUE,
32027   ' ', "X-xxx: ...");
32028 .endd
32029 Normally, there is always at least one non-deleted &'Received:'& header, but
32030 there may not be if &%received_header_text%& expands to an empty string.
32031
32032
32033 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32034 This function removes header lines. If &%occurrence%& is zero or negative, all
32035 occurrences of the header are removed. If occurrence is greater than zero, that
32036 particular instance of the header is removed. If no header(s) can be found that
32037 match the specification, the function does nothing.
32038
32039
32040 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32041         int&~length,&~BOOL&~notdel)*&"
32042 This function tests whether the given header has the given name. It is not just
32043 a string comparison, because white space is permitted between the name and the
32044 colon. If the &%notdel%& argument is true, a false return is forced for all
32045 &"deleted"& headers; otherwise they are not treated specially. For example:
32046 .code
32047 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32048 .endd
32049 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32050 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32051 This function base64-encodes a string, which is passed by address and length.
32052 The text may contain bytes of any value, including zero. The result is passed
32053 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32054 zero-terminated.
32055
32056 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32057 This function decodes a base64-encoded string. Its arguments are a
32058 zero-terminated base64-encoded string and the address of a variable that is set
32059 to point to the result, which is in dynamic memory. The length of the decoded
32060 string is the yield of the function. If the input is invalid base64 data, the
32061 yield is -1. A zero byte is added to the end of the output string to make it
32062 easy to interpret as a C string (assuming it contains no zeros of its own). The
32063 added zero byte is not included in the returned count.
32064
32065 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32066 This function checks for a match in a domain list. Domains are always
32067 matched caselessly. The return value is one of the following:
32068 .display
32069 &`OK     `& match succeeded
32070 &`FAIL   `& match failed
32071 &`DEFER  `& match deferred
32072 .endd
32073 DEFER is usually caused by some kind of lookup defer, such as the
32074 inability to contact a database.
32075
32076 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32077         BOOL&~caseless)*&"
32078 This function checks for a match in a local part list. The third argument
32079 controls case-sensitivity. The return values are as for
32080 &'lss_match_domain()'&.
32081
32082 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32083         BOOL&~caseless)*&"
32084 This function checks for a match in an address list. The third argument
32085 controls the case-sensitivity of the local part match. The domain is always
32086 matched caselessly. The return values are as for &'lss_match_domain()'&.
32087
32088 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32089         uschar&~*list)*&"
32090 This function checks for a match in a host list. The most common usage is
32091 expected to be
32092 .code
32093 lss_match_host(sender_host_name, sender_host_address, ...)
32094 .endd
32095 .vindex "&$sender_host_address$&"
32096 An empty address field matches an empty item in the host list. If the host name
32097 is NULL, the name corresponding to &$sender_host_address$& is automatically
32098 looked up if a host name is required to match an item in the list. The return
32099 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32100 returns ERROR in the case when it had to look up a host name, but the lookup
32101 failed.
32102
32103 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32104         *format,&~...)*&"
32105 This function writes to Exim's log files. The first argument should be zero (it
32106 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32107 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32108 them. It specifies to which log or logs the message is written. The remaining
32109 arguments are a format and relevant insertion arguments. The string should not
32110 contain any newlines, not even at the end.
32111
32112
32113 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32114 This function adds an additional recipient to the message. The first argument
32115 is the recipient address. If it is unqualified (has no domain), it is qualified
32116 with the &%qualify_recipient%& domain. The second argument must always be -1.
32117
32118 This function does not allow you to specify a private &%errors_to%& address (as
32119 described with the structure of &%recipient_item%& above), because it pre-dates
32120 the addition of that field to the structure. However, it is easy to add such a
32121 value afterwards. For example:
32122 .code
32123  receive_add_recipient(US"monitor@mydom.example", -1);
32124  recipients_list[recipients_count-1].errors_to =
32125    US"postmaster@mydom.example";
32126 .endd
32127
32128 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32129 This is a convenience function to remove a named recipient from the list of
32130 recipients. It returns true if a recipient was removed, and false if no
32131 matching recipient could be found. The argument must be a complete email
32132 address.
32133 .endlist
32134
32135
32136 .cindex "RFC 2047"
32137 .vlist
32138 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32139   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32140 This function decodes strings that are encoded according to RFC 2047. Typically
32141 these are the contents of header lines. First, each &"encoded word"& is decoded
32142 from the Q or B encoding into a byte-string. Then, if provided with the name of
32143 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32144 made  to translate the result to the named character set. If this fails, the
32145 binary string is returned with an error message.
32146
32147 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32148 maximum MIME word length is enforced. The third argument is the target
32149 encoding, or NULL if no translation is wanted.
32150
32151 .cindex "binary zero" "in RFC 2047 decoding"
32152 .cindex "RFC 2047" "binary zero in"
32153 If a binary zero is encountered in the decoded string, it is replaced by the
32154 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32155 not be 0 because header lines are handled as zero-terminated strings.
32156
32157 The function returns the result of processing the string, zero-terminated; if
32158 &%lenptr%& is not NULL, the length of the result is set in the variable to
32159 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32160
32161 If an error is encountered, the function returns NULL and uses the &%error%&
32162 argument to return an error message. The variable pointed to by &%error%& is
32163 set to NULL if there is no error; it may be set non-NULL even when the function
32164 returns a non-NULL value if decoding was successful, but there was a problem
32165 with translation.
32166
32167
32168 .vitem &*int&~smtp_fflush(void)*&
32169 This function is used in conjunction with &'smtp_printf()'&, as described
32170 below.
32171
32172 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32173 The arguments of this function are like &[printf()]&; it writes to the SMTP
32174 output stream. You should use this function only when there is an SMTP output
32175 stream, that is, when the incoming message is being received via interactive
32176 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32177 is FALSE. If you want to test for an incoming message from another host (as
32178 opposed to a local process that used the &%-bs%& command line option), you can
32179 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32180 is involved.
32181
32182 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32183 output function, so it can be used for all forms of SMTP connection.
32184
32185 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32186 must start with an appropriate response code: 550 if you are going to return
32187 LOCAL_SCAN_REJECT, 451 if you are going to return
32188 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32189 initial lines of a multi-line response, the code must be followed by a hyphen
32190 to indicate that the line is not the final response line. You must also ensure
32191 that the lines you write terminate with CRLF. For example:
32192 .code
32193 smtp_printf("550-this is some extra info\r\n");
32194 return LOCAL_SCAN_REJECT;
32195 .endd
32196 Note that you can also create multi-line responses by including newlines in
32197 the data returned via the &%return_text%& argument. The added value of using
32198 &'smtp_printf()'& is that, for instance, you could introduce delays between
32199 multiple output lines.
32200
32201 The &'smtp_printf()'& function does not return any error indication, because it
32202 does not automatically flush pending output, and therefore does not test
32203 the state of the stream. (In the main code of Exim, flushing and error
32204 detection is done when Exim is ready for the next SMTP input command.) If
32205 you want to flush the output and check for an error (for example, the
32206 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32207 arguments. It flushes the output stream, and returns a non-zero value if there
32208 is an error.
32209
32210 .vitem &*void&~*store_get(int)*&
32211 This function accesses Exim's internal store (memory) manager. It gets a new
32212 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32213 runs out of memory. See the next section for a discussion of memory handling.
32214
32215 .vitem &*void&~*store_get_perm(int)*&
32216 This function is like &'store_get()'&, but it always gets memory from the
32217 permanent pool. See the next section for a discussion of memory handling.
32218
32219 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32220 See below.
32221
32222 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32223 See below.
32224
32225 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32226 These three functions create strings using Exim's dynamic memory facilities.
32227 The first makes a copy of an entire string. The second copies up to a maximum
32228 number of characters, indicated by the second argument. The third uses a format
32229 and insertion arguments to create a new string. In each case, the result is a
32230 pointer to a new string in the current memory pool. See the next section for
32231 more discussion.
32232 .endlist
32233
32234
32235
32236 .section "More about Exim's memory handling" "SECTmemhanloc"
32237 .cindex "&[local_scan()]& function" "memory handling"
32238 No function is provided for freeing memory, because that is never needed.
32239 The dynamic memory that Exim uses when receiving a message is automatically
32240 recycled if another message is received by the same process (this applies only
32241 to incoming SMTP connections &-- other input methods can supply only one
32242 message at a time). After receiving the last message, a reception process
32243 terminates.
32244
32245 Because it is recycled, the normal dynamic memory cannot be used for holding
32246 data that must be preserved over a number of incoming messages on the same SMTP
32247 connection. However, Exim in fact uses two pools of dynamic memory; the second
32248 one is not recycled, and can be used for this purpose.
32249
32250 If you want to allocate memory that remains available for subsequent messages
32251 in the same SMTP connection, you should set
32252 .code
32253 store_pool = POOL_PERM
32254 .endd
32255 before calling the function that does the allocation. There is no need to
32256 restore the value if you do not need to; however, if you do want to revert to
32257 the normal pool, you can either restore the previous value of &%store_pool%& or
32258 set it explicitly to POOL_MAIN.
32259
32260 The pool setting applies to all functions that get dynamic memory, including
32261 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32262 There is also a convenience function called &'store_get_perm()'& that gets a
32263 block of memory from the permanent pool while preserving the value of
32264 &%store_pool%&.
32265 .ecindex IIDlosca
32266
32267
32268
32269
32270 . ////////////////////////////////////////////////////////////////////////////
32271 . ////////////////////////////////////////////////////////////////////////////
32272
32273 .chapter "System-wide message filtering" "CHAPsystemfilter"
32274 .scindex IIDsysfil1 "filter" "system filter"
32275 .scindex IIDsysfil2 "filtering all mail"
32276 .scindex IIDsysfil3 "system filter"
32277 The previous chapters (on ACLs and the local scan function) describe checks
32278 that can be applied to messages before they are accepted by a host. There is
32279 also a mechanism for checking messages once they have been received, but before
32280 they are delivered. This is called the &'system filter'&.
32281
32282 The system filter operates in a similar manner to users' filter files, but it
32283 is run just once per message (however many recipients the message has).
32284 It should not normally be used as a substitute for routing, because &%deliver%&
32285 commands in a system router provide new envelope recipient addresses.
32286 The system filter must be an Exim filter. It cannot be a Sieve filter.
32287
32288 The system filter is run at the start of a delivery attempt, before any routing
32289 is done. If a message fails to be completely delivered at the first attempt,
32290 the system filter is run again at the start of every retry.
32291 If you want your filter to do something only once per message, you can make use
32292 of the &%first_delivery%& condition in an &%if%& command in the filter to
32293 prevent it happening on retries.
32294
32295 .vindex "&$domain$&"
32296 .vindex "&$local_part$&"
32297 &*Warning*&: Because the system filter runs just once, variables that are
32298 specific to individual recipient addresses, such as &$local_part$& and
32299 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32300 you want to run a centrally-specified filter for each recipient address
32301 independently, you can do so by setting up a suitable &(redirect)& router, as
32302 described in section &<<SECTperaddfil>>& below.
32303
32304
32305 .section "Specifying a system filter" "SECID212"
32306 .cindex "uid (user id)" "system filter"
32307 .cindex "gid (group id)" "system filter"
32308 The name of the file that contains the system filter must be specified by
32309 setting &%system_filter%&. If you want the filter to run under a uid and gid
32310 other than root, you must also set &%system_filter_user%& and
32311 &%system_filter_group%& as appropriate. For example:
32312 .code
32313 system_filter = /etc/mail/exim.filter
32314 system_filter_user = exim
32315 .endd
32316 If a system filter generates any deliveries directly to files or pipes (via the
32317 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32318 specified by setting &%system_filter_file_transport%& and
32319 &%system_filter_pipe_transport%&, respectively. Similarly,
32320 &%system_filter_reply_transport%& must be set to handle any messages generated
32321 by the &%reply%& command.
32322
32323
32324 .section "Testing a system filter" "SECID213"
32325 You can run simple tests of a system filter in the same way as for a user
32326 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32327 are permitted only in system filters are recognized.
32328
32329 If you want to test the combined effect of a system filter and a user filter,
32330 you can use both &%-bF%& and &%-bf%& on the same command line.
32331
32332
32333
32334 .section "Contents of a system filter" "SECID214"
32335 The language used to specify system filters is the same as for users' filter
32336 files. It is described in the separate end-user document &'Exim's interface to
32337 mail filtering'&. However, there are some additional features that are
32338 available only in system filters; these are described in subsequent sections.
32339 If they are encountered in a user's filter file or when testing with &%-bf%&,
32340 they cause errors.
32341
32342 .cindex "frozen messages" "manual thaw; testing in filter"
32343 There are two special conditions which, though available in users' filter
32344 files, are designed for use in system filters. The condition &%first_delivery%&
32345 is true only for the first attempt at delivering a message, and
32346 &%manually_thawed%& is true only if the message has been frozen, and
32347 subsequently thawed by an admin user. An explicit forced delivery counts as a
32348 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32349
32350 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32351 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32352 succeed, it will not be tried again.
32353 If you want Exim to retry an unseen delivery until it succeeds, you should
32354 arrange to set it up every time the filter runs.
32355
32356 When a system filter finishes running, the values of the variables &$n0$& &--
32357 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32358 users' filter files. Thus a system filter can, for example, set up &"scores"&
32359 to which users' filter files can refer.
32360
32361
32362
32363 .section "Additional variable for system filters" "SECID215"
32364 .vindex "&$recipients$&"
32365 The expansion variable &$recipients$&, containing a list of all the recipients
32366 of the message (separated by commas and white space), is available in system
32367 filters. It is not available in users' filters for privacy reasons.
32368
32369
32370
32371 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32372 .cindex "freezing messages"
32373 .cindex "message" "freezing"
32374 .cindex "message" "forced failure"
32375 .cindex "&%fail%&" "in system filter"
32376 .cindex "&%freeze%& in system filter"
32377 .cindex "&%defer%& in system filter"
32378 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32379 always available in system filters, but are not normally enabled in users'
32380 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32381 for the &(redirect)& router.) These commands can optionally be followed by the
32382 word &%text%& and a string containing an error message, for example:
32383 .code
32384 fail text "this message looks like spam to me"
32385 .endd
32386 The keyword &%text%& is optional if the next character is a double quote.
32387
32388 The &%defer%& command defers delivery of the original recipients of the
32389 message. The &%fail%& command causes all the original recipients to be failed,
32390 and a bounce message to be created. The &%freeze%& command suspends all
32391 delivery attempts for the original recipients. In all cases, any new deliveries
32392 that are specified by the filter are attempted as normal after the filter has
32393 run.
32394
32395 The &%freeze%& command is ignored if the message has been manually unfrozen and
32396 not manually frozen since. This means that automatic freezing by a system
32397 filter can be used as a way of checking out suspicious messages. If a message
32398 is found to be all right, manually unfreezing it allows it to be delivered.
32399
32400 .cindex "log" "&%fail%& command log line"
32401 .cindex "&%fail%&" "log line; reducing"
32402 The text given with a fail command is used as part of the bounce message as
32403 well as being written to the log. If the message is quite long, this can fill
32404 up a lot of log space when such failures are common. To reduce the size of the
32405 log message, Exim interprets the text in a special way if it starts with the
32406 two characters &`<<`& and contains &`>>`& later. The text between these two
32407 strings is written to the log, and the rest of the text is used in the bounce
32408 message. For example:
32409 .code
32410 fail "<<filter test 1>>Your message is rejected \
32411      because it contains attachments that we are \
32412      not prepared to receive."
32413 .endd
32414
32415 .cindex "loop" "caused by &%fail%&"
32416 Take great care with the &%fail%& command when basing the decision to fail on
32417 the contents of the message, because the bounce message will of course include
32418 the contents of the original message and will therefore trigger the &%fail%&
32419 command again (causing a mail loop) unless steps are taken to prevent this.
32420 Testing the &%error_message%& condition is one way to prevent this. You could
32421 use, for example
32422 .code
32423 if $message_body contains "this is spam" and not error_message
32424 then fail text "spam is not wanted here" endif
32425 .endd
32426 though of course that might let through unwanted bounce messages. The
32427 alternative is clever checking of the body and/or headers to detect bounces
32428 generated by the filter.
32429
32430 The interpretation of a system filter file ceases after a
32431 &%defer%&,
32432 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32433 set up earlier in the filter file are honoured, so you can use a sequence such
32434 as
32435 .code
32436 mail ...
32437 freeze
32438 .endd
32439 to send a specified message when the system filter is freezing (or deferring or
32440 failing) a message. The normal deliveries for the message do not, of course,
32441 take place.
32442
32443
32444
32445 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32446 .cindex "header lines" "adding; in system filter"
32447 .cindex "header lines" "removing; in system filter"
32448 .cindex "filter" "header lines; adding/removing"
32449 Two filter commands that are available only in system filters are:
32450 .code
32451 headers add <string>
32452 headers remove <string>
32453 .endd
32454 The argument for the &%headers add%& is a string that is expanded and then
32455 added to the end of the message's headers. It is the responsibility of the
32456 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32457 space is ignored, and if the string is otherwise empty, or if the expansion is
32458 forced to fail, the command has no effect.
32459
32460 You can use &"\n"& within the string, followed by white space, to specify
32461 continued header lines. More than one header may be added in one command by
32462 including &"\n"& within the string without any following white space. For
32463 example:
32464 .code
32465 headers add "X-header-1: ....\n  \
32466              continuation of X-header-1 ...\n\
32467              X-header-2: ...."
32468 .endd
32469 Note that the header line continuation white space after the first newline must
32470 be placed before the backslash that continues the input string, because white
32471 space after input continuations is ignored.
32472
32473 The argument for &%headers remove%& is a colon-separated list of header names.
32474 This command applies only to those headers that are stored with the message;
32475 those that are added at delivery time (such as &'Envelope-To:'& and
32476 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32477 header with the same name, they are all removed.
32478
32479 The &%headers%& command in a system filter makes an immediate change to the set
32480 of header lines that was received with the message (with possible additions
32481 from ACL processing). Subsequent commands in the system filter operate on the
32482 modified set, which also forms the basis for subsequent message delivery.
32483 Unless further modified during routing or transporting, this set of headers is
32484 used for all recipients of the message.
32485
32486 During routing and transporting, the variables that refer to the contents of
32487 header lines refer only to those lines that are in this set. Thus, header lines
32488 that are added by a system filter are visible to users' filter files and to all
32489 routers and transports. This contrasts with the manipulation of header lines by
32490 routers and transports, which is not immediate, but which instead is saved up
32491 until the message is actually being written (see section
32492 &<<SECTheadersaddrem>>&).
32493
32494 If the message is not delivered at the first attempt, header lines that were
32495 added by the system filter are stored with the message, and so are still
32496 present at the next delivery attempt. Header lines that were removed are still
32497 present, but marked &"deleted"& so that they are not transported with the
32498 message. For this reason, it is usual to make the &%headers%& command
32499 conditional on &%first_delivery%& so that the set of header lines is not
32500 modified more than once.
32501
32502 Because header modification in a system filter acts immediately, you have to
32503 use an indirect approach if you want to modify the contents of a header line.
32504 For example:
32505 .code
32506 headers add "Old-Subject: $h_subject:"
32507 headers remove "Subject"
32508 headers add "Subject: new subject (was: $h_old-subject:)"
32509 headers remove "Old-Subject"
32510 .endd
32511
32512
32513
32514 .section "Setting an errors address in a system filter" "SECID217"
32515 .cindex "envelope sender"
32516 In a system filter, if a &%deliver%& command is followed by
32517 .code
32518 errors_to <some address>
32519 .endd
32520 in order to change the envelope sender (and hence the error reporting) for that
32521 delivery, any address may be specified. (In a user filter, only the current
32522 user's address can be set.) For example, if some mail is being monitored, you
32523 might use
32524 .code
32525 unseen deliver monitor@spying.example errors_to root@local.example
32526 .endd
32527 to take a copy which would not be sent back to the normal error reporting
32528 address if its delivery failed.
32529
32530
32531
32532 .section "Per-address filtering" "SECTperaddfil"
32533 .vindex "&$domain$&"
32534 .vindex "&$local_part$&"
32535 In contrast to the system filter, which is run just once per message for each
32536 delivery attempt, it is also possible to set up a system-wide filtering
32537 operation that runs once for each recipient address. In this case, variables
32538 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32539 filter file could be made dependent on them. This is an example of a router
32540 which implements such a filter:
32541 .code
32542 central_filter:
32543   check_local_user
32544   driver = redirect
32545   domains = +local_domains
32546   file = /central/filters/$local_part
32547   no_verify
32548   allow_filter
32549   allow_freeze
32550 .endd
32551 The filter is run in a separate process under its own uid. Therefore, either
32552 &%check_local_user%& must be set (as above), in which case the filter is run as
32553 the local user, or the &%user%& option must be used to specify which user to
32554 use. If both are set, &%user%& overrides.
32555
32556 Care should be taken to ensure that none of the commands in the filter file
32557 specify a significant delivery if the message is to go on to be delivered to
32558 its intended recipient. The router will not then claim to have dealt with the
32559 address, so it will be passed on to subsequent routers to be delivered in the
32560 normal way.
32561 .ecindex IIDsysfil1
32562 .ecindex IIDsysfil2
32563 .ecindex IIDsysfil3
32564
32565
32566
32567
32568
32569
32570 . ////////////////////////////////////////////////////////////////////////////
32571 . ////////////////////////////////////////////////////////////////////////////
32572
32573 .chapter "Message processing" "CHAPmsgproc"
32574 .scindex IIDmesproc "message" "general processing"
32575 Exim performs various transformations on the sender and recipient addresses of
32576 all messages that it handles, and also on the messages' header lines. Some of
32577 these are optional and configurable, while others always take place. All of
32578 this processing, except rewriting as a result of routing, and the addition or
32579 removal of header lines while delivering, happens when a message is received,
32580 before it is placed on Exim's queue.
32581
32582 Some of the automatic processing takes place by default only for
32583 &"locally-originated"& messages. This adjective is used to describe messages
32584 that are not received over TCP/IP, but instead are passed to an Exim process on
32585 its standard input. This includes the interactive &"local SMTP"& case that is
32586 set up by the &%-bs%& command line option.
32587
32588 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32589 or ::1) are not considered to be locally-originated. Exim does not treat the
32590 loopback interface specially in any way.
32591
32592 If you want the loopback interface to be treated specially, you must ensure
32593 that there are appropriate entries in your ACLs.
32594
32595
32596
32597
32598 .section "Submission mode for non-local messages" "SECTsubmodnon"
32599 .cindex "message" "submission"
32600 .cindex "submission mode"
32601 Processing that happens automatically for locally-originated messages (unless
32602 &%suppress_local_fixups%& is set) can also be requested for messages that are
32603 received over TCP/IP. The term &"submission mode"& is used to describe this
32604 state. Submission mode is set by the modifier
32605 .code
32606 control = submission
32607 .endd
32608 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32609 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32610 a local submission, and is normally used when the source of the message is
32611 known to be an MUA running on a client host (as opposed to an MTA). For
32612 example, to set submission mode for messages originating on the IPv4 loopback
32613 interface, you could include the following in the MAIL ACL:
32614 .code
32615 warn  hosts = 127.0.0.1
32616       control = submission
32617 .endd
32618 .cindex "&%sender_retain%& submission option"
32619 There are some options that can be used when setting submission mode. A slash
32620 is used to separate options. For example:
32621 .code
32622 control = submission/sender_retain
32623 .endd
32624 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32625 true and &%local_from_check%& false for the current incoming message. The first
32626 of these allows an existing &'Sender:'& header in the message to remain, and
32627 the second suppresses the check to ensure that &'From:'& matches the
32628 authenticated sender. With this setting, Exim still fixes up messages by adding
32629 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32630 attempt to check sender authenticity in header lines.
32631
32632 When &%sender_retain%& is not set, a submission mode setting may specify a
32633 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32634 example:
32635 .code
32636 control = submission/domain=some.domain
32637 .endd
32638 The domain may be empty. How this value is used is described in sections
32639 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32640 that allows you to specify the user's full name for inclusion in a created
32641 &'Sender:'& or &'From:'& header line. For example:
32642 .code
32643 accept authenticated = *
32644        control = submission/domain=wonderland.example/\
32645                             name=${lookup {$authenticated_id} \
32646                                    lsearch {/etc/exim/namelist}}
32647 .endd
32648 Because the name may contain any characters, including slashes, the &%name%&
32649 option must be given last. The remainder of the string is used as the name. For
32650 the example above, if &_/etc/exim/namelist_& contains:
32651 .code
32652 bigegg:  Humpty Dumpty
32653 .endd
32654 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32655 line would be:
32656 .code
32657 Sender: Humpty Dumpty <bigegg@wonderland.example>
32658 .endd
32659 .cindex "return path" "in submission mode"
32660 By default, submission mode forces the return path to the same address as is
32661 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32662 specified, the return path is also left unchanged.
32663
32664 &*Note*&: The changes caused by submission mode take effect after the predata
32665 ACL. This means that any sender checks performed before the fix-ups use the
32666 untrusted sender address specified by the user, not the trusted sender address
32667 specified by submission mode. Although this might be slightly unexpected, it
32668 does mean that you can configure ACL checks to spot that a user is trying to
32669 spoof another's address.
32670
32671 .section "Line endings" "SECTlineendings"
32672 .cindex "line endings"
32673 .cindex "carriage return"
32674 .cindex "linefeed"
32675 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32676 linefeed) is the line ending for messages transmitted over the Internet using
32677 SMTP over TCP/IP. However, within individual operating systems, different
32678 conventions are used. For example, Unix-like systems use just LF, but others
32679 use CRLF or just CR.
32680
32681 Exim was designed for Unix-like systems, and internally, it stores messages
32682 using the system's convention of a single LF as a line terminator. When
32683 receiving a message, all line endings are translated to this standard format.
32684 Originally, it was thought that programs that passed messages directly to an
32685 MTA within an operating system would use that system's convention. Experience
32686 has shown that this is not the case; for example, there are Unix applications
32687 that use CRLF in this circumstance. For this reason, and for compatibility with
32688 other MTAs, the way Exim handles line endings for all messages is now as
32689 follows:
32690
32691 .ilist
32692 LF not preceded by CR is treated as a line ending.
32693 .next
32694 CR is treated as a line ending; if it is immediately followed by LF, the LF
32695 is ignored.
32696 .next
32697 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32698 nor a local message in the state where a line containing only a dot is a
32699 terminator.
32700 .next
32701 If a bare CR is encountered within a header line, an extra space is added after
32702 the line terminator so as not to end the header line. The reasoning behind this
32703 is that bare CRs in header lines are most likely either to be mistakes, or
32704 people trying to play silly games.
32705 .next
32706 If the first header line received in a message ends with CRLF, a subsequent
32707 bare LF in a header line is treated in the same way as a bare CR in a header
32708 line.
32709 .endlist
32710
32711
32712
32713
32714
32715 .section "Unqualified addresses" "SECID218"
32716 .cindex "unqualified addresses"
32717 .cindex "address" "qualification"
32718 By default, Exim expects every envelope address it receives from an external
32719 host to be fully qualified. Unqualified addresses cause negative responses to
32720 SMTP commands. However, because SMTP is used as a means of transporting
32721 messages from MUAs running on personal workstations, there is sometimes a
32722 requirement to accept unqualified addresses from specific hosts or IP networks.
32723
32724 Exim has two options that separately control which hosts may send unqualified
32725 sender or recipient addresses in SMTP commands, namely
32726 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32727 cases, if an unqualified address is accepted, it is qualified by adding the
32728 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32729
32730 .oindex "&%qualify_domain%&"
32731 .oindex "&%qualify_recipient%&"
32732 Unqualified addresses in header lines are automatically qualified for messages
32733 that are locally originated, unless the &%-bnq%& option is given on the command
32734 line. For messages received over SMTP, unqualified addresses in header lines
32735 are qualified only if unqualified addresses are permitted in SMTP commands. In
32736 other words, such qualification is also controlled by
32737 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32738
32739
32740
32741
32742 .section "The UUCP From line" "SECID219"
32743 .cindex "&""From""& line"
32744 .cindex "UUCP" "&""From""& line"
32745 .cindex "sender" "address"
32746 .oindex "&%uucp_from_pattern%&"
32747 .oindex "&%uucp_from_sender%&"
32748 .cindex "envelope sender"
32749 .cindex "Sendmail compatibility" "&""From""& line"
32750 Messages that have come from UUCP (and some other applications) often begin
32751 with a line containing the envelope sender and a timestamp, following the word
32752 &"From"&. Examples of two common formats are:
32753 .code
32754 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32755 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32756 .endd
32757 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32758 Exim recognizes such lines at the start of messages that are submitted to it
32759 via the command line (that is, on the standard input). It does not recognize
32760 such lines in incoming SMTP messages, unless the sending host matches
32761 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32762 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32763 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32764 default value matches the two common cases shown above and puts the address
32765 that follows &"From"& into &$1$&.
32766
32767 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32768 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32769 a trusted user, the message's sender address is constructed by expanding the
32770 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32771 then parsed as an RFC 2822 address. If there is no domain, the local part is
32772 qualified with &%qualify_domain%& unless it is the empty string. However, if
32773 the command line &%-f%& option is used, it overrides the &"From"& line.
32774
32775 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32776 sender address is not changed. This is also the case for incoming SMTP messages
32777 that are permitted to contain &"From"& lines.
32778
32779 Only one &"From"& line is recognized. If there is more than one, the second is
32780 treated as a data line that starts the body of the message, as it is not valid
32781 as a header line. This also happens if a &"From"& line is present in an
32782 incoming SMTP message from a source that is not permitted to send them.
32783
32784
32785
32786 .section "Resent- header lines" "SECID220"
32787 .cindex "&%Resent-%& header lines"
32788 RFC 2822 makes provision for sets of header lines starting with the string
32789 &`Resent-`& to be added to a message when it is resent by the original
32790 recipient to somebody else. These headers are &'Resent-Date:'&,
32791 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32792 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32793
32794 .blockquote
32795 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32796 processing of replies or other such automatic actions on messages.'&
32797 .endblockquote
32798
32799 This leaves things a bit vague as far as other processing actions such as
32800 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32801 follows:
32802
32803 .ilist
32804 A &'Resent-From:'& line that just contains the login id of the submitting user
32805 is automatically rewritten in the same way as &'From:'& (see below).
32806 .next
32807 If there's a rewriting rule for a particular header line, it is also applied to
32808 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32809 &'From:'& also rewrites &'Resent-From:'&.
32810 .next
32811 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32812 also removed.
32813 .next
32814 For a locally-submitted message,
32815 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32816 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32817 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32818 included in log lines in this case.
32819 .next
32820 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32821 &%Resent-%& header lines are present.
32822 .endlist
32823
32824
32825
32826
32827 .section "The Auto-Submitted: header line" "SECID221"
32828 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32829 includes the header line:
32830 .code
32831 Auto-Submitted: auto-replied
32832 .endd
32833
32834 .section "The Bcc: header line" "SECID222"
32835 .cindex "&'Bcc:'& header line"
32836 If Exim is called with the &%-t%& option, to take recipient addresses from a
32837 message's header, it removes any &'Bcc:'& header line that may exist (after
32838 extracting its addresses). If &%-t%& is not present on the command line, any
32839 existing &'Bcc:'& is not removed.
32840
32841
32842 .section "The Date: header line" "SECID223"
32843 .cindex "&'Date:'& header line"
32844 If a locally-generated or submission-mode message has no &'Date:'& header line,
32845 Exim adds one, using the current date and time, unless the
32846 &%suppress_local_fixups%& control has been specified.
32847
32848 .section "The Delivery-date: header line" "SECID224"
32849 .cindex "&'Delivery-date:'& header line"
32850 .oindex "&%delivery_date_remove%&"
32851 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32852 set. Exim can be configured to add them to the final delivery of messages. (See
32853 the generic &%delivery_date_add%& transport option.) They should not be present
32854 in messages in transit. If the &%delivery_date_remove%& configuration option is
32855 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32856 messages.
32857
32858
32859 .section "The Envelope-to: header line" "SECID225"
32860 .cindex "&'Envelope-to:'& header line"
32861 .oindex "&%envelope_to_remove%&"
32862 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32863 Exim can be configured to add them to the final delivery of messages. (See the
32864 generic &%envelope_to_add%& transport option.) They should not be present in
32865 messages in transit. If the &%envelope_to_remove%& configuration option is set
32866 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32867 messages.
32868
32869
32870 .section "The From: header line" "SECTthefrohea"
32871 .cindex "&'From:'& header line"
32872 .cindex "Sendmail compatibility" "&""From""& line"
32873 .cindex "message" "submission"
32874 .cindex "submission mode"
32875 If a submission-mode message does not contain a &'From:'& header line, Exim
32876 adds one if either of the following conditions is true:
32877
32878 .ilist
32879 The envelope sender address is not empty (that is, this is not a bounce
32880 message). The added header line copies the envelope sender address.
32881 .next
32882 .vindex "&$authenticated_id$&"
32883 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32884 .olist
32885 .vindex "&$qualify_domain$&"
32886 If no domain is specified by the submission control, the local part is
32887 &$authenticated_id$& and the domain is &$qualify_domain$&.
32888 .next
32889 If a non-empty domain is specified by the submission control, the local
32890 part is &$authenticated_id$&, and the domain is the specified domain.
32891 .next
32892 If an empty domain is specified by the submission control,
32893 &$authenticated_id$& is assumed to be the complete address.
32894 .endlist
32895 .endlist
32896
32897 A non-empty envelope sender takes precedence.
32898
32899 If a locally-generated incoming message does not contain a &'From:'& header
32900 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32901 containing the sender's address. The calling user's login name and full name
32902 are used to construct the address, as described in section &<<SECTconstr>>&.
32903 They are obtained from the password data by calling &[getpwuid()]& (but see the
32904 &%unknown_login%& configuration option). The address is qualified with
32905 &%qualify_domain%&.
32906
32907 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32908 &'From:'& header line containing just the unqualified login name of the calling
32909 user, this is replaced by an address containing the user's login name and full
32910 name as described in section &<<SECTconstr>>&.
32911
32912
32913 .section "The Message-ID: header line" "SECID226"
32914 .cindex "&'Message-ID:'& header line"
32915 .cindex "message" "submission"
32916 .oindex "&%message_id_header_text%&"
32917 If a locally-generated or submission-mode incoming message does not contain a
32918 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32919 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32920 to the message. If there are any &'Resent-:'& headers in the message, it
32921 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32922 message id, preceded by the letter E to ensure it starts with a letter, and
32923 followed by @ and the primary host name. Additional information can be included
32924 in this header line by setting the &%message_id_header_text%& and/or
32925 &%message_id_header_domain%& options.
32926
32927
32928 .section "The Received: header line" "SECID227"
32929 .cindex "&'Received:'& header line"
32930 A &'Received:'& header line is added at the start of every message. The
32931 contents are defined by the &%received_header_text%& configuration option, and
32932 Exim automatically adds a semicolon and a timestamp to the configured string.
32933
32934 The &'Received:'& header is generated as soon as the message's header lines
32935 have been received. At this stage, the timestamp in the &'Received:'& header
32936 line is the time that the message started to be received. This is the value
32937 that is seen by the DATA ACL and by the &[local_scan()]& function.
32938
32939 Once a message is accepted, the timestamp in the &'Received:'& header line is
32940 changed to the time of acceptance, which is (apart from a small delay while the
32941 -H spool file is written) the earliest time at which delivery could start.
32942
32943
32944 .section "The References: header line" "SECID228"
32945 .cindex "&'References:'& header line"
32946 Messages created by the &(autoreply)& transport include a &'References:'&
32947 header line. This is constructed according to the rules that are described in
32948 section 3.64 of RFC 2822 (which states that replies should contain such a
32949 header line), and section 3.14 of RFC 3834 (which states that automatic
32950 responses are not different in this respect). However, because some mail
32951 processing software does not cope well with very long header lines, no more
32952 than 12 message IDs are copied from the &'References:'& header line in the
32953 incoming message. If there are more than 12, the first one and then the final
32954 11 are copied, before adding the message ID of the incoming message.
32955
32956
32957
32958 .section "The Return-path: header line" "SECID229"
32959 .cindex "&'Return-path:'& header line"
32960 .oindex "&%return_path_remove%&"
32961 &'Return-path:'& header lines are defined as something an MTA may insert when
32962 it does the final delivery of messages. (See the generic &%return_path_add%&
32963 transport option.) Therefore, they should not be present in messages in
32964 transit. If the &%return_path_remove%& configuration option is set (the
32965 default), Exim removes &'Return-path:'& header lines from incoming messages.
32966
32967
32968
32969 .section "The Sender: header line" "SECTthesenhea"
32970 .cindex "&'Sender:'& header line"
32971 .cindex "message" "submission"
32972 For a locally-originated message from an untrusted user, Exim may remove an
32973 existing &'Sender:'& header line, and it may add a new one. You can modify
32974 these actions by setting the &%local_sender_retain%& option true, the
32975 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32976 control setting.
32977
32978 When a local message is received from an untrusted user and
32979 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32980 control has not been set, a check is made to see if the address given in the
32981 &'From:'& header line is the correct (local) sender of the message. The address
32982 that is expected has the login name as the local part and the value of
32983 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32984 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32985 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32986 line is added to the message.
32987
32988 If you set &%local_from_check%& false, this checking does not occur. However,
32989 the removal of an existing &'Sender:'& line still happens, unless you also set
32990 &%local_sender_retain%& to be true. It is not possible to set both of these
32991 options true at the same time.
32992
32993 .cindex "submission mode"
32994 By default, no processing of &'Sender:'& header lines is done for messages
32995 received over TCP/IP or for messages submitted by trusted users. However, when
32996 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32997 not specified on the submission control, the following processing takes place:
32998
32999 .vindex "&$authenticated_id$&"
33000 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33001 authenticated, and &$authenticated_id$& is not empty, a sender address is
33002 created as follows:
33003
33004 .ilist
33005 .vindex "&$qualify_domain$&"
33006 If no domain is specified by the submission control, the local part is
33007 &$authenticated_id$& and the domain is &$qualify_domain$&.
33008 .next
33009 If a non-empty domain is specified by the submission control, the local part
33010 is &$authenticated_id$&, and the domain is the specified domain.
33011 .next
33012 If an empty domain is specified by the submission control,
33013 &$authenticated_id$& is assumed to be the complete address.
33014 .endlist
33015
33016 This address is compared with the address in the &'From:'& header line. If they
33017 are different, a &'Sender:'& header line containing the created address is
33018 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33019 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33020
33021 .cindex "return path" "created from &'Sender:'&"
33022 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33023 the message (the envelope sender address) is changed to be the same address,
33024 except in the case of submission mode when &%sender_retain%& is specified.
33025
33026
33027
33028 .section "Adding and removing header lines in routers and transports" &&&
33029          "SECTheadersaddrem"
33030 .cindex "header lines" "adding; in router or transport"
33031 .cindex "header lines" "removing; in router or transport"
33032 When a message is delivered, the addition and removal of header lines can be
33033 specified in a system filter, or on any of the routers and transports that
33034 process the message. Section &<<SECTaddremheasys>>& contains details about
33035 modifying headers in a system filter. Header lines can also be added in an ACL
33036 as a message is received (see section &<<SECTaddheadacl>>&).
33037
33038 In contrast to what happens in a system filter, header modifications that are
33039 specified on routers and transports apply only to the particular recipient
33040 addresses that are being processed by those routers and transports. These
33041 changes do not actually take place until a copy of the message is being
33042 transported. Therefore, they do not affect the basic set of header lines, and
33043 they do not affect the values of the variables that refer to header lines.
33044
33045 &*Note*&: In particular, this means that any expansions in the configuration of
33046 the transport cannot refer to the modified header lines, because such
33047 expansions all occur before the message is actually transported.
33048
33049 For both routers and transports, the argument of a &%headers_add%&
33050 option must be in the form of one or more RFC 2822 header lines, separated by
33051 newlines (coded as &"\n"&). For example:
33052 .code
33053 headers_add = X-added-header: added by $primary_hostname\n\
33054               X-added-second: another added header line
33055 .endd
33056 Exim does not check the syntax of these added header lines.
33057
33058 Multiple &%headers_add%& options for a single router or transport can be
33059 specified; the values will append to a single list of header lines.
33060 Each header-line is separately expanded.
33061
33062 The argument of a &%headers_remove%& option must consist of a colon-separated
33063 list of header names. This is confusing, because header names themselves are
33064 often terminated by colons. In this case, the colons are the list separators,
33065 not part of the names. For example:
33066 .code
33067 headers_remove = return-receipt-to:acknowledge-to
33068 .endd
33069
33070 Multiple &%headers_remove%& options for a single router or transport can be
33071 specified; the arguments will append to a single header-names list.
33072 Each item is separately expanded.
33073 Note that colons in complex expansions which are used to
33074 form all or part of a &%headers_remove%& list
33075 will act as list separators.
33076
33077 When &%headers_add%& or &%headers_remove%& is specified on a router,
33078 items are expanded at routing time,
33079 and then associated with all addresses that are
33080 accepted by that router, and also with any new addresses that it generates. If
33081 an address passes through several routers as a result of aliasing or
33082 forwarding, the changes are cumulative.
33083
33084 .oindex "&%unseen%&"
33085 However, this does not apply to multiple routers that result from the use of
33086 the &%unseen%& option. Any header modifications that were specified by the
33087 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33088
33089 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33090 settings cannot be delivered together in a batch, so a transport is always
33091 dealing with a set of addresses that have the same header-processing
33092 requirements.
33093
33094 The transport starts by writing the original set of header lines that arrived
33095 with the message, possibly modified by the system filter. As it writes out
33096 these lines, it consults the list of header names that were attached to the
33097 recipient address(es) by &%headers_remove%& options in routers, and it also
33098 consults the transport's own &%headers_remove%& option. Header lines whose
33099 names are on either of these lists are not written out. If there are multiple
33100 instances of any listed header, they are all skipped.
33101
33102 After the remaining original header lines have been written, new header
33103 lines that were specified by routers' &%headers_add%& options are written, in
33104 the order in which they were attached to the address. These are followed by any
33105 header lines specified by the transport's &%headers_add%& option.
33106
33107 This way of handling header line modifications in routers and transports has
33108 the following consequences:
33109
33110 .ilist
33111 The original set of header lines, possibly modified by the system filter,
33112 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33113 to it, at all times.
33114 .next
33115 Header lines that are added by a router's
33116 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33117 expansion syntax in subsequent routers or the transport.
33118 .next
33119 Conversely, header lines that are specified for removal by &%headers_remove%&
33120 in a router remain visible to subsequent routers and the transport.
33121 .next
33122 Headers added to an address by &%headers_add%& in a router cannot be removed by
33123 a later router or by a transport.
33124 .next
33125 An added header can refer to the contents of an original header that is to be
33126 removed, even it has the same name as the added header. For example:
33127 .code
33128 headers_remove = subject
33129 headers_add = Subject: new subject (was: $h_subject:)
33130 .endd
33131 .endlist
33132
33133 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33134 for a &(redirect)& router that has the &%one_time%& option set.
33135
33136
33137
33138
33139
33140 .section "Constructed addresses" "SECTconstr"
33141 .cindex "address" "constructed"
33142 .cindex "constructed address"
33143 When Exim constructs a sender address for a locally-generated message, it uses
33144 the form
33145 .display
33146 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33147 .endd
33148 For example:
33149 .code
33150 Zaphod Beeblebrox <zaphod@end.univ.example>
33151 .endd
33152 The user name is obtained from the &%-F%& command line option if set, or
33153 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33154 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33155 ampersand character, this is replaced by the login name with the first letter
33156 upper cased, as is conventional in a number of operating systems. See the
33157 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33158 The &%unknown_username%& option can be used to specify user names in cases when
33159 there is no password file entry.
33160
33161 .cindex "RFC 2047"
33162 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33163 parts of it if necessary. In addition, if it contains any non-printing
33164 characters, it is encoded as described in RFC 2047, which defines a way of
33165 including non-ASCII characters in header lines. The value of the
33166 &%headers_charset%& option specifies the name of the encoding that is used (the
33167 characters are assumed to be in this encoding). The setting of
33168 &%print_topbitchars%& controls whether characters with the top bit set (that
33169 is, with codes greater than 127) count as printing characters or not.
33170
33171
33172
33173 .section "Case of local parts" "SECID230"
33174 .cindex "case of local parts"
33175 .cindex "local part" "case of"
33176 RFC 2822 states that the case of letters in the local parts of addresses cannot
33177 be assumed to be non-significant. Exim preserves the case of local parts of
33178 addresses, but by default it uses a lower-cased form when it is routing,
33179 because on most Unix systems, usernames are in lower case and case-insensitive
33180 routing is required. However, any particular router can be made to use the
33181 original case for local parts by setting the &%caseful_local_part%& generic
33182 router option.
33183
33184 .cindex "mixed-case login names"
33185 If you must have mixed-case user names on your system, the best way to proceed,
33186 assuming you want case-independent handling of incoming email, is to set up
33187 your first router to convert incoming local parts in your domains to the
33188 correct case by means of a file lookup. For example:
33189 .code
33190 correct_case:
33191   driver = redirect
33192   domains = +local_domains
33193   data = ${lookup{$local_part}cdb\
33194               {/etc/usercased.cdb}{$value}fail}\
33195               @$domain
33196 .endd
33197 For this router, the local part is forced to lower case by the default action
33198 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33199 up a new local part in the correct case. If you then set &%caseful_local_part%&
33200 on any subsequent routers which process your domains, they will operate on
33201 local parts with the correct case in a case-sensitive manner.
33202
33203
33204
33205 .section "Dots in local parts" "SECID231"
33206 .cindex "dot" "in local part"
33207 .cindex "local part" "dots in"
33208 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33209 part may not begin or end with a dot, nor have two consecutive dots in the
33210 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33211 empty components for compatibility.
33212
33213
33214
33215 .section "Rewriting addresses" "SECID232"
33216 .cindex "rewriting" "addresses"
33217 Rewriting of sender and recipient addresses, and addresses in headers, can
33218 happen automatically, or as the result of configuration options, as described
33219 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33220 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33221
33222 Automatic rewriting includes qualification, as mentioned above. The other case
33223 in which it can happen is when an incomplete non-local domain is given. The
33224 routing process may cause this to be expanded into the full domain name. For
33225 example, a header such as
33226 .code
33227 To: hare@teaparty
33228 .endd
33229 might get rewritten as
33230 .code
33231 To: hare@teaparty.wonderland.fict.example
33232 .endd
33233 Rewriting as a result of routing is the one kind of message processing that
33234 does not happen at input time, as it cannot be done until the address has
33235 been routed.
33236
33237 Strictly, one should not do &'any'& deliveries of a message until all its
33238 addresses have been routed, in case any of the headers get changed as a
33239 result of routing. However, doing this in practice would hold up many
33240 deliveries for unreasonable amounts of time, just because one address could not
33241 immediately be routed. Exim therefore does not delay other deliveries when
33242 routing of one or more addresses is deferred.
33243 .ecindex IIDmesproc
33244
33245
33246
33247 . ////////////////////////////////////////////////////////////////////////////
33248 . ////////////////////////////////////////////////////////////////////////////
33249
33250 .chapter "SMTP processing" "CHAPSMTP"
33251 .scindex IIDsmtpproc1 "SMTP" "processing details"
33252 .scindex IIDsmtpproc2 "LMTP" "processing details"
33253 Exim supports a number of different ways of using the SMTP protocol, and its
33254 LMTP variant, which is an interactive protocol for transferring messages into a
33255 closed mail store application. This chapter contains details of how SMTP is
33256 processed. For incoming mail, the following are available:
33257
33258 .ilist
33259 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33260 .next
33261 SMTP over the standard input and output (the &%-bs%& option);
33262 .next
33263 Batched SMTP on the standard input (the &%-bS%& option).
33264 .endlist
33265
33266 For mail delivery, the following are available:
33267
33268 .ilist
33269 SMTP over TCP/IP (the &(smtp)& transport);
33270 .next
33271 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33272 &"lmtp"&);
33273 .next
33274 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33275 transport);
33276 .next
33277 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33278 the &%use_bsmtp%& option set).
33279 .endlist
33280
33281 &'Batched SMTP'& is the name for a process in which batches of messages are
33282 stored in or read from files (or pipes), in a format in which SMTP commands are
33283 used to contain the envelope information.
33284
33285
33286
33287 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33288 .cindex "SMTP" "outgoing over TCP/IP"
33289 .cindex "outgoing SMTP over TCP/IP"
33290 .cindex "LMTP" "over TCP/IP"
33291 .cindex "outgoing LMTP over TCP/IP"
33292 .cindex "EHLO"
33293 .cindex "HELO"
33294 .cindex "SIZE option on MAIL command"
33295 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33296 The &%protocol%& option selects which protocol is to be used, but the actual
33297 processing is the same in both cases.
33298
33299 If, in response to its EHLO command, Exim is told that the SIZE
33300 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33301 command. The value of <&'n'&> is the message size plus the value of the
33302 &%size_addition%& option (default 1024) to allow for additions to the message
33303 such as per-transport header lines, or changes made in a
33304 .cindex "transport" "filter"
33305 .cindex "filter" "transport filter"
33306 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33307 suppressed.
33308
33309 If the remote server advertises support for PIPELINING, Exim uses the
33310 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33311 required for the transaction.
33312
33313 If the remote server advertises support for the STARTTLS command, and Exim
33314 was built to support TLS encryption, it tries to start a TLS session unless the
33315 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33316 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33317 is called for verification.
33318
33319 If the remote server advertises support for the AUTH command, Exim scans
33320 the authenticators configuration for any suitable client settings, as described
33321 in chapter &<<CHAPSMTPAUTH>>&.
33322
33323 .cindex "carriage return"
33324 .cindex "linefeed"
33325 Responses from the remote host are supposed to be terminated by CR followed by
33326 LF. However, there are known to be hosts that do not send CR characters, so in
33327 order to be able to interwork with such hosts, Exim treats LF on its own as a
33328 line terminator.
33329
33330 If a message contains a number of different addresses, all those with the same
33331 characteristics (for example, the same envelope sender) that resolve to the
33332 same set of hosts, in the same order, are sent in a single SMTP transaction,
33333 even if they are for different domains, unless there are more than the setting
33334 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33335 they are split into groups containing no more than &%max_rcpt%&s addresses
33336 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33337 in parallel sessions. The order of hosts with identical MX values is not
33338 significant when checking whether addresses can be batched in this way.
33339
33340 When the &(smtp)& transport suffers a temporary failure that is not
33341 message-related, Exim updates its transport-specific database, which contains
33342 records indexed by host name that remember which messages are waiting for each
33343 particular host. It also updates the retry database with new retry times.
33344
33345 .cindex "hints database" "retry keys"
33346 Exim's retry hints are based on host name plus IP address, so if one address of
33347 a multi-homed host is broken, it will soon be skipped most of the time.
33348 See the next section for more detail about error handling.
33349
33350 .cindex "SMTP" "passed connection"
33351 .cindex "SMTP" "batching over TCP/IP"
33352 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33353 looks in the hints database for the transport to see if there are any queued
33354 messages waiting for the host to which it is connected. If it finds one, it
33355 creates a new Exim process using the &%-MC%& option (which can only be used by
33356 a process running as root or the Exim user) and passes the TCP/IP socket to it
33357 so that it can deliver another message using the same socket. The new process
33358 does only those deliveries that are routed to the connected host, and may in
33359 turn pass the socket on to a third process, and so on.
33360
33361 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33362 limit the number of messages sent down a single TCP/IP connection.
33363
33364 .cindex "asterisk" "after IP address"
33365 The second and subsequent messages delivered down an existing connection are
33366 identified in the main log by the addition of an asterisk after the closing
33367 square bracket of the IP address.
33368
33369
33370
33371
33372 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33373 .cindex "error" "in outgoing SMTP"
33374 .cindex "SMTP" "errors in outgoing"
33375 .cindex "host" "error"
33376 Three different kinds of error are recognized for outgoing SMTP: host errors,
33377 message errors, and recipient errors.
33378
33379 .vlist
33380 .vitem "&*Host errors*&"
33381 A host error is not associated with a particular message or with a
33382 particular recipient of a message. The host errors are:
33383
33384 .ilist
33385 Connection refused or timed out,
33386 .next
33387 Any error response code on connection,
33388 .next
33389 Any error response code to EHLO or HELO,
33390 .next
33391 Loss of connection at any time, except after &"."&,
33392 .next
33393 I/O errors at any time,
33394 .next
33395 Timeouts during the session, other than in response to MAIL, RCPT or
33396 the &"."& at the end of the data.
33397 .endlist ilist
33398
33399 For a host error, a permanent error response on connection, or in response to
33400 EHLO, causes all addresses routed to the host to be failed. Any other host
33401 error causes all addresses to be deferred, and retry data to be created for the
33402 host. It is not tried again, for any message, until its retry time arrives. If
33403 the current set of addresses are not all delivered in this run (to some
33404 alternative host), the message is added to the list of those waiting for this
33405 host, so if it is still undelivered when a subsequent successful delivery is
33406 made to the host, it will be sent down the same SMTP connection.
33407
33408 .vitem "&*Message errors*&"
33409 .cindex "message" "error"
33410 A message error is associated with a particular message when sent to a
33411 particular host, but not with a particular recipient of the message. The
33412 message errors are:
33413
33414 .ilist
33415 Any error response code to MAIL, DATA, or the &"."& that terminates
33416 the data,
33417 .next
33418 Timeout after MAIL,
33419 .next
33420 Timeout or loss of connection after the &"."& that terminates the data. A
33421 timeout after the DATA command itself is treated as a host error, as is loss of
33422 connection at any other time.
33423 .endlist ilist
33424
33425 For a message error, a permanent error response (5&'xx'&) causes all addresses
33426 to be failed, and a delivery error report to be returned to the sender. A
33427 temporary error response (4&'xx'&), or one of the timeouts, causes all
33428 addresses to be deferred. Retry data is not created for the host, but instead,
33429 a retry record for the combination of host plus message id is created. The
33430 message is not added to the list of those waiting for this host. This ensures
33431 that the failing message will not be sent to this host again until the retry
33432 time arrives. However, other messages that are routed to the host are not
33433 affected, so if it is some property of the message that is causing the error,
33434 it will not stop the delivery of other mail.
33435
33436 If the remote host specified support for the SIZE parameter in its response
33437 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33438 over-large message will cause a message error because the error arrives as a
33439 response to MAIL.
33440
33441 .vitem "&*Recipient errors*&"
33442 .cindex "recipient" "error"
33443 A recipient error is associated with a particular recipient of a message. The
33444 recipient errors are:
33445
33446 .ilist
33447 Any error response to RCPT,
33448 .next
33449 Timeout after RCPT.
33450 .endlist
33451
33452 For a recipient error, a permanent error response (5&'xx'&) causes the
33453 recipient address to be failed, and a bounce message to be returned to the
33454 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33455 address to be deferred, and routing retry data to be created for it. This is
33456 used to delay processing of the address in subsequent queue runs, until its
33457 routing retry time arrives. This applies to all messages, but because it
33458 operates only in queue runs, one attempt will be made to deliver a new message
33459 to the failing address before the delay starts to operate. This ensures that,
33460 if the failure is really related to the message rather than the recipient
33461 (&"message too big for this recipient"& is a possible example), other messages
33462 have a chance of getting delivered. If a delivery to the address does succeed,
33463 the retry information gets cleared, so all stuck messages get tried again, and
33464 the retry clock is reset.
33465
33466 The message is not added to the list of those waiting for this host. Use of the
33467 host for other messages is unaffected, and except in the case of a timeout,
33468 other recipients are processed independently, and may be successfully delivered
33469 in the current SMTP session. After a timeout it is of course impossible to
33470 proceed with the session, so all addresses get deferred. However, those other
33471 than the one that failed do not suffer any subsequent retry delays. Therefore,
33472 if one recipient is causing trouble, the others have a chance of getting
33473 through when a subsequent delivery attempt occurs before the failing
33474 recipient's retry time.
33475 .endlist
33476
33477 In all cases, if there are other hosts (or IP addresses) available for the
33478 current set of addresses (for example, from multiple MX records), they are
33479 tried in this run for any undelivered addresses, subject of course to their
33480 own retry data. In other words, recipient error retry data does not take effect
33481 until the next delivery attempt.
33482
33483 Some hosts have been observed to give temporary error responses to every
33484 MAIL command at certain times (&"insufficient space"& has been seen). It
33485 would be nice if such circumstances could be recognized, and defer data for the
33486 host itself created, but this is not possible within the current Exim design.
33487 What actually happens is that retry data for every (host, message) combination
33488 is created.
33489
33490 The reason that timeouts after MAIL and RCPT are treated specially is that
33491 these can sometimes arise as a result of the remote host's verification
33492 procedures. Exim makes this assumption, and treats them as if a temporary error
33493 response had been received. A timeout after &"."& is treated specially because
33494 it is known that some broken implementations fail to recognize the end of the
33495 message if the last character of the last line is a binary zero. Thus, it is
33496 helpful to treat this case as a message error.
33497
33498 Timeouts at other times are treated as host errors, assuming a problem with the
33499 host, or the connection to it. If a timeout after MAIL, RCPT,
33500 or &"."& is really a connection problem, the assumption is that at the next try
33501 the timeout is likely to occur at some other point in the dialogue, causing it
33502 then to be treated as a host error.
33503
33504 There is experimental evidence that some MTAs drop the connection after the
33505 terminating &"."& if they do not like the contents of the message for some
33506 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33507 should be given. That is why Exim treats this case as a message rather than a
33508 host error, in order not to delay other messages to the same host.
33509
33510
33511
33512
33513 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33514 .cindex "SMTP" "incoming over TCP/IP"
33515 .cindex "incoming SMTP over TCP/IP"
33516 .cindex "inetd"
33517 .cindex "daemon"
33518 Incoming SMTP messages can be accepted in one of two ways: by running a
33519 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33520 &_/etc/inetd.conf_& should be like this:
33521 .code
33522 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33523 .endd
33524 Exim distinguishes between this case and the case of a locally running user
33525 agent using the &%-bs%& option by checking whether or not the standard input is
33526 a socket. When it is, either the port must be privileged (less than 1024), or
33527 the caller must be root or the Exim user. If any other user passes a socket
33528 with an unprivileged port number, Exim prints a message on the standard error
33529 stream and exits with an error code.
33530
33531 By default, Exim does not make a log entry when a remote host connects or
33532 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33533 unexpected. It can be made to write such log entries by setting the
33534 &%smtp_connection%& log selector.
33535
33536 .cindex "carriage return"
33537 .cindex "linefeed"
33538 Commands from the remote host are supposed to be terminated by CR followed by
33539 LF. However, there are known to be hosts that do not send CR characters. In
33540 order to be able to interwork with such hosts, Exim treats LF on its own as a
33541 line terminator.
33542 Furthermore, because common code is used for receiving messages from all
33543 sources, a CR on its own is also interpreted as a line terminator. However, the
33544 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33545
33546 .cindex "EHLO" "invalid data"
33547 .cindex "HELO" "invalid data"
33548 One area that sometimes gives rise to problems concerns the EHLO or
33549 HELO commands. Some clients send syntactically invalid versions of these
33550 commands, which Exim rejects by default. (This is nothing to do with verifying
33551 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33552 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33553 match the broken hosts that send invalid commands.
33554
33555 .cindex "SIZE option on MAIL command"
33556 .cindex "MAIL" "SIZE option"
33557 The amount of disk space available is checked whenever SIZE is received on
33558 a MAIL command, independently of whether &%message_size_limit%& or
33559 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33560 false. A temporary error is given if there is not enough space. If
33561 &%check_spool_space%& is set, the check is for that amount of space plus the
33562 value given with SIZE, that is, it checks that the addition of the incoming
33563 message will not reduce the space below the threshold.
33564
33565 When a message is successfully received, Exim includes the local message id in
33566 its response to the final &"."& that terminates the data. If the remote host
33567 logs this text it can help with tracing what has happened to a message.
33568
33569 The Exim daemon can limit the number of simultaneous incoming connections it is
33570 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33571 number of simultaneous incoming connections from a single remote host (see the
33572 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33573 rejected using the SMTP temporary error code 421.
33574
33575 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33576 subprocess has finished, as this can get lost at busy times. Instead, it looks
33577 for completed subprocesses every time it wakes up. Provided there are other
33578 things happening (new incoming calls, starts of queue runs), completed
33579 processes will be noticed and tidied away. On very quiet systems you may
33580 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33581 it will be noticed when the daemon next wakes up.
33582
33583 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33584 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33585 high system load &-- for details see the &%smtp_accept_reserve%&,
33586 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33587 applies in both the daemon and &'inetd'& cases.
33588
33589 Exim normally starts a delivery process for each message received, though this
33590 can be varied by means of the &%-odq%& command line option and the
33591 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33592 number of simultaneously running delivery processes started in this way from
33593 SMTP input can be limited by the &%smtp_accept_queue%& and
33594 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33595 subsequently received messages are just put on the input queue without starting
33596 a delivery process.
33597
33598 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33599 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33600 started up from the &'inetd'& daemon, because in that case each connection is
33601 handled by an entirely independent Exim process. Control by load average is,
33602 however, available with &'inetd'&.
33603
33604 Exim can be configured to verify addresses in incoming SMTP commands as they
33605 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33606 to rewrite addresses at this time &-- before any syntax checking is done. See
33607 section &<<SECTrewriteS>>&.
33608
33609 Exim can also be configured to limit the rate at which a client host submits
33610 MAIL and RCPT commands in a single SMTP session. See the
33611 &%smtp_ratelimit_hosts%& option.
33612
33613
33614
33615 .section "Unrecognized SMTP commands" "SECID234"
33616 .cindex "SMTP" "unrecognized commands"
33617 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33618 commands during a single SMTP connection, it drops the connection after sending
33619 the error response to the last command. The default value for
33620 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33621 abuse that subvert web servers into making connections to SMTP ports; in these
33622 circumstances, a number of non-SMTP lines are sent first.
33623
33624
33625 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33626 .cindex "SMTP" "syntax errors"
33627 .cindex "SMTP" "protocol errors"
33628 A syntax error is detected if an SMTP command is recognized, but there is
33629 something syntactically wrong with its data, for example, a malformed email
33630 address in a RCPT command. Protocol errors include invalid command
33631 sequencing such as RCPT before MAIL. If Exim receives more than
33632 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33633 drops the connection after sending the error response to the last command. The
33634 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33635 broken clients that loop sending bad commands (yes, it has been seen).
33636
33637
33638
33639 .section "Use of non-mail SMTP commands" "SECID236"
33640 .cindex "SMTP" "non-mail commands"
33641 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33642 DATA. Exim counts such commands, and drops the connection if there are too
33643 many of them in a single SMTP session. This action catches some
33644 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33645 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33646 defines what &"too many"& means. Its default value is 10.
33647
33648 When a new message is expected, one occurrence of RSET is not counted. This
33649 allows a client to send one RSET between messages (this is not necessary,
33650 but some clients do it). Exim also allows one uncounted occurrence of HELO
33651 or EHLO, and one occurrence of STARTTLS between messages. After
33652 starting up a TLS session, another EHLO is expected, and so it too is not
33653 counted.
33654
33655 The first occurrence of AUTH in a connection, or immediately following
33656 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33657 RCPT, DATA, and QUIT are counted.
33658
33659 You can control which hosts are subject to the limit set by
33660 &%smtp_accept_max_nonmail%& by setting
33661 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33662 the limit apply to all hosts. This option means that you can exclude any
33663 specific badly-behaved hosts that you have to live with.
33664
33665
33666
33667
33668 .section "The VRFY and EXPN commands" "SECID237"
33669 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33670 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33671 appropriate) in order to decide whether the command should be accepted or not.
33672 If no ACL is defined, the command is rejected.
33673
33674 .cindex "VRFY" "processing"
33675 When VRFY is accepted, it runs exactly the same code as when Exim is
33676 called with the &%-bv%& option.
33677
33678 .cindex "EXPN" "processing"
33679 When EXPN is accepted, a single-level expansion of the address is done.
33680 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33681 than a verification (the &%-bv%& option). If an unqualified local part is given
33682 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33683 of VRFY and EXPN commands are logged on the main and reject logs, and
33684 VRFY verification failures are logged on the main log for consistency with
33685 RCPT failures.
33686
33687
33688
33689 .section "The ETRN command" "SECTETRN"
33690 .cindex "ETRN" "processing"
33691 RFC 1985 describes an SMTP command called ETRN that is designed to
33692 overcome the security problems of the TURN command (which has fallen into
33693 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33694 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33695 should be accepted or not. If no ACL is defined, the command is rejected.
33696
33697 The ETRN command is concerned with &"releasing"& messages that are awaiting
33698 delivery to certain hosts. As Exim does not organize its message queue by host,
33699 the only form of ETRN that is supported by default is the one where the
33700 text starts with the &"#"& prefix, in which case the remainder of the text is
33701 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33702 the &%-R%& option to happen, with the remainder of the ETRN text as its
33703 argument. For example,
33704 .code
33705 ETRN #brigadoon
33706 .endd
33707 runs the command
33708 .code
33709 exim -R brigadoon
33710 .endd
33711 which causes a delivery attempt on all messages with undelivered addresses
33712 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33713 default), Exim prevents the simultaneous execution of more than one queue run
33714 for the same argument string as a result of an ETRN command. This stops
33715 a misbehaving client from starting more than one queue runner at once.
33716
33717 .cindex "hints database" "ETRN serialization"
33718 Exim implements the serialization by means of a hints database in which a
33719 record is written whenever a process is started by ETRN, and deleted when
33720 the process completes. However, Exim does not keep the SMTP session waiting for
33721 the ETRN process to complete. Once ETRN is accepted, the client is sent
33722 a &"success"& return code. Obviously there is scope for hints records to get
33723 left lying around if there is a system or program crash. To guard against this,
33724 Exim ignores any records that are more than six hours old.
33725
33726 .oindex "&%smtp_etrn_command%&"
33727 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33728 used. This specifies a command that is run whenever ETRN is received,
33729 whatever the form of its argument. For
33730 example:
33731 .code
33732 smtp_etrn_command = /etc/etrn_command $domain \
33733                     $sender_host_address
33734 .endd
33735 .vindex "&$domain$&"
33736 The string is split up into arguments which are independently expanded. The
33737 expansion variable &$domain$& is set to the argument of the ETRN command,
33738 and no syntax checking is done on the contents of this argument. Exim does not
33739 wait for the command to complete, so its status code is not checked. Exim runs
33740 under its own uid and gid when receiving incoming SMTP, so it is not possible
33741 for it to change them before running the command.
33742
33743
33744
33745 .section "Incoming local SMTP" "SECID238"
33746 .cindex "SMTP" "local incoming"
33747 Some user agents use SMTP to pass messages to their local MTA using the
33748 standard input and output, as opposed to passing the envelope on the command
33749 line and writing the message to the standard input. This is supported by the
33750 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33751 messages over TCP/IP (including the use of ACLs), except that the envelope
33752 sender given in a MAIL command is ignored unless the caller is trusted. In
33753 an ACL you can detect this form of SMTP input by testing for an empty host
33754 identification. It is common to have this as the first line in the ACL that
33755 runs for RCPT commands:
33756 .code
33757 accept hosts = :
33758 .endd
33759 This accepts SMTP messages from local processes without doing any other tests.
33760
33761
33762
33763 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33764 .cindex "SMTP" "batched outgoing"
33765 .cindex "batched SMTP output"
33766 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33767 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33768 be output in BSMTP format. No SMTP responses are possible for this form of
33769 delivery. All it is doing is using SMTP commands as a way of transmitting the
33770 envelope along with the message.
33771
33772 The message is written to the file or pipe preceded by the SMTP commands
33773 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33774 the message that start with a dot have an extra dot added. The SMTP command
33775 HELO is not normally used. If it is required, the &%message_prefix%& option
33776 can be used to specify it.
33777
33778 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33779 one recipient address at a time by default. However, you can arrange for them
33780 to handle several addresses at once by setting the &%batch_max%& option. When
33781 this is done for BSMTP, messages may contain multiple RCPT commands. See
33782 chapter &<<CHAPbatching>>& for more details.
33783
33784 .vindex "&$host$&"
33785 When one or more addresses are routed to a BSMTP transport by a router that
33786 sets up a host list, the name of the first host on the list is available to the
33787 transport in the variable &$host$&. Here is an example of such a transport and
33788 router:
33789 .code
33790 begin routers
33791 route_append:
33792   driver = manualroute
33793   transport = smtp_appendfile
33794   route_list = domain.example  batch.host.example
33795
33796 begin transports
33797 smtp_appendfile:
33798   driver = appendfile
33799   directory = /var/bsmtp/$host
33800   batch_max = 1000
33801   use_bsmtp
33802   user = exim
33803 .endd
33804 This causes messages addressed to &'domain.example'& to be written in BSMTP
33805 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33806 message (unless there are more than 1000 recipients).
33807
33808
33809
33810 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33811 .cindex "SMTP" "batched incoming"
33812 .cindex "batched SMTP input"
33813 The &%-bS%& command line option causes Exim to accept one or more messages by
33814 reading SMTP on the standard input, but to generate no responses. If the caller
33815 is trusted, the senders in the MAIL commands are believed; otherwise the
33816 sender is always the caller of Exim. Unqualified senders and receivers are not
33817 rejected (there seems little point) but instead just get qualified. HELO
33818 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33819 as NOOP; QUIT quits.
33820
33821 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33822 ACL is run in the same way as for non-SMTP local input.
33823
33824 If an error is detected while reading a message, including a missing &"."& at
33825 the end, Exim gives up immediately. It writes details of the error to the
33826 standard output in a stylized way that the calling program should be able to
33827 make some use of automatically, for example:
33828 .code
33829 554 Unexpected end of file
33830 Transaction started in line 10
33831 Error detected in line 14
33832 .endd
33833 It writes a more verbose version, for human consumption, to the standard error
33834 file, for example:
33835 .code
33836 An error was detected while processing a file of BSMTP input.
33837 The error message was:
33838
33839 501 '>' missing at end of address
33840
33841 The SMTP transaction started in line 10.
33842 The error was detected in line 12.
33843 The SMTP command at fault was:
33844
33845 rcpt to:<malformed@in.com.plete
33846
33847 1 previous message was successfully processed.
33848 The rest of the batch was abandoned.
33849 .endd
33850 The return code from Exim is zero only if there were no errors. It is 1 if some
33851 messages were accepted before an error was detected, and 2 if no messages were
33852 accepted.
33853 .ecindex IIDsmtpproc1
33854 .ecindex IIDsmtpproc2
33855
33856
33857
33858 . ////////////////////////////////////////////////////////////////////////////
33859 . ////////////////////////////////////////////////////////////////////////////
33860
33861 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33862          "Customizing messages"
33863 When a message fails to be delivered, or remains on the queue for more than a
33864 configured amount of time, Exim sends a message to the original sender, or
33865 to an alternative configured address. The text of these messages is built into
33866 the code of Exim, but it is possible to change it, either by adding a single
33867 string, or by replacing each of the paragraphs by text supplied in a file.
33868
33869 The &'From:'& and &'To:'& header lines are automatically generated; you can
33870 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33871 option. Exim also adds the line
33872 .code
33873 Auto-Submitted: auto-generated
33874 .endd
33875 to all warning and bounce messages,
33876
33877
33878 .section "Customizing bounce messages" "SECID239"
33879 .cindex "customizing" "bounce message"
33880 .cindex "bounce message" "customizing"
33881 If &%bounce_message_text%& is set, its contents are included in the default
33882 message immediately after &"This message was created automatically by mail
33883 delivery software."& The string is not expanded. It is not used if
33884 &%bounce_message_file%& is set.
33885
33886 When &%bounce_message_file%& is set, it must point to a template file for
33887 constructing error messages. The file consists of a series of text items,
33888 separated by lines consisting of exactly four asterisks. If the file cannot be
33889 opened, default text is used and a message is written to the main and panic
33890 logs. If any text item in the file is empty, default text is used for that
33891 item.
33892
33893 .vindex "&$bounce_recipient$&"
33894 .vindex "&$bounce_return_size_limit$&"
33895 Each item of text that is read from the file is expanded, and there are two
33896 expansion variables which can be of use here: &$bounce_recipient$& is set to
33897 the recipient of an error message while it is being created, and
33898 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33899 option, rounded to a whole number.
33900
33901 The items must appear in the file in the following order:
33902
33903 .ilist
33904 The first item is included in the headers, and should include at least a
33905 &'Subject:'& header. Exim does not check the syntax of these headers.
33906 .next
33907 The second item forms the start of the error message. After it, Exim lists the
33908 failing addresses with their error messages.
33909 .next
33910 The third item is used to introduce any text from pipe transports that is to be
33911 returned to the sender. It is omitted if there is no such text.
33912 .next
33913 .new
33914 The fourth, fifth and sixth items will be ignored and may be empty.
33915 The fields exist for back-compatibility
33916 .wen
33917 .endlist
33918
33919 The default state (&%bounce_message_file%& unset) is equivalent to the
33920 following file, in which the sixth item is empty. The &'Subject:'& and some
33921 other lines have been split in order to fit them on the page:
33922 .code
33923 Subject: Mail delivery failed
33924   ${if eq{$sender_address}{$bounce_recipient}
33925   {: returning message to sender}}
33926 ****
33927 This message was created automatically by mail delivery software.
33928
33929 A message ${if eq{$sender_address}{$bounce_recipient}
33930   {that you sent }{sent by
33931
33932 <$sender_address>
33933
33934 }}could not be delivered to all of its recipients.
33935 This is a permanent error. The following address(es) failed:
33936 ****
33937 The following text was generated during the delivery attempt(s):
33938 ****
33939 ------ This is a copy of the message, including all the headers.
33940   ------
33941 ****
33942 ------ The body of the message is $message_size characters long;
33943   only the first
33944 ------ $bounce_return_size_limit or so are included here.
33945 ****
33946 .endd
33947 .section "Customizing warning messages" "SECTcustwarn"
33948 .cindex "customizing" "warning message"
33949 .cindex "warning of delay" "customizing the message"
33950 The option &%warn_message_file%& can be pointed at a template file for use when
33951 warnings about message delays are created. In this case there are only three
33952 text sections:
33953
33954 .ilist
33955 The first item is included in the headers, and should include at least a
33956 &'Subject:'& header. Exim does not check the syntax of these headers.
33957 .next
33958 The second item forms the start of the warning message. After it, Exim lists
33959 the delayed addresses.
33960 .next
33961 The third item then ends the message.
33962 .endlist
33963
33964 The default state is equivalent to the following file, except that some lines
33965 have been split here, in order to fit them on the page:
33966 .code
33967 Subject: Warning: message $message_exim_id delayed
33968   $warn_message_delay
33969 ****
33970 This message was created automatically by mail delivery software.
33971
33972 A message ${if eq{$sender_address}{$warn_message_recipients}
33973 {that you sent }{sent by
33974
33975 <$sender_address>
33976
33977 }}has not been delivered to all of its recipients after
33978 more than $warn_message_delay on the queue on $primary_hostname.
33979
33980 The message identifier is:     $message_exim_id
33981 The subject of the message is: $h_subject
33982 The date of the message is:    $h_date
33983
33984 The following address(es) have not yet been delivered:
33985 ****
33986 No action is required on your part. Delivery attempts will
33987 continue for some time, and this warning may be repeated at
33988 intervals if the message remains undelivered. Eventually the
33989 mail delivery software will give up, and when that happens,
33990 the message will be returned to you.
33991 .endd
33992 .vindex "&$warn_message_delay$&"
33993 .vindex "&$warn_message_recipients$&"
33994 However, in the default state the subject and date lines are omitted if no
33995 appropriate headers exist. During the expansion of this file,
33996 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33997 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33998 of recipients for the warning message. There may be more than one if there are
33999 multiple addresses with different &%errors_to%& settings on the routers that
34000 handled them.
34001
34002
34003
34004
34005 . ////////////////////////////////////////////////////////////////////////////
34006 . ////////////////////////////////////////////////////////////////////////////
34007
34008 .chapter "Some common configuration settings" "CHAPcomconreq"
34009 This chapter discusses some configuration settings that seem to be fairly
34010 common. More examples and discussion can be found in the Exim book.
34011
34012
34013
34014 .section "Sending mail to a smart host" "SECID240"
34015 .cindex "smart host" "example router"
34016 If you want to send all mail for non-local domains to a &"smart host"&, you
34017 should replace the default &(dnslookup)& router with a router which does the
34018 routing explicitly:
34019 .code
34020 send_to_smart_host:
34021   driver = manualroute
34022   route_list = !+local_domains smart.host.name
34023   transport = remote_smtp
34024 .endd
34025 You can use the smart host's IP address instead of the name if you wish.
34026 If you are using Exim only to submit messages to a smart host, and not for
34027 receiving incoming messages, you can arrange for it to do the submission
34028 synchronously by setting the &%mua_wrapper%& option (see chapter
34029 &<<CHAPnonqueueing>>&).
34030
34031
34032
34033
34034 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34035 .cindex "mailing lists"
34036 Exim can be used to run simple mailing lists, but for large and/or complicated
34037 requirements, the use of additional specialized mailing list software such as
34038 Majordomo or Mailman is recommended.
34039
34040 The &(redirect)& router can be used to handle mailing lists where each list
34041 is maintained in a separate file, which can therefore be managed by an
34042 independent manager. The &%domains%& router option can be used to run these
34043 lists in a separate domain from normal mail. For example:
34044 .code
34045 lists:
34046   driver = redirect
34047   domains = lists.example
34048   file = /usr/lists/$local_part
34049   forbid_pipe
34050   forbid_file
34051   errors_to = $local_part-request@lists.example
34052   no_more
34053 .endd
34054 This router is skipped for domains other than &'lists.example'&. For addresses
34055 in that domain, it looks for a file that matches the local part. If there is no
34056 such file, the router declines, but because &%no_more%& is set, no subsequent
34057 routers are tried, and so the whole delivery fails.
34058
34059 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34060 expanded into a file name or a pipe delivery, which is usually inappropriate in
34061 a mailing list.
34062
34063 .oindex "&%errors_to%&"
34064 The &%errors_to%& option specifies that any delivery errors caused by addresses
34065 taken from a mailing list are to be sent to the given address rather than the
34066 original sender of the message. However, before acting on this, Exim verifies
34067 the error address, and ignores it if verification fails.
34068
34069 For example, using the configuration above, mail sent to
34070 &'dicts@lists.example'& is passed on to those addresses contained in
34071 &_/usr/lists/dicts_&, with error reports directed to
34072 &'dicts-request@lists.example'&, provided that this address can be verified.
34073 There could be a file called &_/usr/lists/dicts-request_& containing
34074 the address(es) of this particular list's manager(s), but other approaches,
34075 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34076 or &%local_part_suffix%& options) to handle addresses of the form
34077 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34078
34079
34080
34081 .section "Syntax errors in mailing lists" "SECID241"
34082 .cindex "mailing lists" "syntax errors in"
34083 If an entry in redirection data contains a syntax error, Exim normally defers
34084 delivery of the original address. That means that a syntax error in a mailing
34085 list holds up all deliveries to the list. This may not be appropriate when a
34086 list is being maintained automatically from data supplied by users, and the
34087 addresses are not rigorously checked.
34088
34089 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34090 entries that fail to parse, noting the incident in the log. If in addition
34091 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34092 whenever a broken address is skipped. It is usually appropriate to set
34093 &%syntax_errors_to%& to the same address as &%errors_to%&.
34094
34095
34096
34097 .section "Re-expansion of mailing lists" "SECID242"
34098 .cindex "mailing lists" "re-expansion of"
34099 Exim remembers every individual address to which a message has been delivered,
34100 in order to avoid duplication, but it normally stores only the original
34101 recipient addresses with a message. If all the deliveries to a mailing list
34102 cannot be done at the first attempt, the mailing list is re-expanded when the
34103 delivery is next tried. This means that alterations to the list are taken into
34104 account at each delivery attempt, so addresses that have been added to
34105 the list since the message arrived will therefore receive a copy of the
34106 message, even though it pre-dates their subscription.
34107
34108 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34109 on the &(redirect)& router. If this is done, any addresses generated by the
34110 router that fail to deliver at the first attempt are added to the message as
34111 &"top level"& addresses, and the parent address that generated them is marked
34112 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34113 subsequent delivery attempts. The disadvantage of this is that if any of the
34114 failing addresses are incorrect, correcting them in the file has no effect on
34115 pre-existing messages.
34116
34117 The original top-level address is remembered with each of the generated
34118 addresses, and is output in any log messages. However, any intermediate parent
34119 addresses are not recorded. This makes a difference to the log only if the
34120 &%all_parents%& selector is set, but for mailing lists there is normally only
34121 one level of expansion anyway.
34122
34123
34124
34125 .section "Closed mailing lists" "SECID243"
34126 .cindex "mailing lists" "closed"
34127 The examples so far have assumed open mailing lists, to which anybody may
34128 send mail. It is also possible to set up closed lists, where mail is accepted
34129 from specified senders only. This is done by making use of the generic
34130 &%senders%& option to restrict the router that handles the list.
34131
34132 The following example uses the same file as a list of recipients and as a list
34133 of permitted senders. It requires three routers:
34134 .code
34135 lists_request:
34136   driver = redirect
34137   domains = lists.example
34138   local_part_suffix = -request
34139   file = /usr/lists/$local_part$local_part_suffix
34140   no_more
34141
34142 lists_post:
34143   driver = redirect
34144   domains = lists.example
34145   senders = ${if exists {/usr/lists/$local_part}\
34146              {lsearch;/usr/lists/$local_part}{*}}
34147   file = /usr/lists/$local_part
34148   forbid_pipe
34149   forbid_file
34150   errors_to = $local_part-request@lists.example
34151   no_more
34152
34153 lists_closed:
34154   driver = redirect
34155   domains = lists.example
34156   allow_fail
34157   data = :fail: $local_part@lists.example is a closed mailing list
34158 .endd
34159 All three routers have the same &%domains%& setting, so for any other domains,
34160 they are all skipped. The first router runs only if the local part ends in
34161 &%-request%&. It handles messages to the list manager(s) by means of an open
34162 mailing list.
34163
34164 The second router runs only if the &%senders%& precondition is satisfied. It
34165 checks for the existence of a list that corresponds to the local part, and then
34166 checks that the sender is on the list by means of a linear search. It is
34167 necessary to check for the existence of the file before trying to search it,
34168 because otherwise Exim thinks there is a configuration error. If the file does
34169 not exist, the expansion of &%senders%& is *, which matches all senders. This
34170 means that the router runs, but because there is no list, declines, and
34171 &%no_more%& ensures that no further routers are run. The address fails with an
34172 &"unrouteable address"& error.
34173
34174 The third router runs only if the second router is skipped, which happens when
34175 a mailing list exists, but the sender is not on it. This router forcibly fails
34176 the address, giving a suitable error message.
34177
34178
34179
34180
34181 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34182 .cindex "VERP"
34183 .cindex "Variable Envelope Return Paths"
34184 .cindex "envelope sender"
34185 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34186 are a way of helping mailing list administrators discover which subscription
34187 address is the cause of a particular delivery failure. The idea is to encode
34188 the original recipient address in the outgoing envelope sender address, so that
34189 if the message is forwarded by another host and then subsequently bounces, the
34190 original recipient can be extracted from the recipient address of the bounce.
34191
34192 .oindex &%errors_to%&
34193 .oindex &%return_path%&
34194 Envelope sender addresses can be modified by Exim using two different
34195 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34196 list examples), or the &%return_path%& option on a transport. The second of
34197 these is effective only if the message is successfully delivered to another
34198 host; it is not used for errors detected on the local host (see the description
34199 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34200 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34201 .code
34202 verp_smtp:
34203   driver = smtp
34204   max_rcpt = 1
34205   return_path = \
34206     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34207       {$1-request+$local_part=$domain@your.dom.example}fail}
34208 .endd
34209 This has the effect of rewriting the return path (envelope sender) on outgoing
34210 SMTP messages, if the local part of the original return path ends in
34211 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34212 local part and domain of the recipient into the return path. Suppose, for
34213 example, that a message whose return path has been set to
34214 &'somelist-request@your.dom.example'& is sent to
34215 &'subscriber@other.dom.example'&. In the transport, the return path is
34216 rewritten as
34217 .code
34218 somelist-request+subscriber=other.dom.example@your.dom.example
34219 .endd
34220 .vindex "&$local_part$&"
34221 For this to work, you must tell Exim to send multiple copies of messages that
34222 have more than one recipient, so that each copy has just one recipient. This is
34223 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34224 might be sent to several different recipients in the same domain, in which case
34225 &$local_part$& is not available in the transport, because it is not unique.
34226
34227 Unless your host is doing nothing but mailing list deliveries, you should
34228 probably use a separate transport for the VERP deliveries, so as not to use
34229 extra resources in making one-per-recipient copies for other deliveries. This
34230 can easily be done by expanding the &%transport%& option in the router:
34231 .code
34232 dnslookup:
34233   driver = dnslookup
34234   domains = ! +local_domains
34235   transport = \
34236     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34237       {verp_smtp}{remote_smtp}}
34238   no_more
34239 .endd
34240 If you want to change the return path using &%errors_to%& in a router instead
34241 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34242 routers that handle mailing list addresses. This will ensure that all delivery
34243 errors, including those detected on the local host, are sent to the VERP
34244 address.
34245
34246 On a host that does no local deliveries and has no manual routing, only the
34247 &(dnslookup)& router needs to be changed. A special transport is not needed for
34248 SMTP deliveries. Every mailing list recipient has its own return path value,
34249 and so Exim must hand them to the transport one at a time. Here is an example
34250 of a &(dnslookup)& router that implements VERP:
34251 .code
34252 verp_dnslookup:
34253   driver = dnslookup
34254   domains = ! +local_domains
34255   transport = remote_smtp
34256   errors_to = \
34257     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34258      {$1-request+$local_part=$domain@your.dom.example}fail}
34259   no_more
34260 .endd
34261 Before you start sending out messages with VERPed return paths, you must also
34262 configure Exim to accept the bounce messages that come back to those paths.
34263 Typically this is done by setting a &%local_part_suffix%& option for a
34264 router, and using this to route the messages to wherever you want to handle
34265 them.
34266
34267 The overhead incurred in using VERP depends very much on the size of the
34268 message, the number of recipient addresses that resolve to the same remote
34269 host, and the speed of the connection over which the message is being sent. If
34270 a lot of addresses resolve to the same host and the connection is slow, sending
34271 a separate copy of the message for each address may take substantially longer
34272 than sending a single copy with many recipients (for which VERP cannot be
34273 used).
34274
34275
34276
34277
34278
34279
34280 .section "Virtual domains" "SECTvirtualdomains"
34281 .cindex "virtual domains"
34282 .cindex "domain" "virtual"
34283 The phrase &'virtual domain'& is unfortunately used with two rather different
34284 meanings:
34285
34286 .ilist
34287 A domain for which there are no real mailboxes; all valid local parts are
34288 aliases for other email addresses. Common examples are organizational
34289 top-level domains and &"vanity"& domains.
34290 .next
34291 One of a number of independent domains that are all handled by the same host,
34292 with mailboxes on that host, but where the mailbox owners do not necessarily
34293 have login accounts on that host.
34294 .endlist
34295
34296 The first usage is probably more common, and does seem more &"virtual"& than
34297 the second. This kind of domain can be handled in Exim with a straightforward
34298 aliasing router. One approach is to create a separate alias file for each
34299 virtual domain. Exim can test for the existence of the alias file to determine
34300 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34301 to a router of this form:
34302 .code
34303 virtual:
34304   driver = redirect
34305   domains = dsearch;/etc/mail/virtual
34306   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34307   no_more
34308 .endd
34309 The &%domains%& option specifies that the router is to be skipped, unless there
34310 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34311 domain that is being processed. When the router runs, it looks up the local
34312 part in the file to find a new address (or list of addresses). The &%no_more%&
34313 setting ensures that if the lookup fails (leading to &%data%& being an empty
34314 string), Exim gives up on the address without trying any subsequent routers.
34315
34316 This one router can handle all the virtual domains because the alias file names
34317 follow a fixed pattern. Permissions can be arranged so that appropriate people
34318 can edit the different alias files. A successful aliasing operation results in
34319 a new envelope recipient address, which is then routed from scratch.
34320
34321 The other kind of &"virtual"& domain can also be handled in a straightforward
34322 way. One approach is to create a file for each domain containing a list of
34323 valid local parts, and use it in a router like this:
34324 .code
34325 my_domains:
34326   driver = accept
34327   domains = dsearch;/etc/mail/domains
34328   local_parts = lsearch;/etc/mail/domains/$domain
34329   transport = my_mailboxes
34330 .endd
34331 The address is accepted if there is a file for the domain, and the local part
34332 can be found in the file. The &%domains%& option is used to check for the
34333 file's existence because &%domains%& is tested before the &%local_parts%&
34334 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34335 because that option is tested after &%local_parts%&. The transport is as
34336 follows:
34337 .code
34338 my_mailboxes:
34339   driver = appendfile
34340   file = /var/mail/$domain/$local_part
34341   user = mail
34342 .endd
34343 This uses a directory of mailboxes for each domain. The &%user%& setting is
34344 required, to specify which uid is to be used for writing to the mailboxes.
34345
34346 The configuration shown here is just one example of how you might support this
34347 requirement. There are many other ways this kind of configuration can be set
34348 up, for example, by using a database instead of separate files to hold all the
34349 information about the domains.
34350
34351
34352
34353 .section "Multiple user mailboxes" "SECTmulbox"
34354 .cindex "multiple mailboxes"
34355 .cindex "mailbox" "multiple"
34356 .cindex "local part" "prefix"
34357 .cindex "local part" "suffix"
34358 Heavy email users often want to operate with multiple mailboxes, into which
34359 incoming mail is automatically sorted. A popular way of handling this is to
34360 allow users to use multiple sender addresses, so that replies can easily be
34361 identified. Users are permitted to add prefixes or suffixes to their local
34362 parts for this purpose. The wildcard facility of the generic router options
34363 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34364 example, consider this router:
34365 .code
34366 userforward:
34367   driver = redirect
34368   check_local_user
34369   file = $home/.forward
34370   local_part_suffix = -*
34371   local_part_suffix_optional
34372   allow_filter
34373 .endd
34374 .vindex "&$local_part_suffix$&"
34375 It runs a user's &_.forward_& file for all local parts of the form
34376 &'username-*'&. Within the filter file the user can distinguish different
34377 cases by testing the variable &$local_part_suffix$&. For example:
34378 .code
34379 if $local_part_suffix contains -special then
34380 save /home/$local_part/Mail/special
34381 endif
34382 .endd
34383 If the filter file does not exist, or does not deal with such addresses, they
34384 fall through to subsequent routers, and, assuming no subsequent use of the
34385 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34386 control over which suffixes are valid.
34387
34388 Alternatively, a suffix can be used to trigger the use of a different
34389 &_.forward_& file &-- which is the way a similar facility is implemented in
34390 another MTA:
34391 .code
34392 userforward:
34393   driver = redirect
34394   check_local_user
34395   file = $home/.forward$local_part_suffix
34396   local_part_suffix = -*
34397   local_part_suffix_optional
34398   allow_filter
34399 .endd
34400 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34401 example, &_.forward-special_& is used. Once again, if the appropriate file
34402 does not exist, or does not deal with the address, it is passed on to
34403 subsequent routers, which could, if required, look for an unqualified
34404 &_.forward_& file to use as a default.
34405
34406
34407
34408 .section "Simplified vacation processing" "SECID244"
34409 .cindex "vacation processing"
34410 The traditional way of running the &'vacation'& program is for a user to set up
34411 a pipe command in a &_.forward_& file
34412 (see section &<<SECTspecitredli>>& for syntax details).
34413 This is prone to error by inexperienced users. There are two features of Exim
34414 that can be used to make this process simpler for users:
34415
34416 .ilist
34417 A local part prefix such as &"vacation-"& can be specified on a router which
34418 can cause the message to be delivered directly to the &'vacation'& program, or
34419 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34420 &_.forward_& file are then much simpler. For example:
34421 .code
34422 spqr, vacation-spqr
34423 .endd
34424 .next
34425 The &%require_files%& generic router option can be used to trigger a
34426 vacation delivery by checking for the existence of a certain file in the
34427 user's home directory. The &%unseen%& generic option should also be used, to
34428 ensure that the original delivery also proceeds. In this case, all the user has
34429 to do is to create a file called, say, &_.vacation_&, containing a vacation
34430 message.
34431 .endlist
34432
34433 Another advantage of both these methods is that they both work even when the
34434 use of arbitrary pipes by users is locked out.
34435
34436
34437
34438 .section "Taking copies of mail" "SECID245"
34439 .cindex "message" "copying every"
34440 Some installations have policies that require archive copies of all messages to
34441 be made. A single copy of each message can easily be taken by an appropriate
34442 command in a system filter, which could, for example, use a different file for
34443 each day's messages.
34444
34445 There is also a shadow transport mechanism that can be used to take copies of
34446 messages that are successfully delivered by local transports, one copy per
34447 delivery. This could be used, &'inter alia'&, to implement automatic
34448 notification of delivery by sites that insist on doing such things.
34449
34450
34451
34452 .section "Intermittently connected hosts" "SECID246"
34453 .cindex "intermittently connected hosts"
34454 It has become quite common (because it is cheaper) for hosts to connect to the
34455 Internet periodically rather than remain connected all the time. The normal
34456 arrangement is that mail for such hosts accumulates on a system that is
34457 permanently connected.
34458
34459 Exim was designed for use on permanently connected hosts, and so it is not
34460 particularly well-suited to use in an intermittently connected environment.
34461 Nevertheless there are some features that can be used.
34462
34463
34464 .section "Exim on the upstream server host" "SECID247"
34465 It is tempting to arrange for incoming mail for the intermittently connected
34466 host to remain on Exim's queue until the client connects. However, this
34467 approach does not scale very well. Two different kinds of waiting message are
34468 being mixed up in the same queue &-- those that cannot be delivered because of
34469 some temporary problem, and those that are waiting for their destination host
34470 to connect. This makes it hard to manage the queue, as well as wasting
34471 resources, because each queue runner scans the entire queue.
34472
34473 A better approach is to separate off those messages that are waiting for an
34474 intermittently connected host. This can be done by delivering these messages
34475 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34476 format, from where they are transmitted by other software when their
34477 destination connects. This makes it easy to collect all the mail for one host
34478 in a single directory, and to apply local timeout rules on a per-message basis
34479 if required.
34480
34481 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34482 you are doing this, you should configure Exim with a long retry period for the
34483 intermittent host. For example:
34484 .code
34485 cheshire.wonderland.fict.example    *   F,5d,24h
34486 .endd
34487 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34488 which messages it has queued up for that host. Once the intermittent host comes
34489 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34490 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34491 causes all the queued up messages to be delivered, often down a single SMTP
34492 connection. While the host remains connected, any new messages get delivered
34493 immediately.
34494
34495 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34496 issued with a different IP address each time it connects, Exim's retry
34497 mechanisms on the holding host get confused, because the IP address is normally
34498 used as part of the key string for holding retry information. This can be
34499 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34500 Since this has disadvantages for permanently connected hosts, it is best to
34501 arrange a separate transport for the intermittently connected ones.
34502
34503
34504
34505 .section "Exim on the intermittently connected client host" "SECID248"
34506 The value of &%smtp_accept_queue_per_connection%& should probably be
34507 increased, or even set to zero (that is, disabled) on the intermittently
34508 connected host, so that all incoming messages down a single connection get
34509 delivered immediately.
34510
34511 .cindex "SMTP" "passed connection"
34512 .cindex "SMTP" "multiple deliveries"
34513 .cindex "multiple SMTP deliveries"
34514 Mail waiting to be sent from an intermittently connected host will probably
34515 not have been routed, because without a connection DNS lookups are not
34516 possible. This means that if a normal queue run is done at connection time,
34517 each message is likely to be sent in a separate SMTP session. This can be
34518 avoided by starting the queue run with a command line option beginning with
34519 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34520 first pass, routing is done but no deliveries take place. The second pass is a
34521 normal queue run; since all the messages have been previously routed, those
34522 destined for the same host are likely to get sent as multiple deliveries in a
34523 single SMTP connection.
34524
34525
34526
34527 . ////////////////////////////////////////////////////////////////////////////
34528 . ////////////////////////////////////////////////////////////////////////////
34529
34530 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34531          "Exim as a non-queueing client"
34532 .cindex "client, non-queueing"
34533 .cindex "smart host" "suppressing queueing"
34534 On a personal computer, it is a common requirement for all
34535 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34536 configured to operate that way, for all the popular operating systems.
34537 However, there are some MUAs for Unix-like systems that cannot be so
34538 configured: they submit messages using the command line interface of
34539 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34540 messages this way.
34541
34542 If the personal computer runs continuously, there is no problem, because it can
34543 run a conventional MTA that handles delivery to the smart host, and deal with
34544 any delays via its queueing mechanism. However, if the computer does not run
34545 continuously or runs different operating systems at different times, queueing
34546 email is not desirable.
34547
34548 There is therefore a requirement for something that can provide the
34549 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34550 any queueing or retrying facilities. Furthermore, the delivery to the smart
34551 host should be synchronous, so that if it fails, the sending MUA is immediately
34552 informed. In other words, we want something that extends an MUA that submits
34553 to a local MTA via the command line so that it behaves like one that submits
34554 to a remote smart host using TCP/SMTP.
34555
34556 There are a number of applications (for example, there is one called &'ssmtp'&)
34557 that do this job. However, people have found them to be lacking in various
34558 ways. For instance, you might want to allow aliasing and forwarding to be done
34559 before sending a message to the smart host.
34560
34561 Exim already had the necessary infrastructure for doing this job. Just a few
34562 tweaks were needed to make it behave as required, though it is somewhat of an
34563 overkill to use a fully-featured MTA for this purpose.
34564
34565 .oindex "&%mua_wrapper%&"
34566 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34567 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34568 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34569 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34570 compatible router and transport configuration. Typically there will be just one
34571 router and one transport, sending everything to a smart host.
34572
34573 When run in MUA wrapping mode, the behaviour of Exim changes in the
34574 following ways:
34575
34576 .ilist
34577 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34578 In other words, the only way to submit messages is via the command line.
34579 .next
34580 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34581 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34582 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34583 does not finish until the delivery attempt is complete. If the delivery is
34584 successful, a zero return code is given.
34585 .next
34586 Address redirection is permitted, but the final routing for all addresses must
34587 be to the same remote transport, and to the same list of hosts. Furthermore,
34588 the return address (envelope sender) must be the same for all recipients, as
34589 must any added or deleted header lines. In other words, it must be possible to
34590 deliver the message in a single SMTP transaction, however many recipients there
34591 are.
34592 .next
34593 If these conditions are not met, or if routing any address results in a
34594 failure or defer status, or if Exim is unable to deliver all the recipients
34595 successfully to one of the smart hosts, delivery of the entire message fails.
34596 .next
34597 Because no queueing is allowed, all failures are treated as permanent; there
34598 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34599 smart host. Furthermore, because only a single yes/no response can be given to
34600 the caller, it is not possible to deliver to some recipients and not others. If
34601 there is an error (temporary or permanent) for any recipient, all are failed.
34602 .next
34603 If more than one smart host is listed, Exim will try another host after a
34604 connection failure or a timeout, in the normal way. However, if this kind of
34605 failure happens for all the hosts, the delivery fails.
34606 .next
34607 When delivery fails, an error message is written to the standard error stream
34608 (as well as to Exim's log), and Exim exits to the caller with a return code
34609 value 1. The message is expunged from Exim's spool files. No bounce messages
34610 are ever generated.
34611 .next
34612 No retry data is maintained, and any retry rules are ignored.
34613 .next
34614 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34615 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34616 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34617 .endlist
34618
34619 The overall effect is that Exim makes a single synchronous attempt to deliver
34620 the message, failing if there is any kind of problem. Because no local
34621 deliveries are done and no daemon can be run, Exim does not need root
34622 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34623 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34624 the advantages and disadvantages of running without root privilege.
34625
34626
34627
34628
34629 . ////////////////////////////////////////////////////////////////////////////
34630 . ////////////////////////////////////////////////////////////////////////////
34631
34632 .chapter "Log files" "CHAPlog"
34633 .scindex IIDloggen "log" "general description"
34634 .cindex "log" "types of"
34635 Exim writes three different logs, referred to as the main log, the reject log,
34636 and the panic log:
34637
34638 .ilist
34639 .cindex "main log"
34640 The main log records the arrival of each message and each delivery in a single
34641 line in each case. The format is as compact as possible, in an attempt to keep
34642 down the size of log files. Two-character flag sequences make it easy to pick
34643 out these lines. A number of other events are recorded in the main log. Some of
34644 them are optional, in which case the &%log_selector%& option controls whether
34645 they are included or not. A Perl script called &'eximstats'&, which does simple
34646 analysis of main log files, is provided in the Exim distribution (see section
34647 &<<SECTmailstat>>&).
34648 .next
34649 .cindex "reject log"
34650 The reject log records information from messages that are rejected as a result
34651 of a configuration option (that is, for policy reasons).
34652 The first line of each rejection is a copy of the line that is also written to
34653 the main log. Then, if the message's header has been read at the time the log
34654 is written, its contents are written to this log. Only the original header
34655 lines are available; header lines added by ACLs are not logged. You can use the
34656 reject log to check that your policy controls are working correctly; on a busy
34657 host this may be easier than scanning the main log for rejection messages. You
34658 can suppress the writing of the reject log by setting &%write_rejectlog%&
34659 false.
34660 .next
34661 .cindex "panic log"
34662 .cindex "system log"
34663 When certain serious errors occur, Exim writes entries to its panic log. If the
34664 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34665 are usually written to the main log as well, but can get lost amid the mass of
34666 other entries. The panic log should be empty under normal circumstances. It is
34667 therefore a good idea to check it (or to have a &'cron'& script check it)
34668 regularly, in order to become aware of any problems. When Exim cannot open its
34669 panic log, it tries as a last resort to write to the system log (syslog). This
34670 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34671 message itself is written at priority LOG_CRIT.
34672 .endlist
34673
34674 Every log line starts with a timestamp, in the format shown in the following
34675 example. Note that many of the examples shown in this chapter are line-wrapped.
34676 In the log file, this would be all on one line:
34677 .code
34678 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34679   by QUIT
34680 .endd
34681 By default, the timestamps are in the local timezone. There are two
34682 ways of changing this:
34683
34684 .ilist
34685 You can set the &%timezone%& option to a different time zone; in particular, if
34686 you set
34687 .code
34688 timezone = UTC
34689 .endd
34690 the timestamps will be in UTC (aka GMT).
34691 .next
34692 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34693 example:
34694 .code
34695 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34696 .endd
34697 .endlist
34698
34699 .cindex "log" "process ids in"
34700 .cindex "pid (process id)" "in log lines"
34701 Exim does not include its process id in log lines by default, but you can
34702 request that it does so by specifying the &`pid`& log selector (see section
34703 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34704 brackets, immediately after the time and date.
34705
34706
34707
34708
34709 .section "Where the logs are written" "SECTwhelogwri"
34710 .cindex "log" "destination"
34711 .cindex "log" "to file"
34712 .cindex "log" "to syslog"
34713 .cindex "syslog"
34714 The logs may be written to local files, or to syslog, or both. However, it
34715 should be noted that many syslog implementations use UDP as a transport, and
34716 are therefore unreliable in the sense that messages are not guaranteed to
34717 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34718 It has also been reported that on large log files (tens of megabytes) you may
34719 need to tweak syslog to prevent it syncing the file with each write &-- on
34720 Linux this has been seen to make syslog take 90% plus of CPU time.
34721
34722 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34723 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34724 configuration. This latter string is expanded, so it can contain, for example,
34725 references to the host name:
34726 .code
34727 log_file_path = /var/log/$primary_hostname/exim_%slog
34728 .endd
34729 It is generally advisable, however, to set the string in &_Local/Makefile_&
34730 rather than at run time, because then the setting is available right from the
34731 start of Exim's execution. Otherwise, if there's something it wants to log
34732 before it has read the configuration file (for example, an error in the
34733 configuration file) it will not use the path you want, and may not be able to
34734 log at all.
34735
34736 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34737 list, currently limited to at most two items. This is one option where the
34738 facility for changing a list separator may not be used. The list must always be
34739 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34740 otherwise the item must either be an absolute path, containing &`%s`& at the
34741 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34742 implying the use of a default path.
34743
34744 When Exim encounters an empty item in the list, it searches the list defined by
34745 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34746 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34747 mean &"use the path specified at build time"&. It no such item exists, log
34748 files are written in the &_log_& subdirectory of the spool directory. This is
34749 equivalent to the setting:
34750 .code
34751 log_file_path = $spool_directory/log/%slog
34752 .endd
34753 If you do not specify anything at build time or run time,
34754 or if you unset the option at run time (i.e. &`log_file_path = `&),
34755 that is where the logs are written.
34756
34757 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34758 are in use &-- see section &<<SECTdatlogfil>>& below.
34759
34760 Here are some examples of possible settings:
34761 .display
34762 &`LOG_FILE_PATH=syslog                    `& syslog only
34763 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34764 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34765 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34766 .endd
34767 If there are more than two paths in the list, the first is used and a panic
34768 error is logged.
34769
34770
34771
34772 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34773 .cindex "log" "cycling local files"
34774 .cindex "cycling logs"
34775 .cindex "&'exicyclog'&"
34776 .cindex "log" "local files; writing to"
34777 Some operating systems provide centralized and standardized methods for cycling
34778 log files. For those that do not, a utility script called &'exicyclog'& is
34779 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34780 main and reject logs each time it is called. The maximum number of old logs to
34781 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34782
34783 An Exim delivery process opens the main log when it first needs to write to it,
34784 and it keeps the file open in case subsequent entries are required &-- for
34785 example, if a number of different deliveries are being done for the same
34786 message. However, remote SMTP deliveries can take a long time, and this means
34787 that the file may be kept open long after it is renamed if &'exicyclog'& or
34788 something similar is being used to rename log files on a regular basis. To
34789 ensure that a switch of log files is noticed as soon as possible, Exim calls
34790 &[stat()]& on the main log's name before reusing an open file, and if the file
34791 does not exist, or its inode has changed, the old file is closed and Exim
34792 tries to open the main log from scratch. Thus, an old log file may remain open
34793 for quite some time, but no Exim processes should write to it once it has been
34794 renamed.
34795
34796
34797
34798 .section "Datestamped log files" "SECTdatlogfil"
34799 .cindex "log" "datestamped files"
34800 Instead of cycling the main and reject log files by renaming them
34801 periodically, some sites like to use files whose names contain a datestamp,
34802 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34803 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34804 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34805 point where the datestamp is required. For example:
34806 .code
34807 log_file_path = /var/spool/exim/log/%slog-%D
34808 log_file_path = /var/log/exim-%s-%D.log
34809 log_file_path = /var/spool/exim/log/%D-%slog
34810 log_file_path = /var/log/exim/%s.%M
34811 .endd
34812 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34813 examples of names generated by the above examples:
34814 .code
34815 /var/spool/exim/log/mainlog-20021225
34816 /var/log/exim-reject-20021225.log
34817 /var/spool/exim/log/20021225-mainlog
34818 /var/log/exim/main.200212
34819 .endd
34820 When this form of log file is specified, Exim automatically switches to new
34821 files at midnight. It does not make any attempt to compress old logs; you
34822 will need to write your own script if you require this. You should not
34823 run &'exicyclog'& with this form of logging.
34824
34825 The location of the panic log is also determined by &%log_file_path%&, but it
34826 is not datestamped, because rotation of the panic log does not make sense.
34827 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34828 the string. In addition, if it immediately follows a slash, a following
34829 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34830 character is removed. Thus, the four examples above would give these panic
34831 log names:
34832 .code
34833 /var/spool/exim/log/paniclog
34834 /var/log/exim-panic.log
34835 /var/spool/exim/log/paniclog
34836 /var/log/exim/panic
34837 .endd
34838
34839
34840 .section "Logging to syslog" "SECID249"
34841 .cindex "log" "syslog; writing to"
34842 The use of syslog does not change what Exim logs or the format of its messages,
34843 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34844 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34845 that, the same strings are written to syslog as to log files. The syslog
34846 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34847 by default, but you can change these by setting the &%syslog_facility%& and
34848 &%syslog_processname%& options, respectively. If Exim was compiled with
34849 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34850 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34851 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34852 the time and host name to each line.
34853 The three log streams are mapped onto syslog priorities as follows:
34854
34855 .ilist
34856 &'mainlog'& is mapped to LOG_INFO
34857 .next
34858 &'rejectlog'& is mapped to LOG_NOTICE
34859 .next
34860 &'paniclog'& is mapped to LOG_ALERT
34861 .endlist
34862
34863 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34864 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34865 these are routed by syslog to the same place. You can suppress this duplication
34866 by setting &%syslog_duplication%& false.
34867
34868 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34869 entries contain multiple lines when headers are included. To cope with both
34870 these cases, entries written to syslog are split into separate &[syslog()]&
34871 calls at each internal newline, and also after a maximum of
34872 870 data characters. (This allows for a total syslog line length of 1024, when
34873 additions such as timestamps are added.) If you are running a syslog
34874 replacement that can handle lines longer than the 1024 characters allowed by
34875 RFC 3164, you should set
34876 .code
34877 SYSLOG_LONG_LINES=yes
34878 .endd
34879 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34880 lines, but it still splits at internal newlines in &'reject'& log entries.
34881
34882 To make it easy to re-assemble split lines later, each component of a split
34883 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34884 where <&'n'&> is the component number and <&'m'&> is the total number of
34885 components in the entry. The / delimiter is used when the line was split
34886 because it was too long; if it was split because of an internal newline, the \
34887 delimiter is used. For example, supposing the length limit to be 50 instead of
34888 870, the following would be the result of a typical rejection message to
34889 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34890 name, and pid as added by syslog:
34891 .code
34892 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34893 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34894 [3/5]  when scanning for sender: missing or malformed lo
34895 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34896 [5/5] mple>)
34897 .endd
34898 The same error might cause the following lines to be written to &"rejectlog"&
34899 (LOG_NOTICE):
34900 .code
34901 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34902 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34903 [3/18] er when scanning for sender: missing or malformed
34904 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34905 [5\18] .example>)
34906 [6\18] Recipients: ph10@some.domain.cam.example
34907 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34908 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34909 [9\18]        id 16RdAL-0006pc-00
34910 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34911 [11\18] 09:43 +0100
34912 [12\18] F From: <>
34913 [13\18]   Subject: this is a test header
34914 [18\18]   X-something: this is another header
34915 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34916 [16\18] le>
34917 [17\18] B Bcc:
34918 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34919 .endd
34920 Log lines that are neither too long nor contain newlines are written to syslog
34921 without modification.
34922
34923 If only syslog is being used, the Exim monitor is unable to provide a log tail
34924 display, unless syslog is routing &'mainlog'& to a file on the local host and
34925 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34926 where it is.
34927
34928
34929
34930 .section "Log line flags" "SECID250"
34931 One line is written to the main log for each message received, and for each
34932 successful, unsuccessful, and delayed delivery. These lines can readily be
34933 picked out by the distinctive two-character flags that immediately follow the
34934 timestamp. The flags are:
34935 .display
34936 &`<=`&     message arrival
34937 &`=>`&     normal message delivery
34938 &`->`&     additional address in same delivery
34939 &`>>`&     cutthrough message delivery
34940 &`*>`&     delivery suppressed by &%-N%&
34941 &`**`&     delivery failed; address bounced
34942 &`==`&     delivery deferred; temporary problem
34943 .endd
34944
34945
34946 .section "Logging message reception" "SECID251"
34947 .cindex "log" "reception line"
34948 The format of the single-line entry in the main log that is written for every
34949 message received is shown in the basic example below, which is split over
34950 several lines in order to fit it on the page:
34951 .code
34952 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34953   H=mailer.fict.example [192.168.123.123] U=exim
34954   P=smtp S=5678 id=<incoming message id>
34955 .endd
34956 The address immediately following &"<="& is the envelope sender address. A
34957 bounce message is shown with the sender address &"<>"&, and if it is locally
34958 generated, this is followed by an item of the form
34959 .code
34960 R=<message id>
34961 .endd
34962 which is a reference to the message that caused the bounce to be sent.
34963
34964 .cindex "HELO"
34965 .cindex "EHLO"
34966 For messages from other hosts, the H and U fields identify the remote host and
34967 record the RFC 1413 identity of the user that sent the message, if one was
34968 received. The number given in square brackets is the IP address of the sending
34969 host. If there is a single, unparenthesized  host name in the H field, as
34970 above, it has been verified to correspond to the IP address (see the
34971 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34972 by the remote host in the SMTP HELO or EHLO command, and has not been
34973 verified. If verification yields a different name to that given for HELO or
34974 EHLO, the verified name appears first, followed by the HELO or EHLO
34975 name in parentheses.
34976
34977 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34978 without brackets, in the HELO or EHLO command, leading to entries in
34979 the log containing text like these examples:
34980 .code
34981 H=(10.21.32.43) [192.168.8.34]
34982 H=([10.21.32.43]) [192.168.8.34]
34983 .endd
34984 This can be confusing. Only the final address in square brackets can be relied
34985 on.
34986
34987 For locally generated messages (that is, messages not received over TCP/IP),
34988 the H field is omitted, and the U field contains the login name of the caller
34989 of Exim.
34990
34991 .cindex "authentication" "logging"
34992 .cindex "AUTH" "logging"
34993 For all messages, the P field specifies the protocol used to receive the
34994 message. This is the value that is stored in &$received_protocol$&. In the case
34995 of incoming SMTP messages, the value indicates whether or not any SMTP
34996 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34997 session was encrypted, there is an additional X field that records the cipher
34998 suite that was used.
34999
35000 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35001 hosts that have authenticated themselves using the SMTP AUTH command. The first
35002 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35003 there is an additional item A= followed by the name of the authenticator that
35004 was used. If an authenticated identification was set up by the authenticator's
35005 &%server_set_id%& option, this is logged too, separated by a colon from the
35006 authenticator name.
35007
35008 .cindex "size" "of message"
35009 The id field records the existing message id, if present. The size of the
35010 received message is given by the S field. When the message is delivered,
35011 headers may be removed or added, so that the size of delivered copies of the
35012 message may not correspond with this value (and indeed may be different to each
35013 other).
35014
35015 The &%log_selector%& option can be used to request the logging of additional
35016 data when a message is received. See section &<<SECTlogselector>>& below.
35017
35018
35019
35020 .section "Logging deliveries" "SECID252"
35021 .cindex "log" "delivery line"
35022 The format of the single-line entry in the main log that is written for every
35023 delivery is shown in one of the examples below, for local and remote
35024 deliveries, respectively. Each example has been split into two lines in order
35025 to fit it on the page:
35026 .code
35027 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35028   <marv@hitch.fict.example> R=localuser T=local_delivery
35029 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35030   monk@holistic.fict.example R=dnslookup T=remote_smtp
35031   H=holistic.fict.example [192.168.234.234]
35032 .endd
35033 For ordinary local deliveries, the original address is given in angle brackets
35034 after the final delivery address, which might be a pipe or a file. If
35035 intermediate address(es) exist between the original and the final address, the
35036 last of these is given in parentheses after the final address. The R and T
35037 fields record the router and transport that were used to process the address.
35038
35039 If SMTP AUTH was used for the delivery there is an additional item A=
35040 followed by the name of the authenticator that was used.
35041 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35042 option, this is logged too, separated by a colon from the authenticator name.
35043
35044 If a shadow transport was run after a successful local delivery, the log line
35045 for the successful delivery has an item added on the end, of the form
35046 .display
35047 &`ST=<`&&'shadow transport name'&&`>`&
35048 .endd
35049 If the shadow transport did not succeed, the error message is put in
35050 parentheses afterwards.
35051
35052 .cindex "asterisk" "after IP address"
35053 When more than one address is included in a single delivery (for example, two
35054 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35055 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35056 down a single SMTP connection, an asterisk follows the IP address in the log
35057 lines for the second and subsequent messages.
35058
35059 .cindex "delivery" "cutthrough; logging"
35060 .cindex "cutthrough" "logging"
35061 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35062 line precedes the reception line, since cutthrough waits for a possible
35063 rejection from the destination in case it can reject the sourced item.
35064
35065 The generation of a reply message by a filter file gets logged as a
35066 &"delivery"& to the addressee, preceded by &">"&.
35067
35068 The &%log_selector%& option can be used to request the logging of additional
35069 data when a message is delivered. See section &<<SECTlogselector>>& below.
35070
35071
35072 .section "Discarded deliveries" "SECID253"
35073 .cindex "discarded messages"
35074 .cindex "message" "discarded"
35075 .cindex "delivery" "discarded; logging"
35076 When a message is discarded as a result of the command &"seen finish"& being
35077 obeyed in a filter file which generates no deliveries, a log entry of the form
35078 .code
35079 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35080   <low.club@bridge.example> R=userforward
35081 .endd
35082 is written, to record why no deliveries are logged. When a message is discarded
35083 because it is aliased to &":blackhole:"& the log line is like this:
35084 .code
35085 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35086   <hole@nowhere.example> R=blackhole_router
35087 .endd
35088
35089
35090 .section "Deferred deliveries" "SECID254"
35091 When a delivery is deferred, a line of the following form is logged:
35092 .code
35093 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35094   R=dnslookup T=smtp defer (146): Connection refused
35095 .endd
35096 In the case of remote deliveries, the error is the one that was given for the
35097 last IP address that was tried. Details of individual SMTP failures are also
35098 written to the log, so the above line would be preceded by something like
35099 .code
35100 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35101   mail1.endrest.example [192.168.239.239]: Connection refused
35102 .endd
35103 When a deferred address is skipped because its retry time has not been reached,
35104 a message is written to the log, but this can be suppressed by setting an
35105 appropriate value in &%log_selector%&.
35106
35107
35108
35109 .section "Delivery failures" "SECID255"
35110 .cindex "delivery" "failure; logging"
35111 If a delivery fails because an address cannot be routed, a line of the
35112 following form is logged:
35113 .code
35114 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35115   <jim@trek99.example>: unknown mail domain
35116 .endd
35117 If a delivery fails at transport time, the router and transport are shown, and
35118 the response from the remote host is included, as in this example:
35119 .code
35120 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35121   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35122   after pipelined RCPT TO:<ace400@pb.example>: host
35123   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35124   <ace400@pb.example>...Addressee unknown
35125 .endd
35126 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35127 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35128 disabling PIPELINING. The log lines for all forms of delivery failure are
35129 flagged with &`**`&.
35130
35131
35132
35133 .section "Fake deliveries" "SECID256"
35134 .cindex "delivery" "fake; logging"
35135 If a delivery does not actually take place because the &%-N%& option has been
35136 used to suppress it, a normal delivery line is written to the log, except that
35137 &"=>"& is replaced by &"*>"&.
35138
35139
35140
35141 .section "Completion" "SECID257"
35142 A line of the form
35143 .code
35144 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35145 .endd
35146 is written to the main log when a message is about to be removed from the spool
35147 at the end of its processing.
35148
35149
35150
35151
35152 .section "Summary of Fields in Log Lines" "SECID258"
35153 .cindex "log" "summary of fields"
35154 A summary of the field identifiers that are used in log lines is shown in
35155 the following table:
35156 .display
35157 &`A   `&        authenticator name (and optional id and sender)
35158 &`C   `&        SMTP confirmation on delivery
35159 &`    `&        command list for &"no mail in SMTP session"&
35160 &`CV  `&        certificate verification status
35161 &`D   `&        duration of &"no mail in SMTP session"&
35162 &`DN  `&        distinguished name from peer certificate
35163 &`DT  `&        on &`=>`& lines: time taken for a delivery
35164 &`F   `&        sender address (on delivery lines)
35165 &`H   `&        host name and IP address
35166 &`I   `&        local interface used
35167 &`id  `&        message id for incoming message
35168 &`P   `&        on &`<=`& lines: protocol used
35169 &`    `&        on &`=>`& and &`**`& lines: return path
35170 &`QT  `&        on &`=>`& lines: time spent on queue so far
35171 &`    `&        on &"Completed"& lines: time spent on queue
35172 &`R   `&        on &`<=`& lines: reference for local bounce
35173 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35174 &`S   `&        size of message
35175 &`SNI `&        server name indication from TLS client hello
35176 &`ST  `&        shadow transport name
35177 &`T   `&        on &`<=`& lines: message subject (topic)
35178 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35179 &`U   `&        local user or RFC 1413 identity
35180 &`X   `&        TLS cipher suite
35181 .endd
35182
35183
35184 .section "Other log entries" "SECID259"
35185 Various other types of log entry are written from time to time. Most should be
35186 self-explanatory. Among the more common are:
35187
35188 .ilist
35189 .cindex "retry" "time not reached"
35190 &'retry time not reached'&&~&~An address previously suffered a temporary error
35191 during routing or local delivery, and the time to retry has not yet arrived.
35192 This message is not written to an individual message log file unless it happens
35193 during the first delivery attempt.
35194 .next
35195 &'retry time not reached for any host'&&~&~An address previously suffered
35196 temporary errors during remote delivery, and the retry time has not yet arrived
35197 for any of the hosts to which it is routed.
35198 .next
35199 .cindex "spool directory" "file locked"
35200 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35201 some other Exim process is already working on the message. This can be quite
35202 common if queue running processes are started at frequent intervals. The
35203 &'exiwhat'& utility script can be used to find out what Exim processes are
35204 doing.
35205 .next
35206 .cindex "error" "ignored"
35207 &'error ignored'&&~&~There are several circumstances that give rise to this
35208 message:
35209 .olist
35210 Exim failed to deliver a bounce message whose age was greater than
35211 &%ignore_bounce_errors_after%&. The bounce was discarded.
35212 .next
35213 A filter file set up a delivery using the &"noerror"& option, and the delivery
35214 failed. The delivery was discarded.
35215 .next
35216 A delivery set up by a router configured with
35217 . ==== As this is a nested list, any displays it contains must be indented
35218 . ==== as otherwise they are too far to the left.
35219 .code
35220     errors_to = <>
35221 .endd
35222 failed. The delivery was discarded.
35223 .endlist olist
35224 .endlist ilist
35225
35226
35227
35228
35229
35230 .section "Reducing or increasing what is logged" "SECTlogselector"
35231 .cindex "log" "selectors"
35232 By setting the &%log_selector%& global option, you can disable some of Exim's
35233 default logging, or you can request additional logging. The value of
35234 &%log_selector%& is made up of names preceded by plus or minus characters. For
35235 example:
35236 .code
35237 log_selector = +arguments -retry_defer
35238 .endd
35239 The list of optional log items is in the following table, with the default
35240 selection marked by asterisks:
35241 .display
35242 &` 8bitmime                   `&  received 8BITMIME status
35243 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35244 &` address_rewrite            `&  address rewriting
35245 &` all_parents                `&  all parents in => lines
35246 &` arguments                  `&  command line arguments
35247 &`*connection_reject          `&  connection rejections
35248 &`*delay_delivery             `&  immediate delivery delayed
35249 &` deliver_time               `&  time taken to perform delivery
35250 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35251 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35252 &`*etrn                       `&  ETRN commands
35253 &`*host_lookup_failed         `&  as it says
35254 &` ident_timeout              `&  timeout for ident connection
35255 &` incoming_interface         `&  local interface on <= and => lines
35256 &` incoming_port              `&  remote port on <= lines
35257 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35258 &` outgoing_port              `&  add remote port to => lines
35259 &`*queue_run                  `&  start and end queue runs
35260 &` queue_time                 `&  time on queue for one recipient
35261 &` queue_time_overall         `&  time on queue for whole message
35262 &` pid                        `&  Exim process id
35263 &` received_recipients        `&  recipients on <= lines
35264 &` received_sender            `&  sender on <= lines
35265 &`*rejected_header            `&  header contents on reject log
35266 &`*retry_defer                `&  &"retry time not reached"&
35267 &` return_path_on_delivery    `&  put return path on => and ** lines
35268 &` sender_on_delivery         `&  add sender to => lines
35269 &`*sender_verify_fail         `&  sender verification failures
35270 &`*size_reject                `&  rejection because too big
35271 &`*skip_delivery              `&  delivery skipped in a queue run
35272 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35273 &` smtp_connection            `&  SMTP connections
35274 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35275 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35276 &` smtp_no_mail               `&  session with no MAIL commands
35277 &` smtp_protocol_error        `&  SMTP protocol errors
35278 &` smtp_syntax_error          `&  SMTP syntax errors
35279 &` subject                    `&  contents of &'Subject:'& on <= lines
35280 .new
35281 &`*tls_certificate_verified   `&  certificate verification status
35282 .wen
35283 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35284 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35285 &` tls_sni                    `&  TLS SNI on <= lines
35286 &` unknown_in_list            `&  DNS lookup failed in list match
35287
35288 &` all                        `&  all of the above
35289 .endd
35290 More details on each of these items follows:
35291
35292 .ilist
35293 .cindex "8BITMIME"
35294 .cindex "log" "8BITMIME"
35295 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35296 which may help in tracking down interoperability issues with ancient MTAs
35297 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35298 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35299 &`7BIT`& and &`8BITMIME`& respectively.
35300 .next
35301 .cindex "&%warn%& ACL verb" "log when skipping"
35302 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35303 its conditions cannot be evaluated, a log line to this effect is written if
35304 this log selector is set.
35305 .next
35306 .cindex "log" "rewriting"
35307 .cindex "rewriting" "logging"
35308 &%address_rewrite%&: This applies both to global rewrites and per-transport
35309 rewrites, but not to rewrites in filters run as an unprivileged user (because
35310 such users cannot access the log).
35311 .next
35312 .cindex "log" "full parentage"
35313 &%all_parents%&: Normally only the original and final addresses are logged on
35314 delivery lines; with this selector, intermediate parents are given in
35315 parentheses between them.
35316 .next
35317 .cindex "log" "Exim arguments"
35318 .cindex "Exim arguments, logging"
35319 &%arguments%&: This causes Exim to write the arguments with which it was called
35320 to the main log, preceded by the current working directory. This is a debugging
35321 feature, added to make it easier to find out how certain MUAs call
35322 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35323 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35324 that are empty or that contain white space are quoted. Non-printing characters
35325 are shown as escape sequences. This facility cannot log unrecognized arguments,
35326 because the arguments are checked before the configuration file is read. The
35327 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35328 between the caller and Exim.
35329 .next
35330 .cindex "log" "connection rejections"
35331 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35332 connection is rejected, for whatever reason.
35333 .next
35334 .cindex "log" "delayed delivery"
35335 .cindex "delayed delivery, logging"
35336 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35337 started for an incoming message because the load is too high or too many
35338 messages were received on one connection. Logging does not occur if no delivery
35339 process is started because &%queue_only%& is set or &%-odq%& was used.
35340 .next
35341 .cindex "log" "delivery duration"
35342 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35343 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35344 .next
35345 .cindex "log" "message size on delivery"
35346 .cindex "size" "of message"
35347 &%delivery_size%&: For each delivery, the size of message delivered is added to
35348 the &"=>"& line, tagged with S=.
35349 .next
35350 .cindex "log" "dnslist defer"
35351 .cindex "DNS list" "logging defer"
35352 .cindex "black list (DNS)"
35353 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35354 DNS black list suffers a temporary error.
35355 .next
35356 .cindex "log" "ETRN commands"
35357 .cindex "ETRN" "logging"
35358 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35359 is run to determine whether or not it is actually accepted. An invalid ETRN
35360 command, or one received within a message transaction is not logged by this
35361 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35362 .next
35363 .cindex "log" "host lookup failure"
35364 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35365 any addresses, or when a lookup of an IP address fails to find a host name, a
35366 log line is written. This logging does not apply to direct DNS lookups when
35367 routing email addresses, but it does apply to &"byname"& lookups.
35368 .next
35369 .cindex "log" "ident timeout"
35370 .cindex "RFC 1413" "logging timeout"
35371 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35372 client's ident port times out.
35373 .next
35374 .cindex "log" "incoming interface"
35375 .cindex "log" "local interface"
35376 .cindex "log" "local address and port"
35377 .cindex "TCP/IP" "logging local address and port"
35378 .cindex "interface" "logging"
35379 &%incoming_interface%&: The interface on which a message was received is added
35380 to the &"<="& line as an IP address in square brackets, tagged by I= and
35381 followed by a colon and the port number. The local interface and port are also
35382 added to other SMTP log lines, for example &"SMTP connection from"& and to
35383 rejection lines
35384 and (despite the name) the local interface is added to &"=>"& lines..
35385 .next
35386 .cindex "log" "incoming remote port"
35387 .cindex "port" "logging remote"
35388 .cindex "TCP/IP" "logging incoming remote port"
35389 .vindex "&$sender_fullhost$&"
35390 .vindex "&$sender_rcvhost$&"
35391 &%incoming_port%&: The remote port number from which a message was received is
35392 added to log entries and &'Received:'& header lines, following the IP address
35393 in square brackets, and separated from it by a colon. This is implemented by
35394 changing the value that is put in the &$sender_fullhost$& and
35395 &$sender_rcvhost$& variables. Recording the remote port number has become more
35396 important with the widening use of NAT (see RFC 2505).
35397 .next
35398 .cindex "log" "dropped connection"
35399 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35400 connection is unexpectedly dropped.
35401 .next
35402 .cindex "log" "outgoing remote port"
35403 .cindex "port" "logging outgoint remote"
35404 .cindex "TCP/IP" "logging ougtoing remote port"
35405 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35406 containing => tags) following the IP address. This option is not included in
35407 the default setting, because for most ordinary configurations, the remote port
35408 number is always 25 (the SMTP port).
35409 .next
35410 .cindex "log" "process ids in"
35411 .cindex "pid (process id)" "in log lines"
35412 &%pid%&: The current process id is added to every log line, in square brackets,
35413 immediately after the time and date.
35414 .next
35415 .cindex "log" "queue run"
35416 .cindex "queue runner" "logging"
35417 &%queue_run%&: The start and end of every queue run are logged.
35418 .next
35419 .cindex "log" "queue time"
35420 &%queue_time%&: The amount of time the message has been in the queue on the
35421 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35422 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35423 includes reception time as well as the delivery time for the current address.
35424 This means that it may be longer than the difference between the arrival and
35425 delivery log line times, because the arrival log line is not written until the
35426 message has been successfully received.
35427 .next
35428 &%queue_time_overall%&: The amount of time the message has been in the queue on
35429 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35430 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35431 message, so it includes reception time as well as the total delivery time.
35432 .next
35433 .cindex "log" "recipients"
35434 &%received_recipients%&: The recipients of a message are listed in the main log
35435 as soon as the message is received. The list appears at the end of the log line
35436 that is written when a message is received, preceded by the word &"for"&. The
35437 addresses are listed after they have been qualified, but before any rewriting
35438 has taken place.
35439 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35440 in the list.
35441 .next
35442 .cindex "log" "sender reception"
35443 &%received_sender%&: The unrewritten original sender of a message is added to
35444 the end of the log line that records the message's arrival, after the word
35445 &"from"& (before the recipients if &%received_recipients%& is also set).
35446 .next
35447 .cindex "log" "header lines for rejection"
35448 &%rejected_header%&: If a message's header has been received at the time a
35449 rejection is written to the reject log, the complete header is added to the
35450 log. Header logging can be turned off individually for messages that are
35451 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35452 .next
35453 .cindex "log" "retry defer"
35454 &%retry_defer%&: A log line is written if a delivery is deferred because a
35455 retry time has not yet been reached. However, this &"retry time not reached"&
35456 message is always omitted from individual message logs after the first delivery
35457 attempt.
35458 .next
35459 .cindex "log" "return path"
35460 &%return_path_on_delivery%&: The return path that is being transmitted with
35461 the message is included in delivery and bounce lines, using the tag P=.
35462 This is omitted if no delivery actually happens, for example, if routing fails,
35463 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35464 .next
35465 .cindex "log" "sender on delivery"
35466 &%sender_on_delivery%&: The message's sender address is added to every delivery
35467 and bounce line, tagged by F= (for &"from"&).
35468 This is the original sender that was received with the message; it is not
35469 necessarily the same as the outgoing return path.
35470 .next
35471 .cindex "log" "sender verify failure"
35472 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35473 gives details of a sender verification failure is not written. Log lines for
35474 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35475 detail is lost.
35476 .next
35477 .cindex "log" "size rejection"
35478 &%size_reject%&: A log line is written whenever a message is rejected because
35479 it is too big.
35480 .next
35481 .cindex "log" "frozen messages; skipped"
35482 .cindex "frozen messages" "logging skipping"
35483 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35484 queue run because it is frozen or because another process is already delivering
35485 it.
35486 .cindex "&""spool file is locked""&"
35487 The message that is written is &"spool file is locked"&.
35488 .next
35489 .cindex "log" "smtp confirmation"
35490 .cindex "SMTP" "logging confirmation"
35491 .cindex "LMTP" "logging confirmation"
35492 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35493 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35494 A number of MTAs (including Exim) return an identifying string in this
35495 response.
35496 .next
35497 .cindex "log" "SMTP connections"
35498 .cindex "SMTP" "logging connections"
35499 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35500 established or closed, unless the connection is from a host that matches
35501 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35502 only when the closure is unexpected.) This applies to connections from local
35503 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35504 dropped in the middle of a message, a log line is always written, whether or
35505 not this selector is set, but otherwise nothing is written at the start and end
35506 of connections unless this selector is enabled.
35507
35508 For TCP/IP connections to an Exim daemon, the current number of connections is
35509 included in the log message for each new connection, but note that the count is
35510 reset if the daemon is restarted.
35511 Also, because connections are closed (and the closure is logged) in
35512 subprocesses, the count may not include connections that have been closed but
35513 whose termination the daemon has not yet noticed. Thus, while it is possible to
35514 match up the opening and closing of connections in the log, the value of the
35515 logged counts may not be entirely accurate.
35516 .next
35517 .cindex "log" "SMTP transaction; incomplete"
35518 .cindex "SMTP" "logging incomplete transactions"
35519 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35520 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35521 and the message sender plus any accepted recipients are included in the log
35522 line. This can provide evidence of dictionary attacks.
35523 .next
35524 .cindex "log" "non-MAIL SMTP sessions"
35525 .cindex "MAIL" "logging session without"
35526 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35527 connection terminates without having issued a MAIL command. This includes both
35528 the case when the connection is dropped, and the case when QUIT is used. It
35529 does not include cases where the connection is rejected right at the start (by
35530 an ACL, or because there are too many connections, or whatever). These cases
35531 already have their own log lines.
35532
35533 The log line that is written contains the identity of the client in the usual
35534 way, followed by D= and a time, which records the duration of the connection.
35535 If the connection was authenticated, this fact is logged exactly as it is for
35536 an incoming message, with an A= item. If the connection was encrypted, CV=,
35537 DN=, and X= items may appear as they do for an incoming message, controlled by
35538 the same logging options.
35539
35540 Finally, if any SMTP commands were issued during the connection, a C= item
35541 is added to the line, listing the commands that were used. For example,
35542 .code
35543 C=EHLO,QUIT
35544 .endd
35545 shows that the client issued QUIT straight after EHLO. If there were fewer
35546 than 20 commands, they are all listed. If there were more than 20 commands,
35547 the last 20 are listed, preceded by &"..."&. However, with the default
35548 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35549 have been aborted before 20 non-mail commands are processed.
35550 .next
35551 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35552 colon-separated, is appended to the A= item for a message arrival or delivery
35553 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35554 was accepted or used.
35555 .next
35556 .cindex "log" "SMTP protocol error"
35557 .cindex "SMTP" "logging protocol error"
35558 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35559 encountered. Exim does not have perfect detection of all protocol errors
35560 because of transmission delays and the use of pipelining. If PIPELINING has
35561 been advertised to a client, an Exim server assumes that the client will use
35562 it, and therefore it does not count &"expected"& errors (for example, RCPT
35563 received after rejecting MAIL) as protocol errors.
35564 .next
35565 .cindex "SMTP" "logging syntax errors"
35566 .cindex "SMTP" "syntax errors; logging"
35567 .cindex "SMTP" "unknown command; logging"
35568 .cindex "log" "unknown SMTP command"
35569 .cindex "log" "SMTP syntax error"
35570 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35571 encountered. An unrecognized command is treated as a syntax error. For an
35572 external connection, the host identity is given; for an internal connection
35573 using &%-bs%& the sender identification (normally the calling user) is given.
35574 .next
35575 .cindex "log" "subject"
35576 .cindex "subject, logging"
35577 &%subject%&: The subject of the message is added to the arrival log line,
35578 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35579 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35580 specifies whether characters with values greater than 127 should be logged
35581 unchanged, or whether they should be rendered as escape sequences.
35582 .next
35583 .cindex "log" "certificate verification"
35584 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35585 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35586 verified, and &`CV=no`& if not.
35587 .next
35588 .cindex "log" "TLS cipher"
35589 .cindex "TLS" "logging cipher"
35590 &%tls_cipher%&: When a message is sent or received over an encrypted
35591 connection, the cipher suite used is added to the log line, preceded by X=.
35592 .next
35593 .cindex "log" "TLS peer DN"
35594 .cindex "TLS" "logging peer DN"
35595 &%tls_peerdn%&: When a message is sent or received over an encrypted
35596 connection, and a certificate is supplied by the remote host, the peer DN is
35597 added to the log line, preceded by DN=.
35598 .next
35599 .cindex "log" "TLS SNI"
35600 .cindex "TLS" "logging SNI"
35601 &%tls_sni%&: When a message is received over an encrypted connection, and
35602 the remote host provided the Server Name Indication extension, the SNI is
35603 added to the log line, preceded by SNI=.
35604 .next
35605 .cindex "log" "DNS failure in list"
35606 &%unknown_in_list%&: This setting causes a log entry to be written when the
35607 result of a list match is failure because a DNS lookup failed.
35608 .endlist
35609
35610
35611 .section "Message log" "SECID260"
35612 .cindex "message" "log file for"
35613 .cindex "log" "message log; description of"
35614 .cindex "&_msglog_& directory"
35615 .oindex "&%preserve_message_logs%&"
35616 In addition to the general log files, Exim writes a log file for each message
35617 that it handles. The names of these per-message logs are the message ids, and
35618 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35619 message log contains copies of the log lines that apply to the message. This
35620 makes it easier to inspect the status of an individual message without having
35621 to search the main log. A message log is deleted when processing of the message
35622 is complete, unless &%preserve_message_logs%& is set, but this should be used
35623 only with great care because they can fill up your disk very quickly.
35624
35625 On a heavily loaded system, it may be desirable to disable the use of
35626 per-message logs, in order to reduce disk I/O. This can be done by setting the
35627 &%message_logs%& option false.
35628 .ecindex IIDloggen
35629
35630
35631
35632
35633 . ////////////////////////////////////////////////////////////////////////////
35634 . ////////////////////////////////////////////////////////////////////////////
35635
35636 .chapter "Exim utilities" "CHAPutils"
35637 .scindex IIDutils "utilities"
35638 A number of utility scripts and programs are supplied with Exim and are
35639 described in this chapter. There is also the Exim Monitor, which is covered in
35640 the next chapter. The utilities described here are:
35641
35642 .itable none 0 0 3  7* left  15* left  40* left
35643 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35644   "list what Exim processes are doing"
35645 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35646 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35647 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35648 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35649                                                 various criteria"
35650 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35651 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35652   "extract statistics from the log"
35653 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35654   "check address acceptance from given IP"
35655 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35656 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35657 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35658 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35659 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35660 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35661 .endtable
35662
35663 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35664 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35665 &url(http://duncanthrax.net/exilog/) for details.
35666
35667
35668
35669
35670 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35671 .cindex "&'exiwhat'&"
35672 .cindex "process, querying"
35673 .cindex "SIGUSR1"
35674 On operating systems that can restart a system call after receiving a signal
35675 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35676 a line describing what it is doing to the file &_exim-process.info_& in the
35677 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35678 processes it can find, having first emptied the file. It then waits for one
35679 second to allow the Exim processes to react before displaying the results. In
35680 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35681 send the signal to the Exim processes, so it is normally run as root.
35682
35683 &*Warning*&: This is not an efficient process. It is intended for occasional
35684 use by system administrators. It is not sensible, for example, to set up a
35685 script that sends SIGUSR1 signals to Exim processes at short intervals.
35686
35687
35688 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35689 varies in different operating systems. Not only are different options used,
35690 but the format of the output is different. For this reason, there are some
35691 system configuration options that configure exactly how &'exiwhat'& works. If
35692 it doesn't seem to be working for you, check the following compile-time
35693 options:
35694 .display
35695 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35696 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35697 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35698 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35699 .endd
35700 An example of typical output from &'exiwhat'& is
35701 .code
35702 164 daemon: -q1h, listening on port 25
35703 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35704 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35705   [10.19.42.42] (editor@ref.example)
35706 10592 handling incoming call from [192.168.243.242]
35707 10628 accepting a local non-SMTP message
35708 .endd
35709 The first number in the output line is the process number. The third line has
35710 been split here, in order to fit it on the page.
35711
35712
35713
35714 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35715 .cindex "&'exiqgrep'&"
35716 .cindex "queue" "grepping"
35717 This utility is a Perl script contributed by Matt Hubbard. It runs
35718 .code
35719 exim -bpu
35720 .endd
35721 or (in case &*-a*& switch is specified)
35722 .code
35723 exim -bp
35724 .endd
35725 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35726 contain alternate exim configuration the queue management might be using.
35727
35728 to obtain a queue listing, and then greps the output to select messages 
35729 that match given criteria. The following selection options are available:
35730
35731 .vlist
35732 .vitem &*-f*&&~<&'regex'&>
35733 Match the sender address using a case-insensitive search. The field that is
35734 tested is enclosed in angle brackets, so you can test for bounce messages with
35735 .code
35736 exiqgrep -f '^<>$'
35737 .endd
35738 .vitem &*-r*&&~<&'regex'&>
35739 Match a recipient address using a case-insensitve search. The field that is
35740 tested is not enclosed in angle brackets.
35741
35742 .vitem &*-s*&&~<&'regex'&>
35743 Match against the size field.
35744
35745 .vitem &*-y*&&~<&'seconds'&>
35746 Match messages that are younger than the given time.
35747
35748 .vitem &*-o*&&~<&'seconds'&>
35749 Match messages that are older than the given time.
35750
35751 .vitem &*-z*&
35752 Match only frozen messages.
35753
35754 .vitem &*-x*&
35755 Match only non-frozen messages.
35756 .endlist
35757
35758 The following options control the format of the output:
35759
35760 .vlist
35761 .vitem &*-c*&
35762 Display only the count of matching messages.
35763
35764 .vitem &*-l*&
35765 Long format &-- display the full message information as output by Exim. This is
35766 the default.
35767
35768 .vitem &*-i*&
35769 Display message ids only.
35770
35771 .vitem &*-b*&
35772 Brief format &-- one line per message.
35773
35774 .vitem &*-R*&
35775 Display messages in reverse order.
35776
35777 .vitem &*-a*&
35778 Include delivered recipients in queue listing.
35779 .endlist
35780
35781 There is one more option, &%-h%&, which outputs a list of options.
35782
35783
35784
35785 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35786 .cindex "&'exiqsumm'&"
35787 .cindex "queue" "summary"
35788 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35789 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35790 running a command such as
35791 .code
35792 exim -bp | exiqsumm
35793 .endd
35794 The output consists of one line for each domain that has messages waiting for
35795 it, as in the following example:
35796 .code
35797 3   2322   74m   66m  msn.com.example
35798 .endd
35799 Each line lists the number of pending deliveries for a domain, their total
35800 volume, and the length of time that the oldest and the newest messages have
35801 been waiting. Note that the number of pending deliveries is greater than the
35802 number of messages when messages have more than one recipient.
35803
35804 A summary line is output at the end. By default the output is sorted on the
35805 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35806 the output to be sorted by oldest message and by count of messages,
35807 respectively. There are also three options that split the messages for each
35808 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35809 separates frozen messages, and &%-s%& separates messages according to their
35810 sender.
35811
35812 The output of &'exim -bp'& contains the original addresses in the message, so
35813 this also applies to the output from &'exiqsumm'&. No domains from addresses
35814 generated by aliasing or forwarding are included (unless the &%one_time%&
35815 option of the &(redirect)& router has been used to convert them into &"top
35816 level"& addresses).
35817
35818
35819
35820
35821 .section "Extracting specific information from the log (exigrep)" &&&
35822          "SECTextspeinf"
35823 .cindex "&'exigrep'&"
35824 .cindex "log" "extracts; grepping for"
35825 The &'exigrep'& utility is a Perl script that searches one or more main log
35826 files for entries that match a given pattern. When it finds a match, it
35827 extracts all the log entries for the relevant message, not just those that
35828 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35829 given message, or all mail for a given user, or for a given host, for example.
35830 The input files can be in Exim log format or syslog format.
35831 If a matching log line is not associated with a specific message, it is
35832 included in &'exigrep'&'s output without any additional lines. The usage is:
35833 .display
35834 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35835 .endd
35836 If no log file names are given on the command line, the standard input is read.
35837
35838 The &%-t%& argument specifies a number of seconds. It adds an additional
35839 condition for message selection. Messages that are complete are shown only if
35840 they spent more than <&'n'&> seconds on the queue.
35841
35842 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35843 makes it case-sensitive. This may give a performance improvement when searching
35844 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35845 option; with &%-I%& they do not. In both cases it is possible to change the
35846 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35847
35848 The &%-l%& option means &"literal"&, that is, treat all characters in the
35849 pattern as standing for themselves. Otherwise the pattern must be a Perl
35850 regular expression.
35851
35852 The &%-v%& option inverts the matching condition. That is, a line is selected
35853 if it does &'not'& match the pattern.
35854
35855 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35856 that are generated as a result/response to a message that &'exigrep'& matched
35857 normally.
35858
35859 Example of &%-M%&:
35860 user_a sends a message to user_b, which generates a bounce back to user_b. If
35861 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35862 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35863 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35864 when searching for &"user_a"& will show both messages since the bounce is
35865 &"related"& to or a &"result"& of the first message that was found by the
35866 search term.
35867
35868 If the location of a &'zcat'& command is known from the definition of
35869 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35870 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35871 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
35872 autodetection of some well known compression extensions.
35873
35874
35875 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35876 .cindex "&'exipick'&"
35877 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35878 lists messages from the queue according to a variety of criteria. For details
35879 of &'exipick'&'s facilities, visit the web page at
35880 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35881 the &%--help%& option.
35882
35883
35884 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35885 .cindex "log" "cycling local files"
35886 .cindex "cycling logs"
35887 .cindex "&'exicyclog'&"
35888 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35889 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35890 you are using log files with datestamps in their names (see section
35891 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35892 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35893 There are two command line options for &'exicyclog'&:
35894 .ilist
35895 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35896 default that is set when Exim is built. The default default is 10.
35897 .next
35898 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35899 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35900 overriding the script's default, which is to find the setting from Exim's
35901 configuration.
35902 .endlist
35903
35904 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35905 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35906 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35907 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35908 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35909 logs are handled similarly.
35910
35911 If the limit is greater than 99, the script uses 3-digit numbers such as
35912 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35913 to one that is greater, or &'vice versa'&, you will have to fix the names of
35914 any existing log files.
35915
35916 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35917 the end are deleted. All files with numbers greater than 01 are compressed,
35918 using a compression command which is configured by the COMPRESS_COMMAND
35919 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35920 root &%crontab%& entry of the form
35921 .code
35922 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35923 .endd
35924 assuming you have used the name &"exim"& for the Exim user. You can run
35925 &'exicyclog'& as root if you wish, but there is no need.
35926
35927
35928
35929 .section "Mail statistics (eximstats)" "SECTmailstat"
35930 .cindex "statistics"
35931 .cindex "&'eximstats'&"
35932 A Perl script called &'eximstats'& is provided for extracting statistical
35933 information from log files. The output is either plain text, or HTML.
35934 Exim log files are also supported by the &'Lire'& system produced by the
35935 LogReport Foundation &url(http://www.logreport.org).
35936
35937 The &'eximstats'& script has been hacked about quite a bit over time. The
35938 latest version is the result of some extensive revision by Steve Campbell. A
35939 lot of information is given by default, but there are options for suppressing
35940 various parts of it. Following any options, the arguments to the script are a
35941 list of files, which should be main log files. For example:
35942 .code
35943 eximstats -nr /var/spool/exim/log/mainlog.01
35944 .endd
35945 By default, &'eximstats'& extracts information about the number and volume of
35946 messages received from or delivered to various hosts. The information is sorted
35947 both by message count and by volume, and the top fifty hosts in each category
35948 are listed on the standard output. Similar information, based on email
35949 addresses or domains instead of hosts can be requested by means of various
35950 options. For messages delivered and received locally, similar statistics are
35951 also produced per user.
35952
35953 The output also includes total counts and statistics about delivery errors, and
35954 histograms showing the number of messages received and deliveries made in each
35955 hour of the day. A delivery with more than one address in its envelope (for
35956 example, an SMTP transaction with more than one RCPT command) is counted
35957 as a single delivery by &'eximstats'&.
35958
35959 Though normally more deliveries than receipts are reported (as messages may
35960 have multiple recipients), it is possible for &'eximstats'& to report more
35961 messages received than delivered, even though the queue is empty at the start
35962 and end of the period in question. If an incoming message contains no valid
35963 recipients, no deliveries are recorded for it. A bounce message is handled as
35964 an entirely separate message.
35965
35966 &'eximstats'& always outputs a grand total summary giving the volume and number
35967 of messages received and deliveries made, and the number of hosts involved in
35968 each case. It also outputs the number of messages that were delayed (that is,
35969 not completely delivered at the first attempt), and the number that had at
35970 least one address that failed.
35971
35972 The remainder of the output is in sections that can be independently disabled
35973 or modified by various options. It consists of a summary of deliveries by
35974 transport, histograms of messages received and delivered per time interval
35975 (default per hour), information about the time messages spent on the queue,
35976 a list of relayed messages, lists of the top fifty sending hosts, local
35977 senders, destination hosts, and destination local users by count and by volume,
35978 and a list of delivery errors that occurred.
35979
35980 The relay information lists messages that were actually relayed, that is, they
35981 came from a remote host and were directly delivered to some other remote host,
35982 without being processed (for example, for aliasing or forwarding) locally.
35983
35984 There are quite a few options for &'eximstats'& to control exactly what it
35985 outputs. These are documented in the Perl script itself, and can be extracted
35986 by running the command &(perldoc)& on the script. For example:
35987 .code
35988 perldoc /usr/exim/bin/eximstats
35989 .endd
35990
35991 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35992 .cindex "&'exim_checkaccess'&"
35993 .cindex "policy control" "checking access"
35994 .cindex "checking access"
35995 The &%-bh%& command line argument allows you to run a fake SMTP session with
35996 debugging output, in order to check what Exim is doing when it is applying
35997 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35998 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35999 sometimes you just want to answer the question &"Does this address have
36000 access?"& without bothering with any further details.
36001
36002 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36003 two arguments, an IP address and an email address:
36004 .code
36005 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36006 .endd
36007 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36008 given email address would be accepted in a RCPT command in a TCP/IP
36009 connection from the host with the given IP address. The output of the utility
36010 is either the word &"accepted"&, or the SMTP error response, for example:
36011 .code
36012 Rejected:
36013 550 Relay not permitted
36014 .endd
36015 When running this test, the utility uses &`<>`& as the envelope sender address
36016 for the MAIL command, but you can change this by providing additional
36017 options. These are passed directly to the Exim command. For example, to specify
36018 that the test is to be run with the sender address &'himself@there.example'&
36019 you can use:
36020 .code
36021 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36022                  -f himself@there.example
36023 .endd
36024 Note that these additional Exim command line items must be given after the two
36025 mandatory arguments.
36026
36027 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36028 while running its checks. You can run checks that include callouts by using
36029 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36030
36031
36032
36033 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36034 .cindex "DBM" "building dbm files"
36035 .cindex "building DBM files"
36036 .cindex "&'exim_dbmbuild'&"
36037 .cindex "lower casing"
36038 .cindex "binary zero" "in lookup key"
36039 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36040 the format used by the &(lsearch)& lookup (see section
36041 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36042 names as keys and the remainder of the information as data. The lower-casing
36043 can be prevented by calling the program with the &%-nolc%& option.
36044
36045 A terminating zero is included as part of the key string. This is expected by
36046 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36047 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36048 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36049 files.
36050
36051 The program requires two arguments: the name of the input file (which can be a
36052 single hyphen to indicate the standard input), and the name of the output file.
36053 It creates the output under a temporary name, and then renames it if all went
36054 well.
36055
36056 .cindex "USE_DB"
36057 If the native DB interface is in use (USE_DB is set in a compile-time
36058 configuration file &-- this is common in free versions of Unix) the two file
36059 names must be different, because in this mode the Berkeley DB functions create
36060 a single output file using exactly the name given. For example,
36061 .code
36062 exim_dbmbuild /etc/aliases /etc/aliases.db
36063 .endd
36064 reads the system alias file and creates a DBM version of it in
36065 &_/etc/aliases.db_&.
36066
36067 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36068 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36069 environment, the suffixes are added to the second argument of
36070 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36071 when the Berkeley functions are used in compatibility mode (though this is not
36072 recommended), because in that case it adds a &_.db_& suffix to the file name.
36073
36074 If a duplicate key is encountered, the program outputs a warning, and when it
36075 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36076 option is used. By default, only the first of a set of duplicates is used &--
36077 this makes it compatible with &(lsearch)& lookups. There is an option
36078 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36079 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36080 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36081 return code is 2.
36082
36083
36084
36085
36086 .section "Finding individual retry times (exinext)" "SECTfinindret"
36087 .cindex "retry" "times"
36088 .cindex "&'exinext'&"
36089 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36090 fish specific information out of the retry database. Given a mail domain (or a
36091 complete address), it looks up the hosts for that domain, and outputs any retry
36092 information for the hosts or for the domain. At present, the retry information
36093 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36094 output. For example:
36095 .code
36096 $ exinext piglet@milne.fict.example
36097 kanga.milne.example:192.168.8.1 error 146: Connection refused
36098   first failed: 21-Feb-1996 14:57:34
36099   last tried:   21-Feb-1996 14:57:34
36100   next try at:  21-Feb-1996 15:02:34
36101 roo.milne.example:192.168.8.3 error 146: Connection refused
36102   first failed: 20-Jan-1996 13:12:08
36103   last tried:   21-Feb-1996 11:42:03
36104   next try at:  21-Feb-1996 19:42:03
36105   past final cutoff time
36106 .endd
36107 You can also give &'exinext'& a local part, without a domain, and it
36108 will give any retry information for that local part in your default domain.
36109 A message id can be used to obtain retry information pertaining to a specific
36110 message. This exists only when an attempt to deliver a message to a remote host
36111 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36112 &'exinext'& is not particularly efficient, but then it is not expected to be
36113 run very often.
36114
36115 The &'exinext'& utility calls Exim to find out information such as the location
36116 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36117 passed on to the &'exim'& commands. The first specifies an alternate Exim
36118 configuration file, and the second sets macros for use within the configuration
36119 file. These features are mainly to help in testing, but might also be useful in
36120 environments where more than one configuration file is in use.
36121
36122
36123
36124 .section "Hints database maintenance" "SECThindatmai"
36125 .cindex "hints database" "maintenance"
36126 .cindex "maintaining Exim's hints database"
36127 Three utility programs are provided for maintaining the DBM files that Exim
36128 uses to contain its delivery hint information. Each program requires two
36129 arguments. The first specifies the name of Exim's spool directory, and the
36130 second is the name of the database it is to operate on. These are as follows:
36131
36132 .ilist
36133 &'retry'&: the database of retry information
36134 .next
36135 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36136 for remote hosts
36137 .next
36138 &'callout'&: the callout cache
36139 .next
36140 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36141 .next
36142 &'misc'&: other hints data
36143 .endlist
36144
36145 The &'misc'& database is used for
36146
36147 .ilist
36148 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36149 .next
36150 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36151 &(smtp)& transport)
36152 .endlist
36153
36154
36155
36156 .section "exim_dumpdb" "SECID261"
36157 .cindex "&'exim_dumpdb'&"
36158 The entire contents of a database are written to the standard output by the
36159 &'exim_dumpdb'& program, which has no options or arguments other than the
36160 spool and database names. For example, to dump the retry database:
36161 .code
36162 exim_dumpdb /var/spool/exim retry
36163 .endd
36164 Two lines of output are produced for each entry:
36165 .code
36166 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36167 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36168 .endd
36169 The first item on the first line is the key of the record. It starts with one
36170 of the letters R, or T, depending on whether it refers to a routing or
36171 transport retry. For a local delivery, the next part is the local address; for
36172 a remote delivery it is the name of the remote host, followed by its failing IP
36173 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36174 transport). If the remote port is not the standard one (port 25), it is added
36175 to the IP address. Then there follows an error code, an additional error code,
36176 and a textual description of the error.
36177
36178 The three times on the second line are the time of first failure, the time of
36179 the last delivery attempt, and the computed time for the next attempt. The line
36180 ends with an asterisk if the cutoff time for the last retry rule has been
36181 exceeded.
36182
36183 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36184 consists of a host name followed by a list of ids for messages that are or were
36185 waiting to be delivered to that host. If there are a very large number for any
36186 one host, continuation records, with a sequence number added to the host name,
36187 may be seen. The data in these records is often out of date, because a message
36188 may be routed to several alternative hosts, and Exim makes no effort to keep
36189 cross-references.
36190
36191
36192
36193 .section "exim_tidydb" "SECID262"
36194 .cindex "&'exim_tidydb'&"
36195 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36196 database. If run with no options, it removes all records that are more than 30
36197 days old. The age is calculated from the date and time that the record was last
36198 updated. Note that, in the case of the retry database, it is &'not'& the time
36199 since the first delivery failure. Information about a host that has been down
36200 for more than 30 days will remain in the database, provided that the record is
36201 updated sufficiently often.
36202
36203 The cutoff date can be altered by means of the &%-t%& option, which must be
36204 followed by a time. For example, to remove all records older than a week from
36205 the retry database:
36206 .code
36207 exim_tidydb -t 7d /var/spool/exim retry
36208 .endd
36209 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36210 message ids. In the former these appear as data in records keyed by host &--
36211 they were messages that were waiting for that host &-- and in the latter they
36212 are the keys for retry information for messages that have suffered certain
36213 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36214 message ids in database records are those of messages that are still on the
36215 queue. Message ids for messages that no longer exist are removed from
36216 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36217 For the &'retry'& database, records whose keys are non-existent message ids are
36218 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36219 whenever it removes information from the database.
36220
36221 Certain records are automatically removed by Exim when they are no longer
36222 needed, but others are not. For example, if all the MX hosts for a domain are
36223 down, a retry record is created for each one. If the primary MX host comes back
36224 first, its record is removed when Exim successfully delivers to it, but the
36225 records for the others remain because Exim has not tried to use those hosts.
36226
36227 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36228 hints databases. You should do this at a quiet time of day, because it requires
36229 a database to be locked (and therefore inaccessible to Exim) while it does its
36230 work. Removing records from a DBM file does not normally make the file smaller,
36231 but all the common DBM libraries are able to re-use the space that is released.
36232 After an initial phase of increasing in size, the databases normally reach a
36233 point at which they no longer get any bigger, as long as they are regularly
36234 tidied.
36235
36236 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36237 databases is likely to keep on increasing.
36238
36239
36240
36241
36242 .section "exim_fixdb" "SECID263"
36243 .cindex "&'exim_fixdb'&"
36244 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36245 Its main use is for testing Exim, but it might also be occasionally useful for
36246 getting round problems in a live system. It has no options, and its interface
36247 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36248 key of a database record can then be entered, and the data for that record is
36249 displayed.
36250
36251 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36252 except the &'retry'& database, that is the only operation that can be carried
36253 out. For the &'retry'& database, each field is output preceded by a number, and
36254 data for individual fields can be changed by typing the field number followed
36255 by new data, for example:
36256 .code
36257 > 4 951102:1000
36258 .endd
36259 resets the time of the next delivery attempt. Time values are given as a
36260 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36261 used as optional separators.
36262
36263
36264
36265
36266 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36267 .cindex "mailbox" "maintenance"
36268 .cindex "&'exim_lock'&"
36269 .cindex "locking mailboxes"
36270 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36271 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36272 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36273 a user agent while investigating a problem. The utility requires the name of
36274 the file as its first argument. If the locking is successful, the second
36275 argument is run as a command (using C's &[system()]& function); if there is no
36276 second argument, the value of the SHELL environment variable is used; if this
36277 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36278 is unlocked and the utility ends. The following options are available:
36279
36280 .vlist
36281 .vitem &%-fcntl%&
36282 Use &[fcntl()]& locking on the open mailbox.
36283
36284 .vitem &%-flock%&
36285 Use &[flock()]& locking on the open mailbox, provided the operating system
36286 supports it.
36287
36288 .vitem &%-interval%&
36289 This must be followed by a number, which is a number of seconds; it sets the
36290 interval to sleep between retries (default 3).
36291
36292 .vitem &%-lockfile%&
36293 Create a lock file before opening the mailbox.
36294
36295 .vitem &%-mbx%&
36296 Lock the mailbox using MBX rules.
36297
36298 .vitem &%-q%&
36299 Suppress verification output.
36300
36301 .vitem &%-retries%&
36302 This must be followed by a number; it sets the number of times to try to get
36303 the lock (default 10).
36304
36305 .vitem &%-restore_time%&
36306 This option causes &%exim_lock%& to restore the modified and read times to the
36307 locked file before exiting. This allows you to access a locked mailbox (for
36308 example, to take a backup copy) without disturbing the times that the user
36309 subsequently sees.
36310
36311 .vitem &%-timeout%&
36312 This must be followed by a number, which is a number of seconds; it sets a
36313 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36314 default), a non-blocking call is used.
36315
36316 .vitem &%-v%&
36317 Generate verbose output.
36318 .endlist
36319
36320 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36321 default is to create a lock file and also to use &[fcntl()]& locking on the
36322 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36323 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36324 requires that the directory containing the file be writeable. Locking by lock
36325 file does not last for ever; Exim assumes that a lock file is expired if it is
36326 more than 30 minutes old.
36327
36328 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36329 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36330 to be taken out on the open mailbox, and an exclusive lock on the file
36331 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36332 number of the mailbox file. When the locking is released, if an exclusive lock
36333 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36334
36335 The default output contains verification of the locking that takes place. The
36336 &%-v%& option causes some additional information to be given. The &%-q%& option
36337 suppresses all output except error messages.
36338
36339 A command such as
36340 .code
36341 exim_lock /var/spool/mail/spqr
36342 .endd
36343 runs an interactive shell while the file is locked, whereas
36344 .display
36345 &`exim_lock -q /var/spool/mail/spqr <<End`&
36346 <&'some commands'&>
36347 &`End`&
36348 .endd
36349 runs a specific non-interactive sequence of commands while the file is locked,
36350 suppressing all verification output. A single command can be run by a command
36351 such as
36352 .code
36353 exim_lock -q /var/spool/mail/spqr \
36354   "cp /var/spool/mail/spqr /some/where"
36355 .endd
36356 Note that if a command is supplied, it must be entirely contained within the
36357 second argument &-- hence the quotes.
36358 .ecindex IIDutils
36359
36360
36361 . ////////////////////////////////////////////////////////////////////////////
36362 . ////////////////////////////////////////////////////////////////////////////
36363
36364 .chapter "The Exim monitor" "CHAPeximon"
36365 .scindex IIDeximon "Exim monitor" "description"
36366 .cindex "X-windows"
36367 .cindex "&'eximon'&"
36368 .cindex "Local/eximon.conf"
36369 .cindex "&_exim_monitor/EDITME_&"
36370 The Exim monitor is an application which displays in an X window information
36371 about the state of Exim's queue and what Exim is doing. An admin user can
36372 perform certain operations on messages from this GUI interface; however all
36373 such facilities are also available from the command line, and indeed, the
36374 monitor itself makes use of the command line to perform any actions requested.
36375
36376
36377
36378 .section "Running the monitor" "SECID264"
36379 The monitor is started by running the script called &'eximon'&. This is a shell
36380 script that sets up a number of environment variables, and then runs the
36381 binary called &_eximon.bin_&. The default appearance of the monitor window can
36382 be changed by editing the &_Local/eximon.conf_& file created by editing
36383 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36384 parameters are for.
36385
36386 The parameters that get built into the &'eximon'& script can be overridden for
36387 a particular invocation by setting up environment variables of the same names,
36388 preceded by &`EXIMON_`&. For example, a shell command such as
36389 .code
36390 EXIMON_LOG_DEPTH=400 eximon
36391 .endd
36392 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36393 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36394 overrides the Exim log file configuration. This makes it possible to have
36395 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36396 syslog messages are routed to a file on the local host.
36397
36398 X resources can be used to change the appearance of the window in the normal
36399 way. For example, a resource setting of the form
36400 .code
36401 Eximon*background: gray94
36402 .endd
36403 changes the colour of the background to light grey rather than white. The
36404 stripcharts are drawn with both the data lines and the reference lines in
36405 black. This means that the reference lines are not visible when on top of the
36406 data. However, their colour can be changed by setting a resource called
36407 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36408 For example, if your X server is running Unix, you could set up lighter
36409 reference lines in the stripcharts by obeying
36410 .code
36411 xrdb -merge <<End
36412 Eximon*highlight: gray
36413 End
36414 .endd
36415 .cindex "admin user"
36416 In order to see the contents of messages on the queue, and to operate on them,
36417 &'eximon'& must either be run as root or by an admin user.
36418
36419 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36420 contain X11 resource parameters interpreted by the X11 library.  In addition,
36421 if the first parameter starts with the string "gdb" then it is removed and the
36422 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36423 versioned variants of gdb can be invoked).
36424
36425 The monitor's window is divided into three parts. The first contains one or
36426 more stripcharts and two action buttons, the second contains a &"tail"& of the
36427 main log file, and the third is a display of the queue of messages awaiting
36428 delivery, with two more action buttons. The following sections describe these
36429 different parts of the display.
36430
36431
36432
36433
36434 .section "The stripcharts" "SECID265"
36435 .cindex "stripchart"
36436 The first stripchart is always a count of messages on the queue. Its name can
36437 be configured by setting QUEUE_STRIPCHART_NAME in the
36438 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36439 configuration script by regular expression matches on log file entries, making
36440 it possible to display, for example, counts of messages delivered to certain
36441 hosts or using certain transports. The supplied defaults display counts of
36442 received and delivered messages, and of local and SMTP deliveries. The default
36443 period between stripchart updates is one minute; this can be adjusted by a
36444 parameter in the &_Local/eximon.conf_& file.
36445
36446 The stripchart displays rescale themselves automatically as the value they are
36447 displaying changes. There are always 10 horizontal lines in each chart; the
36448 title string indicates the value of each division when it is greater than one.
36449 For example, &"x2"& means that each division represents a value of 2.
36450
36451 It is also possible to have a stripchart which shows the percentage fullness of
36452 a particular disk partition, which is useful when local deliveries are confined
36453 to a single partition.
36454
36455 .cindex "&%statvfs%& function"
36456 This relies on the availability of the &[statvfs()]& function or equivalent in
36457 the operating system. Most, but not all versions of Unix that support Exim have
36458 this. For this particular stripchart, the top of the chart always represents
36459 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36460 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36461 &_Local/eximon.conf_& file.
36462
36463
36464
36465
36466 .section "Main action buttons" "SECID266"
36467 .cindex "size" "of monitor window"
36468 .cindex "Exim monitor" "window size"
36469 .cindex "window size"
36470 Below the stripcharts there is an action button for quitting the monitor. Next
36471 to this is another button marked &"Size"&. They are placed here so that
36472 shrinking the window to its default minimum size leaves just the queue count
36473 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36474 the window to expand to its maximum size, unless it is already at the maximum,
36475 in which case it is reduced to its minimum.
36476
36477 When expanding to the maximum, if the window cannot be fully seen where it
36478 currently is, it is moved back to where it was the last time it was at full
36479 size. When it is expanding from its minimum size, the old position is
36480 remembered, and next time it is reduced to the minimum it is moved back there.
36481
36482 The idea is that you can keep a reduced window just showing one or two
36483 stripcharts at a convenient place on your screen, easily expand it to show
36484 the full window when required, and just as easily put it back to what it was.
36485 The idea is copied from what the &'twm'& window manager does for its
36486 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36487 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36488
36489 Normally, the monitor starts up with the window at its full size, but it can be
36490 built so that it starts up with the window at its smallest size, by setting
36491 START_SMALL=yes in &_Local/eximon.conf_&.
36492
36493
36494
36495 .section "The log display" "SECID267"
36496 .cindex "log" "tail of; in monitor"
36497 The second section of the window is an area in which a display of the tail of
36498 the main log is maintained.
36499 To save space on the screen, the timestamp on each log line is shortened by
36500 removing the date and, if &%log_timezone%& is set, the timezone.
36501 The log tail is not available when the only destination for logging data is
36502 syslog, unless the syslog lines are routed to a local file whose name is passed
36503 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36504
36505 The log sub-window has a scroll bar at its lefthand side which can be used to
36506 move back to look at earlier text, and the up and down arrow keys also have a
36507 scrolling effect. The amount of log that is kept depends on the setting of
36508 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36509 to use. When this is full, the earlier 50% of data is discarded &-- this is
36510 much more efficient than throwing it away line by line. The sub-window also has
36511 a horizontal scroll bar for accessing the ends of long log lines. This is the
36512 only means of horizontal scrolling; the right and left arrow keys are not
36513 available. Text can be cut from this part of the window using the mouse in the
36514 normal way. The size of this subwindow is controlled by parameters in the
36515 configuration file &_Local/eximon.conf_&.
36516
36517 Searches of the text in the log window can be carried out by means of the ^R
36518 and ^S keystrokes, which default to a reverse and a forward search,
36519 respectively. The search covers only the text that is displayed in the window.
36520 It cannot go further back up the log.
36521
36522 The point from which the search starts is indicated by a caret marker. This is
36523 normally at the end of the text in the window, but can be positioned explicitly
36524 by pointing and clicking with the left mouse button, and is moved automatically
36525 by a successful search. If new text arrives in the window when it is scrolled
36526 back, the caret remains where it is, but if the window is not scrolled back,
36527 the caret is moved to the end of the new text.
36528
36529 Pressing ^R or ^S pops up a window into which the search text can be typed.
36530 There are buttons for selecting forward or reverse searching, for carrying out
36531 the search, and for cancelling. If the &"Search"& button is pressed, the search
36532 happens and the window remains so that further searches can be done. If the
36533 &"Return"& key is pressed, a single search is done and the window is closed. If
36534 ^C is typed the search is cancelled.
36535
36536 The searching facility is implemented using the facilities of the Athena text
36537 widget. By default this pops up a window containing both &"search"& and
36538 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36539 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36540 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36541 provided version of &%TextPop%& when the remaining parts of the text widget
36542 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36543 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36544 on these systems, at the expense of having unwanted items in the search popup
36545 window.
36546
36547
36548
36549 .section "The queue display" "SECID268"
36550 .cindex "queue" "display in monitor"
36551 The bottom section of the monitor window contains a list of all messages that
36552 are on the queue, which includes those currently being received or delivered,
36553 as well as those awaiting delivery. The size of this subwindow is controlled by
36554 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36555 at which it is updated is controlled by another parameter in the same file &--
36556 the default is 5 minutes, since queue scans can be quite expensive. However,
36557 there is an &"Update"& action button just above the display which can be used
36558 to force an update of the queue display at any time.
36559
36560 When a host is down for some time, a lot of pending mail can build up for it,
36561 and this can make it hard to deal with other messages on the queue. To help
36562 with this situation there is a button next to &"Update"& called &"Hide"&. If
36563 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36564 type anything in here and press &"Return"&, the text is added to a chain of
36565 such texts, and if every undelivered address in a message matches at least one
36566 of the texts, the message is not displayed.
36567
36568 If there is an address that does not match any of the texts, all the addresses
36569 are displayed as normal. The matching happens on the ends of addresses so, for
36570 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36571 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36572 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36573 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36574 a hide request is automatically cancelled after one hour.
36575
36576 While the dialogue box is displayed, you can't press any buttons or do anything
36577 else to the monitor window. For this reason, if you want to cut text from the
36578 queue display to use in the dialogue box, you have to do the cutting before
36579 pressing the &"Hide"& button.
36580
36581 The queue display contains, for each unhidden queued message, the length of
36582 time it has been on the queue, the size of the message, the message id, the
36583 message sender, and the first undelivered recipient, all on one line. If it is
36584 a bounce message, the sender is shown as &"<>"&. If there is more than one
36585 recipient to which the message has not yet been delivered, subsequent ones are
36586 listed on additional lines, up to a maximum configured number, following which
36587 an ellipsis is displayed. Recipients that have already received the message are
36588 not shown.
36589
36590 .cindex "frozen messages" "display"
36591 If a message is frozen, an asterisk is displayed at the left-hand side.
36592
36593 The queue display has a vertical scroll bar, and can also be scrolled by means
36594 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36595 The text searching facilities, as described above for the log window, are also
36596 available, but the caret is always moved to the end of the text when the queue
36597 display is updated.
36598
36599
36600
36601 .section "The queue menu" "SECID269"
36602 .cindex "queue" "menu in monitor"
36603 If the &%shift%& key is held down and the left button is clicked when the mouse
36604 pointer is over the text for any message, an action menu pops up, and the first
36605 line of the queue display for the message is highlighted. This does not affect
36606 any selected text.
36607
36608 If you want to use some other event for popping up the menu, you can set the
36609 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36610 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36611 value set in this parameter is a standard X event description. For example, to
36612 run eximon using &%ctrl%& rather than &%shift%& you could use
36613 .code
36614 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36615 .endd
36616 The title of the menu is the message id, and it contains entries which act as
36617 follows:
36618
36619 .ilist
36620 &'message log'&: The contents of the message log for the message are displayed
36621 in a new text window.
36622 .next
36623 &'headers'&: Information from the spool file that contains the envelope
36624 information and headers is displayed in a new text window. See chapter
36625 &<<CHAPspool>>& for a description of the format of spool files.
36626 .next
36627 &'body'&: The contents of the spool file containing the body of the message are
36628 displayed in a new text window. There is a default limit of 20,000 bytes to the
36629 amount of data displayed. This can be changed by setting the BODY_MAX
36630 option at compile time, or the EXIMON_BODY_MAX option at run time.
36631 .next
36632 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36633 delivery of the message. This causes an automatic thaw if the message is
36634 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36635 a new text window. The delivery is run in a separate process, to avoid holding
36636 up the monitor while the delivery proceeds.
36637 .next
36638 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36639 that the message be frozen.
36640 .next
36641 .cindex "thawing messages"
36642 .cindex "unfreezing messages"
36643 .cindex "frozen messages" "thawing"
36644 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36645 that the message be thawed.
36646 .next
36647 .cindex "delivery" "forcing failure"
36648 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36649 that Exim gives up trying to deliver the message. A bounce message is generated
36650 for any remaining undelivered addresses.
36651 .next
36652 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36653 that the message be deleted from the system without generating a bounce
36654 message.
36655 .next
36656 &'add recipient'&: A dialog box is displayed into which a recipient address can
36657 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36658 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36659 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36660 causes a call to Exim to be made using the &%-Mar%& option to request that an
36661 additional recipient be added to the message, unless the entry box is empty, in
36662 which case no action is taken.
36663 .next
36664 &'mark delivered'&: A dialog box is displayed into which a recipient address
36665 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36666 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36667 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36668 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36669 recipient address as already delivered, unless the entry box is empty, in which
36670 case no action is taken.
36671 .next
36672 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36673 mark all recipient addresses as already delivered.
36674 .next
36675 &'edit sender'&: A dialog box is displayed initialized with the current
36676 sender's address. Pressing RETURN causes a call to Exim to be made using the
36677 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36678 in which case no action is taken. If you want to set an empty sender (as in
36679 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36680 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36681 the address is qualified with that domain.
36682 .endlist
36683
36684 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36685 other cases when a call to Exim is made, if there is any output from Exim (in
36686 particular, if the command fails) a window containing the command and the
36687 output is displayed. Otherwise, the results of the action are normally apparent
36688 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36689 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36690 if no output is generated.
36691
36692 The queue display is automatically updated for actions such as freezing and
36693 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36694 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36695 force an update of the display after one of these actions.
36696
36697 In any text window that is displayed as result of a menu action, the normal
36698 cut-and-paste facility is available, and searching can be carried out using ^R
36699 and ^S, as described above for the log tail window.
36700 .ecindex IIDeximon
36701
36702
36703
36704
36705
36706 . ////////////////////////////////////////////////////////////////////////////
36707 . ////////////////////////////////////////////////////////////////////////////
36708
36709 .chapter "Security considerations" "CHAPsecurity"
36710 .scindex IIDsecurcon "security" "discussion of"
36711 This chapter discusses a number of issues concerned with security, some of
36712 which are also covered in other parts of this manual.
36713
36714 For reasons that this author does not understand, some people have promoted
36715 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36716 existence of this chapter in the documentation. However, the intent of the
36717 chapter is simply to describe the way Exim works in relation to certain
36718 security concerns, not to make any specific claims about the effectiveness of
36719 its security as compared with other MTAs.
36720
36721 What follows is a description of the way Exim is supposed to be. Best efforts
36722 have been made to try to ensure that the code agrees with the theory, but an
36723 absence of bugs can never be guaranteed. Any that are reported will get fixed
36724 as soon as possible.
36725
36726
36727 .section "Building a more &""hardened""& Exim" "SECID286"
36728 .cindex "security" "build-time features"
36729 There are a number of build-time options that can be set in &_Local/Makefile_&
36730 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36731 Exim administrator who does not have the root password, or by someone who has
36732 penetrated the Exim (but not the root) account. These options are as follows:
36733
36734 .ilist
36735 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36736 start of any file names used with the &%-C%& option. When it is set, these file
36737 names are also not allowed to contain the sequence &"/../"&. (However, if the
36738 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36739 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36740 default setting for &%ALT_CONFIG_PREFIX%&.
36741
36742 If the permitted configuration files are confined to a directory to
36743 which only root has access, this guards against someone who has broken
36744 into the Exim account from running a privileged Exim with an arbitrary
36745 configuration file, and using it to break into other accounts.
36746 .next
36747
36748 If a non-trusted configuration file (i.e. not the default configuration file
36749 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36750 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36751 the next item), then root privilege is retained only if the caller of Exim is
36752 root. This locks out the possibility of testing a configuration using &%-C%&
36753 right through message reception and delivery, even if the caller is root. The
36754 reception works, but by that time, Exim is running as the Exim user, so when
36755 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36756 privilege to be lost. However, root can test reception and delivery using two
36757 separate commands.
36758
36759 .next
36760 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36761 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36762 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36763 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36764 the restrictive side.  Requiring build-time selection of safe macros is onerous
36765 but this option is intended solely as a transition mechanism to permit
36766 previously-working configurations to continue to work after release 4.73.
36767 .next
36768 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36769 is disabled.
36770 .next
36771 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36772 never to be used for any deliveries. This is like the &%never_users%& runtime
36773 option, but it cannot be overridden; the runtime option adds additional users
36774 to the list. The default setting is &"root"&; this prevents a non-root user who
36775 is permitted to modify the runtime file from using Exim as a way to get root.
36776 .endlist
36777
36778
36779
36780 .section "Root privilege" "SECID270"
36781 .cindex "setuid"
36782 .cindex "root privilege"
36783 The Exim binary is normally setuid to root, which means that it gains root
36784 privilege (runs as root) when it starts execution. In some special cases (for
36785 example, when the daemon is not in use and there are no local deliveries), it
36786 may be possible to run Exim setuid to some user other than root. This is
36787 discussed in the next section. However, in most installations, root privilege
36788 is required for two things:
36789
36790 .ilist
36791 To set up a socket connected to the standard SMTP port (25) when initialising
36792 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36793 not required.
36794 .next
36795 To be able to change uid and gid in order to read users' &_.forward_& files and
36796 perform local deliveries as the receiving user or as specified in the
36797 configuration.
36798 .endlist
36799
36800 It is not necessary to be root to do any of the other things Exim does, such as
36801 receiving messages and delivering them externally over SMTP, and it is
36802 obviously more secure if Exim does not run as root except when necessary.
36803 For this reason, a user and group for Exim to use must be defined in
36804 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36805 group"&. Their values can be changed by the run time configuration, though this
36806 is not recommended. Often a user called &'exim'& is used, but some sites use
36807 &'mail'& or another user name altogether.
36808
36809 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36810 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36811 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36812
36813 After a new Exim process has interpreted its command line options, it changes
36814 uid and gid in the following cases:
36815
36816 .ilist
36817 .oindex "&%-C%&"
36818 .oindex "&%-D%&"
36819 If the &%-C%& option is used to specify an alternate configuration file, or if
36820 the &%-D%& option is used to define macro values for the configuration, and the
36821 calling process is not running as root, the uid and gid are changed to those of
36822 the calling process.
36823 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36824 option may not be used at all.
36825 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36826 can be supplied if the calling process is running as root, the Exim run-time
36827 user or CONFIGURE_OWNER, if defined.
36828 .next
36829 .oindex "&%-be%&"
36830 .oindex "&%-bf%&"
36831 .oindex "&%-bF%&"
36832 If the expansion test option (&%-be%&) or one of the filter testing options
36833 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36834 calling process.
36835 .next
36836 If the process is not a daemon process or a queue runner process or a delivery
36837 process or a process for testing address routing (started with &%-bt%&), the
36838 uid and gid are changed to the Exim user and group. This means that Exim always
36839 runs under its own uid and gid when receiving messages. This also applies when
36840 testing address verification
36841 .oindex "&%-bv%&"
36842 .oindex "&%-bh%&"
36843 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36844 option).
36845 .next
36846 For a daemon, queue runner, delivery, or address testing process, the uid
36847 remains as root at this stage, but the gid is changed to the Exim group.
36848 .endlist
36849
36850 The processes that initially retain root privilege behave as follows:
36851
36852 .ilist
36853 A daemon process changes the gid to the Exim group and the uid to the Exim
36854 user after setting up one or more listening sockets. The &[initgroups()]&
36855 function is called, so that if the Exim user is in any additional groups, they
36856 will be used during message reception.
36857 .next
36858 A queue runner process retains root privilege throughout its execution. Its
36859 job is to fork a controlled sequence of delivery processes.
36860 .next
36861 A delivery process retains root privilege throughout most of its execution,
36862 but any actual deliveries (that is, the transports themselves) are run in
36863 subprocesses which always change to a non-root uid and gid. For local
36864 deliveries this is typically the uid and gid of the owner of the mailbox; for
36865 remote deliveries, the Exim uid and gid are used. Once all the delivery
36866 subprocesses have been run, a delivery process changes to the Exim uid and gid
36867 while doing post-delivery tidying up such as updating the retry database and
36868 generating bounce and warning messages.
36869
36870 While the recipient addresses in a message are being routed, the delivery
36871 process runs as root. However, if a user's filter file has to be processed,
36872 this is done in a subprocess that runs under the individual user's uid and
36873 gid. A system filter is run as root unless &%system_filter_user%& is set.
36874 .next
36875 A process that is testing addresses (the &%-bt%& option) runs as root so that
36876 the routing is done in the same environment as a message delivery.
36877 .endlist
36878
36879
36880
36881
36882 .section "Running Exim without privilege" "SECTrunexiwitpri"
36883 .cindex "privilege, running without"
36884 .cindex "unprivileged running"
36885 .cindex "root privilege" "running without"
36886 Some installations like to run Exim in an unprivileged state for more of its
36887 operation, for added security. Support for this mode of operation is provided
36888 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36889 gid are changed to the Exim user and group at the start of a delivery process
36890 (and also queue runner and address testing processes). This means that address
36891 routing is no longer run as root, and the deliveries themselves cannot change
36892 to any other uid.
36893
36894 .cindex SIGHUP
36895 .cindex "daemon" "restarting"
36896 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36897 that the daemon can still be started in the usual way, and it can respond
36898 correctly to SIGHUP because the re-invocation regains root privilege.
36899
36900 An alternative approach is to make Exim setuid to the Exim user and also setgid
36901 to the Exim group. If you do this, the daemon must be started from a root
36902 process. (Calling Exim from a root process makes it behave in the way it does
36903 when it is setuid root.) However, the daemon cannot restart itself after a
36904 SIGHUP signal because it cannot regain privilege.
36905
36906 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36907 stops Exim from trying to re-invoke itself to do a delivery after a message has
36908 been received. Such a re-invocation is a waste of resources because it has no
36909 effect.
36910
36911 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36912 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36913 to the Exim user seems a clean approach, but there is one complication:
36914
36915 In this style of operation, Exim is running with the real uid and gid set to
36916 those of the calling process, and the effective uid/gid set to Exim's values.
36917 Ideally, any association with the calling process' uid/gid should be dropped,
36918 that is, the real uid/gid should be reset to the effective values so as to
36919 discard any privileges that the caller may have. While some operating systems
36920 have a function that permits this action for a non-root effective uid, quite a
36921 number of them do not. Because of this lack of standardization, Exim does not
36922 address this problem at this time.
36923
36924 For this reason, the recommended approach for &"mostly unprivileged"& running
36925 is to keep the Exim binary setuid to root, and to set
36926 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36927 be used in the most straightforward way.
36928
36929 If you configure Exim not to run delivery processes as root, there are a
36930 number of restrictions on what you can do:
36931
36932 .ilist
36933 You can deliver only as the Exim user/group. You should  explicitly use the
36934 &%user%& and &%group%& options to override routers or local transports that
36935 normally deliver as the recipient. This makes sure that configurations that
36936 work in this mode function the same way in normal mode. Any implicit or
36937 explicit specification of another user causes an error.
36938 .next
36939 Use of &_.forward_& files is severely restricted, such that it is usually
36940 not worthwhile to include them in the configuration.
36941 .next
36942 Users who wish to use &_.forward_& would have to make their home directory and
36943 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36944 and their equivalents in Exim filters, cannot be used. While they could be
36945 enabled in the Exim user's name, that would be insecure and not very useful.
36946 .next
36947 Unless the local user mailboxes are all owned by the Exim user (possible in
36948 some POP3 or IMAP-only environments):
36949
36950 .olist
36951 They must be owned by the Exim group and be writeable by that group. This
36952 implies you must set &%mode%& in the appendfile configuration, as well as the
36953 mode of the mailbox files themselves.
36954 .next
36955 You must set &%no_check_owner%&, since most or all of the files will not be
36956 owned by the Exim user.
36957 .next
36958 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36959 on a newly created mailbox when unprivileged. This also implies that new
36960 mailboxes need to be created manually.
36961 .endlist olist
36962 .endlist ilist
36963
36964
36965 These restrictions severely restrict what can be done in local deliveries.
36966 However, there are no restrictions on remote deliveries. If you are running a
36967 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36968 gives more security at essentially no cost.
36969
36970 If you are using the &%mua_wrapper%& facility (see chapter
36971 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36972
36973
36974
36975
36976 .section "Delivering to local files" "SECID271"
36977 Full details of the checks applied by &(appendfile)& before it writes to a file
36978 are given in chapter &<<CHAPappendfile>>&.
36979
36980
36981
36982 .section "Running local commands" "SECTsecconslocalcmds"
36983 .cindex "security" "local commands"
36984 .cindex "security" "command injection attacks"
36985 There are a number of ways in which an administrator can configure Exim to run
36986 commands based upon received, untrustworthy, data. Further, in some
36987 configurations a user who can control a &_.forward_& file can also arrange to
36988 run commands. Configuration to check includes, but is not limited to:
36989
36990 .ilist
36991 Use of &%use_shell%& in the pipe transport: various forms of shell command
36992 injection may be possible with this option present. It is dangerous and should
36993 be used only with considerable caution. Consider constraints which whitelist
36994 allowed characters in a variable which is to be used in a pipe transport that
36995 has &%use_shell%& enabled.
36996 .next
36997 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36998 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36999 &_.forward_& files in a redirect router. If Exim is running on a central mail
37000 hub to which ordinary users do not have shell access, but home directories are
37001 NFS mounted (for instance) then administrators should review the list of these
37002 forbid options available, and should bear in mind that the options that may
37003 need forbidding can change as new features are added between releases.
37004 .next
37005 The &%${run...}%& expansion item does not use a shell by default, but
37006 administrators can configure use of &_/bin/sh_& as part of the command.
37007 Such invocations should be viewed with prejudicial suspicion.
37008 .next
37009 Administrators who use embedded Perl are advised to explore how Perl's
37010 taint checking might apply to their usage.
37011 .next
37012 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
37013 administrators are well advised to view its use with suspicion, in case (for
37014 instance) it allows a local-part to contain embedded Exim directives.
37015 .next
37016 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37017 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37018 each can reference arbitrary lists and files, rather than just being a list
37019 of opaque strings.
37020 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37021 real-world security vulnerabilities caused by its use with untrustworthy data
37022 injected in, for SQL injection attacks.
37023 Consider the use of the &%inlisti%& expansion condition instead.
37024 .endlist
37025
37026
37027
37028
37029 .section "Trust in configuration data" "SECTsecconfdata"
37030 .cindex "security" "data sources"
37031 .cindex "security" "regular expressions"
37032 .cindex "regular expressions" "security"
37033 .cindex "PCRE" "security"
37034 If configuration data for Exim can come from untrustworthy sources, there
37035 are some issues to be aware of:
37036
37037 .ilist
37038 Use of &%${expand...}%& may provide a path for shell injection attacks.
37039 .next
37040 Letting untrusted data provide a regular expression is unwise.
37041 .next
37042 Using &%${match...}%& to apply a fixed regular expression against untrusted
37043 data may result in pathological behaviour within PCRE.  Be aware of what
37044 "backtracking" means and consider options for being more strict with a regular
37045 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37046 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37047 possessive quantifiers or just not using regular expressions against untrusted
37048 data.
37049 .next
37050 It can be important to correctly use &%${quote:...}%&,
37051 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37052 items to ensure that data is correctly constructed.
37053 .next
37054 Some lookups might return multiple results, even though normal usage is only
37055 expected to yield one result.
37056 .endlist
37057
37058
37059
37060
37061 .section "IPv4 source routing" "SECID272"
37062 .cindex "source routing" "in IP packets"
37063 .cindex "IP source routing"
37064 Many operating systems suppress IP source-routed packets in the kernel, but
37065 some cannot be made to do this, so Exim does its own check. It logs incoming
37066 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37067 IPv6. No special checking is currently done.
37068
37069
37070
37071 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37072 Support for these SMTP commands is disabled by default. If required, they can
37073 be enabled by defining suitable ACLs.
37074
37075
37076
37077
37078 .section "Privileged users" "SECID274"
37079 .cindex "trusted users"
37080 .cindex "admin user"
37081 .cindex "privileged user"
37082 .cindex "user" "trusted"
37083 .cindex "user" "admin"
37084 Exim recognizes two sets of users with special privileges. Trusted users are
37085 able to submit new messages to Exim locally, but supply their own sender
37086 addresses and information about a sending host. For other users submitting
37087 local messages, Exim sets up the sender address from the uid, and doesn't
37088 permit a remote host to be specified.
37089
37090 .oindex "&%-f%&"
37091 However, an untrusted user is permitted to use the &%-f%& command line option
37092 in the special form &%-f <>%& to indicate that a delivery failure for the
37093 message should not cause an error report. This affects the message's envelope,
37094 but it does not affect the &'Sender:'& header. Untrusted users may also be
37095 permitted to use specific forms of address with the &%-f%& option by setting
37096 the &%untrusted_set_sender%& option.
37097
37098 Trusted users are used to run processes that receive mail messages from some
37099 other mail domain and pass them on to Exim for delivery either locally, or over
37100 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37101 as any user listed in the &%trusted_users%& configuration option, or under any
37102 group listed in the &%trusted_groups%& option.
37103
37104 Admin users are permitted to do things to the messages on Exim's queue. They
37105 can freeze or thaw messages, cause them to be returned to their senders, remove
37106 them entirely, or modify them in various ways. In addition, admin users can run
37107 the Exim monitor and see all the information it is capable of providing, which
37108 includes the contents of files on the spool.
37109
37110 .oindex "&%-M%&"
37111 .oindex "&%-q%&"
37112 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37113 delivery of messages on its queue is restricted to admin users. This
37114 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37115 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37116 queue is also restricted to admin users. This restriction can be relaxed by
37117 setting &%no_queue_list_requires_admin%&.
37118
37119 Exim recognizes an admin user if the calling process is running as root or as
37120 the Exim user or if any of the groups associated with the calling process is
37121 the Exim group. It is not necessary actually to be running under the Exim
37122 group. However, if admin users who are not root or the Exim user are to access
37123 the contents of files on the spool via the Exim monitor (which runs
37124 unprivileged), Exim must be built to allow group read access to its spool
37125 files.
37126
37127
37128
37129 .section "Spool files" "SECID275"
37130 .cindex "spool directory" "files"
37131 Exim's spool directory and everything it contains is owned by the Exim user and
37132 set to the Exim group. The mode for spool files is defined in the
37133 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37134 any user who is a member of the Exim group can access these files.
37135
37136
37137
37138 .section "Use of argv[0]" "SECID276"
37139 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37140 of specific strings, Exim assumes certain options. For example, calling Exim
37141 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37142 to calling it with the option &%-bS%&. There are no security implications in
37143 this.
37144
37145
37146
37147 .section "Use of %f formatting" "SECID277"
37148 The only use made of &"%f"& by Exim is in formatting load average values. These
37149 are actually stored in integer variables as 1000 times the load average.
37150 Consequently, their range is limited and so therefore is the length of the
37151 converted output.
37152
37153
37154
37155 .section "Embedded Exim path" "SECID278"
37156 Exim uses its own path name, which is embedded in the code, only when it needs
37157 to re-exec in order to regain root privilege. Therefore, it is not root when it
37158 does so. If some bug allowed the path to get overwritten, it would lead to an
37159 arbitrary program's being run as exim, not as root.
37160
37161
37162
37163 .section "Dynamic module directory" "SECTdynmoddir"
37164 Any dynamically loadable modules must be installed into the directory
37165 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37166 loading it.
37167
37168
37169 .section "Use of sprintf()" "SECID279"
37170 .cindex "&[sprintf()]&"
37171 A large number of occurrences of &"sprintf"& in the code are actually calls to
37172 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37173 The intermediate formatting is done into a large fixed buffer by a function
37174 that runs through the format string itself, and checks the length of each
37175 conversion before performing it, thus preventing buffer overruns.
37176
37177 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37178 the output buffer is known to be sufficiently long to contain the converted
37179 string.
37180
37181
37182
37183 .section "Use of debug_printf() and log_write()" "SECID280"
37184 Arbitrary strings are passed to both these functions, but they do their
37185 formatting by calling the function &'string_vformat()'&, which runs through
37186 the format string itself, and checks the length of each conversion.
37187
37188
37189
37190 .section "Use of strcat() and strcpy()" "SECID281"
37191 These are used only in cases where the output buffer is known to be large
37192 enough to hold the result.
37193 .ecindex IIDsecurcon
37194
37195
37196
37197
37198 . ////////////////////////////////////////////////////////////////////////////
37199 . ////////////////////////////////////////////////////////////////////////////
37200
37201 .chapter "Format of spool files" "CHAPspool"
37202 .scindex IIDforspo1 "format" "spool files"
37203 .scindex IIDforspo2 "spool directory" "format of files"
37204 .scindex IIDforspo3 "spool files" "format of"
37205 .cindex "spool files" "editing"
37206 A message on Exim's queue consists of two files, whose names are the message id
37207 followed by -D and -H, respectively. The data portion of the message is kept in
37208 the -D file on its own. The message's envelope, status, and headers are all
37209 kept in the -H file, whose format is described in this chapter. Each of these
37210 two files contains the final component of its own name as its first line. This
37211 is insurance against disk crashes where the directory is lost but the files
37212 themselves are recoverable.
37213
37214 Some people are tempted into editing -D files in order to modify messages. You
37215 need to be extremely careful if you do this; it is not recommended and you are
37216 on your own if you do it. Here are some of the pitfalls:
37217
37218 .ilist
37219 You must ensure that Exim does not try to deliver the message while you are
37220 fiddling with it. The safest way is to take out a write lock on the -D file,
37221 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37222 place, the lock will be retained. If you write a new file and rename it, the
37223 lock will be lost at the instant of rename.
37224 .next
37225 .vindex "&$body_linecount$&"
37226 If you change the number of lines in the file, the value of
37227 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37228 present, this value is not used by Exim, but there is no guarantee that this
37229 will always be the case.
37230 .next
37231 If the message is in MIME format, you must take care not to break it.
37232 .next
37233 If the message is cryptographically signed, any change will invalidate the
37234 signature.
37235 .endlist
37236 All in all, modifying -D files is fraught with danger.
37237
37238 Files whose names end with -J may also be seen in the &_input_& directory (or
37239 its subdirectories when &%split_spool_directory%& is set). These are journal
37240 files, used to record addresses to which the message has been delivered during
37241 the course of a delivery attempt. If there are still undelivered recipients at
37242 the end, the -H file is updated, and the -J file is deleted. If, however, there
37243 is some kind of crash (for example, a power outage) before this happens, the -J
37244 file remains in existence. When Exim next processes the message, it notices the
37245 -J file and uses it to update the -H file before starting the next delivery
37246 attempt.
37247
37248 .section "Format of the -H file" "SECID282"
37249 .cindex "uid (user id)" "in spool file"
37250 .cindex "gid (group id)" "in spool file"
37251 The second line of the -H file contains the login name for the uid of the
37252 process that called Exim to read the message, followed by the numerical uid and
37253 gid. For a locally generated message, this is normally the user who sent the
37254 message. For a message received over TCP/IP via the daemon, it is
37255 normally the Exim user.
37256
37257 The third line of the file contains the address of the message's sender as
37258 transmitted in the envelope, contained in angle brackets. The sender address is
37259 empty for bounce messages. For incoming SMTP mail, the sender address is given
37260 in the MAIL command. For locally generated mail, the sender address is
37261 created by Exim from the login name of the current user and the configured
37262 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37263 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37264 &"<>"& or an address that matches &%untrusted_set_senders%&.
37265
37266 The fourth line contains two numbers. The first is the time that the message
37267 was received, in the conventional Unix form &-- the number of seconds since the
37268 start of the epoch. The second number is a count of the number of messages
37269 warning of delayed delivery that have been sent to the sender.
37270
37271 There follow a number of lines starting with a hyphen. These can appear in any
37272 order, and are omitted when not relevant:
37273
37274 .vlist
37275 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37276 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37277 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37278 recognized, to provide backward compatibility. In the old format, a line of
37279 this form is present for every ACL variable that is not empty. The number
37280 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37281 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37282 the data string for the variable. The string itself starts at the beginning of
37283 the next line, and is followed by a newline character. It may contain internal
37284 newlines.
37285
37286 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37287 A line of this form is present for every ACL connection variable that is
37288 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37289 The length is the length of the data string for the variable. The string itself
37290 starts at the beginning of the next line, and is followed by a newline
37291 character. It may contain internal newlines.
37292
37293 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37294 A line of this form is present for every ACL message variable that is defined.
37295 Note that there is a space between &%-aclm%& and the rest of the name. The
37296 length is the length of the data string for the variable. The string itself
37297 starts at the beginning of the next line, and is followed by a newline
37298 character. It may contain internal newlines.
37299
37300 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37301 This is present if, when the message was received over SMTP, the value of
37302 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37303
37304 .vitem &%-allow_unqualified_recipient%&
37305 This is present if unqualified recipient addresses are permitted in header
37306 lines (to stop such addresses from being qualified if rewriting occurs at
37307 transport time). Local messages that were input using &%-bnq%& and remote
37308 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37309
37310 .vitem &%-allow_unqualified_sender%&
37311 This is present if unqualified sender addresses are permitted in header lines
37312 (to stop such addresses from being qualified if rewriting occurs at transport
37313 time). Local messages that were input using &%-bnq%& and remote messages from
37314 hosts that match &%sender_unqualified_hosts%& set this flag.
37315
37316 .vitem "&%-auth_id%&&~<&'text'&>"
37317 The id information for a message received on an authenticated SMTP connection
37318 &-- the value of the &$authenticated_id$& variable.
37319
37320 .vitem "&%-auth_sender%&&~<&'address'&>"
37321 The address of an authenticated sender &-- the value of the
37322 &$authenticated_sender$& variable.
37323
37324 .vitem "&%-body_linecount%&&~<&'number'&>"
37325 This records the number of lines in the body of the message, and is always
37326 present.
37327
37328 .vitem "&%-body_zerocount%&&~<&'number'&>"
37329 This records the number of binary zero bytes in the body of the message, and is
37330 present if the number is greater than zero.
37331
37332 .vitem &%-deliver_firsttime%&
37333 This is written when a new message is first added to the spool. When the spool
37334 file is updated after a deferral, it is omitted.
37335
37336 .vitem "&%-frozen%&&~<&'time'&>"
37337 .cindex "frozen messages" "spool data"
37338 The message is frozen, and the freezing happened at <&'time'&>.
37339
37340 .vitem "&%-helo_name%&&~<&'text'&>"
37341 This records the host name as specified by a remote host in a HELO or EHLO
37342 command.
37343
37344 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37345 This records the IP address of the host from which the message was received and
37346 the remote port number that was used. It is omitted for locally generated
37347 messages.
37348
37349 .vitem "&%-host_auth%&&~<&'text'&>"
37350 If the message was received on an authenticated SMTP connection, this records
37351 the name of the authenticator &-- the value of the
37352 &$sender_host_authenticated$& variable.
37353
37354 .vitem &%-host_lookup_failed%&
37355 This is present if an attempt to look up the sending host's name from its IP
37356 address failed. It corresponds to the &$host_lookup_failed$& variable.
37357
37358 .vitem "&%-host_name%&&~<&'text'&>"
37359 .cindex "reverse DNS lookup"
37360 .cindex "DNS" "reverse lookup"
37361 This records the name of the remote host from which the message was received,
37362 if the host name was looked up from the IP address when the message was being
37363 received. It is not present if no reverse lookup was done.
37364
37365 .vitem "&%-ident%&&~<&'text'&>"
37366 For locally submitted messages, this records the login of the originating user,
37367 unless it was a trusted user and the &%-oMt%& option was used to specify an
37368 ident value. For messages received over TCP/IP, this records the ident string
37369 supplied by the remote host, if any.
37370
37371 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37372 This records the IP address of the local interface and the port number through
37373 which a message was received from a remote host. It is omitted for locally
37374 generated messages.
37375
37376 .vitem &%-local%&
37377 The message is from a local sender.
37378
37379 .vitem &%-localerror%&
37380 The message is a locally-generated bounce message.
37381
37382 .vitem "&%-local_scan%&&~<&'string'&>"
37383 This records the data string that was returned by the &[local_scan()]& function
37384 when the message was received &-- the value of the &$local_scan_data$&
37385 variable. It is omitted if no data was returned.
37386
37387 .vitem &%-manual_thaw%&
37388 The message was frozen but has been thawed manually, that is, by an explicit
37389 Exim command rather than via the auto-thaw process.
37390
37391 .vitem &%-N%&
37392 A testing delivery process was started using the &%-N%& option to suppress any
37393 actual deliveries, but delivery was deferred. At any further delivery attempts,
37394 &%-N%& is assumed.
37395
37396 .vitem &%-received_protocol%&
37397 This records the value of the &$received_protocol$& variable, which contains
37398 the name of the protocol by which the message was received.
37399
37400 .vitem &%-sender_set_untrusted%&
37401 The envelope sender of this message was set by an untrusted local caller (used
37402 to ensure that the caller is displayed in queue listings).
37403
37404 .vitem "&%-spam_score_int%&&~<&'number'&>"
37405 If a message was scanned by SpamAssassin, this is present. It records the value
37406 of &$spam_score_int$&.
37407
37408 .vitem &%-tls_certificate_verified%&
37409 A TLS certificate was received from the client that sent this message, and the
37410 certificate was verified by the server.
37411
37412 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37413 When the message was received over an encrypted connection, this records the
37414 name of the cipher suite that was used.
37415
37416 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37417 When the message was received over an encrypted connection, and a certificate
37418 was received from the client, this records the Distinguished Name from that
37419 certificate.
37420 .endlist
37421
37422 Following the options there is a list of those addresses to which the message
37423 is not to be delivered. This set of addresses is initialized from the command
37424 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37425 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37426 the address is added to this set. The addresses are kept internally as a
37427 balanced binary tree, and it is a representation of that tree which is written
37428 to the spool file. If an address is expanded via an alias or forward file, the
37429 original address is added to the tree when deliveries to all its child
37430 addresses are complete.
37431
37432 If the tree is empty, there is a single line in the spool file containing just
37433 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37434 Y or N, followed by an address. The address is the value for the node of the
37435 tree, and the letters indicate whether the node has a left branch and/or a
37436 right branch attached to it, respectively. If branches exist, they immediately
37437 follow. Here is an example of a three-node tree:
37438 .code
37439 YY darcy@austen.fict.example
37440 NN alice@wonderland.fict.example
37441 NN editor@thesaurus.ref.example
37442 .endd
37443 After the non-recipients tree, there is a list of the message's recipients.
37444 This is a simple list, preceded by a count. It includes all the original
37445 recipients of the message, including those to whom the message has already been
37446 delivered. In the simplest case, the list contains one address per line. For
37447 example:
37448 .code
37449 4
37450 editor@thesaurus.ref.example
37451 darcy@austen.fict.example
37452 rdo@foundation
37453 alice@wonderland.fict.example
37454 .endd
37455 However, when a child address has been added to the top-level addresses as a
37456 result of the use of the &%one_time%& option on a &(redirect)& router, each
37457 line is of the following form:
37458 .display
37459 <&'top-level address'&> <&'errors_to address'&> &&&
37460   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37461 .endd
37462 The 01 flag bit indicates the presence of the three other fields that follow
37463 the top-level address. Other bits may be used in future to support additional
37464 fields. The <&'parent number'&> is the offset in the recipients list of the
37465 original parent of the &"one time"& address. The first two fields are the
37466 envelope sender that is associated with this address and its length. If the
37467 length is zero, there is no special envelope sender (there are then two space
37468 characters in the line). A non-empty field can arise from a &(redirect)& router
37469 that has an &%errors_to%& setting.
37470
37471
37472 A blank line separates the envelope and status information from the headers
37473 which follow. A header may occupy several lines of the file, and to save effort
37474 when reading it in, each header is preceded by a number and an identifying
37475 character. The number is the number of characters in the header, including any
37476 embedded newlines and the terminating newline. The character is one of the
37477 following:
37478
37479 .table2 50pt
37480 .row <&'blank'&>         "header in which Exim has no special interest"
37481 .row &`B`&               "&'Bcc:'& header"
37482 .row &`C`&               "&'Cc:'& header"
37483 .row &`F`&               "&'From:'& header"
37484 .row &`I`&               "&'Message-id:'& header"
37485 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37486 .row &`R`&               "&'Reply-To:'& header"
37487 .row &`S`&               "&'Sender:'& header"
37488 .row &`T`&               "&'To:'& header"
37489 .row &`*`&               "replaced or deleted header"
37490 .endtable
37491
37492 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37493 purposes. They are not transmitted when the message is delivered. Here is a
37494 typical set of headers:
37495 .code
37496 111P Received: by hobbit.fict.example with local (Exim 4.00)
37497 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37498 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37499 038* X-rewrote-sender: bb@hobbit.fict.example
37500 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37501 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37502 099* To: alice@wonderland.fict.example, rdo@foundation,
37503 darcy@austen.fict.example, editor@thesaurus.ref.example
37504 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37505 darcy@austen.fict.example, editor@thesaurus.ref.example
37506 038  Date: Fri, 11 May 2001 10:28:59 +0100
37507 .endd
37508 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37509 &'To:'& header have been rewritten, the last one because routing expanded the
37510 unqualified domain &'foundation'&.
37511 .ecindex IIDforspo1
37512 .ecindex IIDforspo2
37513 .ecindex IIDforspo3
37514
37515 . ////////////////////////////////////////////////////////////////////////////
37516 . ////////////////////////////////////////////////////////////////////////////
37517
37518 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37519          "DKIM Support"
37520 .cindex "DKIM"
37521
37522 DKIM is a mechanism by which messages sent by some entity can be provably
37523 linked to a domain which that entity controls.  It permits reputation to
37524 be tracked on a per-domain basis, rather than merely upon source IP address.
37525 DKIM is documented in RFC 4871.
37526
37527 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37528 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37529
37530 Exim's DKIM implementation allows to
37531 .olist
37532 Sign outgoing messages: This function is implemented in the SMTP transport.
37533 It can co-exist with all other Exim features
37534 (including transport filters)
37535 except cutthrough delivery.
37536 .next
37537 Verify signatures in incoming messages: This is implemented by an additional
37538 ACL (acl_smtp_dkim), which can be called several times per message, with
37539 different signature contexts.
37540 .endlist
37541
37542 In typical Exim style, the verification implementation does not include any
37543 default "policy". Instead it enables you to build your own policy using
37544 Exim's standard controls.
37545
37546 Please note that verification of DKIM signatures in incoming mail is turned
37547 on by default for logging purposes. For each signature in incoming email,
37548 exim will log a line displaying the most important signature details, and the
37549 signature status. Here is an example (with line-breaks added for clarity):
37550 .code
37551 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37552     d=facebookmail.com s=q1-2009b
37553     c=relaxed/relaxed a=rsa-sha1
37554     i=@facebookmail.com t=1252484542 [verification succeeded]
37555 .endd
37556 You might want to turn off DKIM verification processing entirely for internal
37557 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37558 control modifier. This should typically be done in the RCPT ACL, at points
37559 where you accept mail from relay sources (internal hosts or authenticated
37560 senders).
37561
37562
37563 .section "Signing outgoing messages" "SECID513"
37564 .cindex "DKIM" "signing"
37565
37566 Signing is implemented by setting private options on the SMTP transport.
37567 These options take (expandable) strings as arguments.
37568
37569 .option dkim_domain smtp string&!! unset
37570 MANDATORY:
37571 The domain you want to sign with. The result of this expanded
37572 option is put into the &%$dkim_domain%& expansion variable.
37573
37574 .option dkim_selector smtp string&!! unset
37575 MANDATORY:
37576 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37577 variable to look up a matching selector. The result is put in the expansion
37578 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37579 option along with &%$dkim_domain%&.
37580
37581 .option dkim_private_key smtp string&!! unset
37582 MANDATORY:
37583 This sets the private key to use. You can use the &%$dkim_domain%& and
37584 &%$dkim_selector%& expansion variables to determine the private key to use.
37585 The result can either
37586 .ilist
37587 be a valid RSA private key in ASCII armor, including line breaks.
37588 .next
37589 start with a slash, in which case it is treated as a file that contains
37590 the private key.
37591 .next
37592 be "0", "false" or the empty string, in which case the message will not
37593 be signed. This case will not result in an error, even if &%dkim_strict%&
37594 is set.
37595 .endlist
37596
37597 .option dkim_canon smtp string&!! unset
37598 OPTIONAL:
37599 This option sets the canonicalization method used when signing a message.
37600 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37601 The option defaults to "relaxed" when unset. Note: the current implementation
37602 only supports using the same canonicalization method for both headers and body.
37603
37604 .option dkim_strict smtp string&!! unset
37605 OPTIONAL:
37606 This  option  defines  how  Exim  behaves  when  signing a message that
37607 should be signed fails for some reason.  When the expansion evaluates to
37608 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37609 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37610 variables here.
37611
37612 .option dkim_sign_headers smtp string&!! unset
37613 OPTIONAL:
37614 When set, this option must expand to (or be specified as) a colon-separated
37615 list of header names. Headers with these names will be included in the message
37616 signature. When unspecified, the header names recommended in RFC4871 will be
37617 used.
37618
37619
37620 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37621 .cindex "DKIM" "verification"
37622
37623 Verification of DKIM signatures in incoming email is implemented via the
37624 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37625 syntactically(!) correct signature in the incoming message.
37626 A missing ACL definition defaults to accept.
37627 If any ACL call does not acccept, the message is not accepted.
37628 If a cutthrough delivery was in progress for the message it is
37629 summarily dropped (having wasted the transmission effort).
37630
37631 To evaluate the signature in the ACL a large number of expansion variables
37632 containing the signature status and its details are set up during the
37633 runtime of the ACL.
37634
37635 Calling the ACL only for existing signatures is not sufficient to build
37636 more advanced policies. For that reason, the global option
37637 &%dkim_verify_signers%&, and a global expansion variable
37638 &%$dkim_signers%& exist.
37639
37640 The global option &%dkim_verify_signers%& can be set to a colon-separated
37641 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37642 called. It is expanded when the message has been received. At this point,
37643 the expansion variable &%$dkim_signers%& already contains a colon-separated
37644 list of signer domains and identities for the message. When
37645 &%dkim_verify_signers%& is not specified in the main configuration,
37646 it defaults as:
37647 .code
37648 dkim_verify_signers = $dkim_signers
37649 .endd
37650 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37651 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37652 call the ACL for known domains or identities. This would be achieved as follows:
37653 .code
37654 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37655 .endd
37656 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37657 and "ebay.com", plus all domains and identities that have signatures in the message.
37658 You can also be more creative in constructing your policy. For example:
37659 .code
37660 dkim_verify_signers = $sender_address_domain:$dkim_signers
37661 .endd
37662
37663 If a domain or identity is listed several times in the (expanded) value of
37664 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37665
37666
37667 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37668 available (from most to least important):
37669
37670
37671 .vlist
37672 .vitem &%$dkim_cur_signer%&
37673 The signer that is being evaluated in this ACL run. This can be a domain or
37674 an identity. This is one of the list items from the expanded main option
37675 &%dkim_verify_signers%& (see above).
37676 .vitem &%$dkim_verify_status%&
37677 A string describing the general status of the signature. One of
37678 .ilist
37679 &%none%&: There is no signature in the message for the current domain or
37680 identity (as reflected by &%$dkim_cur_signer%&).
37681 .next
37682 &%invalid%&: The signature could not be verified due to a processing error.
37683 More detail is available in &%$dkim_verify_reason%&.
37684 .next
37685 &%fail%&: Verification of the signature failed.  More detail is
37686 available in &%$dkim_verify_reason%&.
37687 .next
37688 &%pass%&: The signature passed verification. It is valid.
37689 .endlist
37690 .vitem &%$dkim_verify_reason%&
37691 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37692 "fail" or "invalid". One of
37693 .ilist
37694 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37695 key for the domain could not be retrieved. This may be a temporary problem.
37696 .next
37697 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37698 record for the domain is syntactically invalid.
37699 .next
37700 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37701 body hash does not match the one specified in the signature header. This
37702 means that the message body was modified in transit.
37703 .next
37704 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37705 could not be verified. This may mean that headers were modified,
37706 re-written or otherwise changed in a way which is incompatible with
37707 DKIM verification. It may of course also mean that the signature is forged.
37708 .endlist
37709 .vitem &%$dkim_domain%&
37710 The signing domain. IMPORTANT: This variable is only populated if there is
37711 an actual signature in the message for the current domain or identity (as
37712 reflected by &%$dkim_cur_signer%&).
37713 .vitem &%$dkim_identity%&
37714 The signing identity, if present. IMPORTANT: This variable is only populated
37715 if there is an actual signature in the message for the current domain or
37716 identity (as reflected by &%$dkim_cur_signer%&).
37717 .vitem &%$dkim_selector%&
37718 The key record selector string.
37719 .vitem &%$dkim_algo%&
37720 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37721 .vitem &%$dkim_canon_body%&
37722 The body canonicalization method. One of 'relaxed' or 'simple'.
37723 .vitem &%dkim_canon_headers%&
37724 The header canonicalization method. One of 'relaxed' or 'simple'.
37725 .vitem &%$dkim_copiedheaders%&
37726 A transcript of headers and their values which are included in the signature
37727 (copied from the 'z=' tag of the signature).
37728 .vitem &%$dkim_bodylength%&
37729 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37730 limit was set by the signer, "9999999999999" is returned. This makes sure
37731 that this variable always expands to an integer value.
37732 .vitem &%$dkim_created%&
37733 UNIX timestamp reflecting the date and time when the signature was created.
37734 When this was not specified by the signer, "0" is returned.
37735 .vitem &%$dkim_expires%&
37736 UNIX timestamp reflecting the date and time when the signer wants the
37737 signature to be treated as "expired". When this was not specified by the
37738 signer, "9999999999999" is returned. This makes it possible to do useful
37739 integer size comparisons against this value.
37740 .vitem &%$dkim_headernames%&
37741 A colon-separated list of names of headers included in the signature.
37742 .vitem &%$dkim_key_testing%&
37743 "1" if the key record has the "testing" flag set, "0" if not.
37744 .vitem &%$dkim_key_nosubdomains%&
37745 "1" if the key record forbids subdomaining, "0" otherwise.
37746 .vitem &%$dkim_key_srvtype%&
37747 Service type (tag s=) from the key record. Defaults to "*" if not specified
37748 in the key record.
37749 .vitem &%$dkim_key_granularity%&
37750 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37751 in the key record.
37752 .vitem &%$dkim_key_notes%&
37753 Notes from the key record (tag n=).
37754 .endlist
37755
37756 In addition, two ACL conditions are provided:
37757
37758 .vlist
37759 .vitem &%dkim_signers%&
37760 ACL condition that checks a colon-separated list of domains or identities
37761 for a match against the domain or identity that the ACL is currently verifying
37762 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37763 verb to a group of domains or identities. For example:
37764
37765 .code
37766 # Warn when Mail purportedly from GMail has no signature at all
37767 warn log_message = GMail sender without DKIM signature
37768      sender_domains = gmail.com
37769      dkim_signers = gmail.com
37770      dkim_status = none
37771 .endd
37772
37773 .vitem &%dkim_status%&
37774 ACL condition that checks a colon-separated list of possible DKIM verification
37775 results against the actual result of verification. This is typically used
37776 to restrict an ACL verb to a list of verification outcomes, for example:
37777
37778 .code
37779 deny message = Mail from Paypal with invalid/missing signature
37780      sender_domains = paypal.com:paypal.de
37781      dkim_signers = paypal.com:paypal.de
37782      dkim_status = none:invalid:fail
37783 .endd
37784
37785 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37786 see the documentation of the &%$dkim_verify_status%& expansion variable above
37787 for more information of what they mean.
37788 .endlist
37789
37790 . ////////////////////////////////////////////////////////////////////////////
37791 . ////////////////////////////////////////////////////////////////////////////
37792
37793 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37794          "Adding drivers or lookups"
37795 .cindex "adding drivers"
37796 .cindex "new drivers, adding"
37797 .cindex "drivers" "adding new"
37798 The following actions have to be taken in order to add a new router, transport,
37799 authenticator, or lookup type to Exim:
37800
37801 .olist
37802 Choose a name for the driver or lookup type that does not conflict with any
37803 existing name; I will use &"newdriver"& in what follows.
37804 .next
37805 Add to &_src/EDITME_& the line:
37806 .display
37807 <&'type'&>&`_NEWDRIVER=yes`&
37808 .endd
37809 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37810 code is not to be included in the binary by default, comment this line out. You
37811 should also add any relevant comments about the driver or lookup type.
37812 .next
37813 Add to &_src/config.h.defaults_& the line:
37814 .code
37815 #define <type>_NEWDRIVER
37816 .endd
37817 .next
37818 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37819 and create a table entry as is done for all the other drivers and lookup types.
37820 .next
37821 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37822 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37823 Add your &`NEWDRIVER`& to that list.
37824 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37825 simple form that most lookups have.
37826 .next
37827 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37828 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37829 driver or lookup type and add it to the definition of OBJ.
37830 .next
37831 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37832 &_src_&.
37833 .next
37834 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37835 as for other drivers and lookups.
37836 .endlist
37837
37838 Then all you need to do is write the code! A good way to start is to make a
37839 proforma by copying an existing module of the same type, globally changing all
37840 occurrences of the name, and cutting out most of the code. Note that any
37841 options you create must be listed in alphabetical order, because the tables are
37842 searched using a binary chop procedure.
37843
37844 There is a &_README_& file in each of the sub-directories of &_src_& describing
37845 the interface that is expected.
37846
37847
37848
37849
37850 . ////////////////////////////////////////////////////////////////////////////
37851 . ////////////////////////////////////////////////////////////////////////////
37852
37853 . /////////////////////////////////////////////////////////////////////////////
37854 . These lines are processing instructions for the Simple DocBook Processor that
37855 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37856 . PDFs than using xmlto and fop. They will be ignored by all other XML
37857 . processors.
37858 . /////////////////////////////////////////////////////////////////////////////
37859
37860 .literal xml
37861 <?sdop
37862   format="newpage"
37863   foot_right_recto="&chaptertitle;"
37864   foot_right_verso="&chaptertitle;"
37865 ?>
37866 .literal off
37867
37868 .makeindex "Options index"   "option"
37869 .makeindex "Variables index" "variable"
37870 .makeindex "Concept index"   "concept"
37871
37872
37873 . /////////////////////////////////////////////////////////////////////////////
37874 . /////////////////////////////////////////////////////////////////////////////