Withdraw A6 DNS record support
[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, SPF, SRV, TLSA and TXT,
6882 and, when Exim is compiled with IPv6 support, AAAA.
6883 If no type is given, TXT is assumed. When the type is PTR,
6884 the data can be an IP address, written as normal; inversion and the addition of
6885 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6886 .code
6887 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6888 .endd
6889 If the data for a PTR record is not a syntactically valid IP address, it is not
6890 altered and nothing is added.
6891
6892 For any record type, if multiple records are found, the data is returned as a
6893 concatenation, with newline as the default separator. The order, of course,
6894 depends on the DNS resolver. You can specify a different separator character
6895 between multiple records by putting a right angle-bracket followed immediately
6896 by the new separator at the start of the query. For example:
6897 .code
6898 ${lookup dnsdb{>: a=host1.example}}
6899 .endd
6900 It is permitted to specify a space as the separator character. Further
6901 white space is ignored.
6902
6903 .cindex "MX record" "in &(dnsdb)& lookup"
6904 .cindex "SRV record" "in &(dnsdb)& lookup"
6905 For an MX lookup, both the preference value and the host name are returned for
6906 each record, separated by a space. For an SRV lookup, the priority, weight,
6907 port, and host name are returned for each record, separated by spaces.
6908 An alternate field separator can be specified using a comma after the main
6909 separator character, followed immediately by the field separator.
6910
6911 .cindex "TXT record" "in &(dnsdb)& lookup"
6912 .cindex "SPF record" "in &(dnsdb)& lookup"
6913 For TXT records with multiple items of data, only the first item is returned,
6914 unless a separator for them is specified using a comma after the separator
6915 character followed immediately by the TXT record item separator. To concatenate
6916 items without a separator, use a semicolon instead. For SPF records the
6917 default behaviour is to concatenate multiple items without using a separator.
6918 .code
6919 ${lookup dnsdb{>\n,: txt=a.b.example}}
6920 ${lookup dnsdb{>\n; txt=a.b.example}}
6921 ${lookup dnsdb{spf=example.org}}
6922 .endd
6923 It is permitted to specify a space as the separator character. Further
6924 white space is ignored.
6925
6926 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6927 .cindex "dnsdb modifiers"
6928 .cindex "modifiers" "dnsdb"
6929 .cindex "options" "dnsdb"
6930 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6931 each followed by a comma,
6932 that may appear before the record type.
6933
6934 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6935 temporary DNS error for any of them, the behaviour is controlled by
6936 a defer-option modifier.
6937 The possible keywords are
6938 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6939 With &"strict"& behaviour, any temporary DNS error causes the
6940 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6941 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6942 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6943 error causes the whole lookup to defer only if none of the other lookups
6944 succeed. The default is &"lax"&, so the following lookups are equivalent:
6945 .code
6946 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6947 ${lookup dnsdb{a=one.host.com:two.host.com}}
6948 .endd
6949 Thus, in the default case, as long as at least one of the DNS lookups
6950 yields some data, the lookup succeeds.
6951
6952 .cindex "DNSSEC" "dns lookup"
6953 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6954 The possible keywords are
6955 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6956 With &"strict"& or &"lax"& DNSSEC information is requested
6957 with the lookup.
6958 With &"strict"& a response from the DNS resolver that
6959 is not labelled as authenticated data
6960 is treated as equivalent to a temporary DNS error.
6961 The default is &"never"&.
6962
6963 See also the &$lookup_dnssec_authenticated$& variable.
6964
6965
6966 .section "Pseudo dnsdb record types" "SECID66"
6967 .cindex "MX record" "in &(dnsdb)& lookup"
6968 By default, both the preference value and the host name are returned for
6969 each MX record, separated by a space. If you want only host names, you can use
6970 the pseudo-type MXH:
6971 .code
6972 ${lookup dnsdb{mxh=a.b.example}}
6973 .endd
6974 In this case, the preference values are omitted, and just the host names are
6975 returned.
6976
6977 .cindex "name server for enclosing domain"
6978 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6979 records on the given domain, but if none are found, it removes the first
6980 component of the domain name, and tries again. This process continues until NS
6981 records are found or there are no more components left (or there is a DNS
6982 error). In other words, it may return the name servers for a top-level domain,
6983 but it never returns the root name servers. If there are no NS records for the
6984 top-level domain, the lookup fails. Consider these examples:
6985 .code
6986 ${lookup dnsdb{zns=xxx.quercite.com}}
6987 ${lookup dnsdb{zns=xxx.edu}}
6988 .endd
6989 Assuming that in each case there are no NS records for the full domain name,
6990 the first returns the name servers for &%quercite.com%&, and the second returns
6991 the name servers for &%edu%&.
6992
6993 You should be careful about how you use this lookup because, unless the
6994 top-level domain does not exist, the lookup always returns some host names. The
6995 sort of use to which this might be put is for seeing if the name servers for a
6996 given domain are on a blacklist. You can probably assume that the name servers
6997 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6998 such a list.
6999
7000 .cindex "CSA" "in &(dnsdb)& lookup"
7001 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7002 records according to the CSA rules, which are described in section
7003 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7004 not sufficient because of the extra parent domain search behaviour of CSA. The
7005 result of a successful lookup such as:
7006 .code
7007 ${lookup dnsdb {csa=$sender_helo_name}}
7008 .endd
7009 has two space-separated fields: an authorization code and a target host name.
7010 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7011 authorization required but absent, or &"?"& for unknown.
7012
7013 .cindex "A+" "in &(dnsdb)& lookup"
7014 The pseudo-type A+ performs an AAAA
7015 and then an A lookup.  All results are returned; defer processing
7016 (see below) is handled separately for each lookup.  Example:
7017 .code
7018 ${lookup dnsdb {>; a+=$sender_helo_name}}
7019 .endd
7020
7021
7022 .section "Multiple dnsdb lookups" "SECID67"
7023 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7024 However, you can specify a list of domains or IP addresses in a single
7025 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7026 the default separator, but with the ability to change this. For example:
7027 .code
7028 ${lookup dnsdb{one.domain.com:two.domain.com}}
7029 ${lookup dnsdb{a=one.host.com:two.host.com}}
7030 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7031 .endd
7032 In order to retain backwards compatibility, there is one special case: if
7033 the lookup type is PTR and no change of separator is specified, Exim looks
7034 to see if the rest of the string is precisely one IPv6 address. In this
7035 case, it does not treat it as a list.
7036
7037 The data from each lookup is concatenated, with newline separators by default,
7038 in the same way that multiple DNS records for a single item are handled. A
7039 different separator can be specified, as described above.
7040
7041
7042
7043
7044 .section "More about LDAP" "SECTldap"
7045 .cindex "LDAP" "lookup, more about"
7046 .cindex "lookup" "LDAP"
7047 .cindex "Solaris" "LDAP"
7048 The original LDAP implementation came from the University of Michigan; this has
7049 become &"Open LDAP"&, and there are now two different releases. Another
7050 implementation comes from Netscape, and Solaris 7 and subsequent releases
7051 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7052 the lookup function level, their error handling is different. For this reason
7053 it is necessary to set a compile-time variable when building Exim with LDAP, to
7054 indicate which LDAP library is in use. One of the following should appear in
7055 your &_Local/Makefile_&:
7056 .code
7057 LDAP_LIB_TYPE=UMICHIGAN
7058 LDAP_LIB_TYPE=OPENLDAP1
7059 LDAP_LIB_TYPE=OPENLDAP2
7060 LDAP_LIB_TYPE=NETSCAPE
7061 LDAP_LIB_TYPE=SOLARIS
7062 .endd
7063 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7064 same interface as the University of Michigan version.
7065
7066 There are three LDAP lookup types in Exim. These behave slightly differently in
7067 the way they handle the results of a query:
7068
7069 .ilist
7070 &(ldap)& requires the result to contain just one entry; if there are more, it
7071 gives an error.
7072 .next
7073 &(ldapdn)& also requires the result to contain just one entry, but it is the
7074 Distinguished Name that is returned rather than any attribute values.
7075 .next
7076 &(ldapm)& permits the result to contain more than one entry; the attributes
7077 from all of them are returned.
7078 .endlist
7079
7080
7081 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7082 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7083 the data returned by a successful lookup is described in the next section.
7084 First we explain how LDAP queries are coded.
7085
7086
7087 .section "Format of LDAP queries" "SECTforldaque"
7088 .cindex "LDAP" "query format"
7089 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7090 the configuration of a &(redirect)& router one might have this setting:
7091 .code
7092 data = ${lookup ldap \
7093   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7094   c=UK?mailbox?base?}}
7095 .endd
7096 .cindex "LDAP" "with TLS"
7097 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7098 secure (encrypted) LDAP connections. The second of these ensures that an
7099 encrypted TLS connection is used.
7100
7101 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7102 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7103 See the &%ldap_start_tls%& option.
7104
7105 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7106 controlled. Every part of the TLS configuration can be configured by settings in
7107 &_exim.conf_&. Depending on the version of the client libraries installed on
7108 your system, some of the initialization may have required setting options in
7109 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7110 certificates. This revealed a nuance where the current UID that exim was
7111 running as could affect which config files it read. With Exim 4.83, these
7112 methods become optional, only taking effect if not specifically set in
7113 &_exim.conf_&.
7114
7115
7116 .section "LDAP quoting" "SECID68"
7117 .cindex "LDAP" "quoting"
7118 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7119 and the second because the LDAP query is represented as a URL. Furthermore,
7120 within an LDAP query, two different kinds of quoting are required. For this
7121 reason, there are two different LDAP-specific quoting operators.
7122
7123 The &%quote_ldap%& operator is designed for use on strings that are part of
7124 filter specifications. Conceptually, it first does the following conversions on
7125 the string:
7126 .code
7127 *   =>   \2A
7128 (   =>   \28
7129 )   =>   \29
7130 \   =>   \5C
7131 .endd
7132 in accordance with RFC 2254. The resulting string is then quoted according
7133 to the rules for URLs, that is, all non-alphanumeric characters except
7134 .code
7135 ! $ ' - . _ ( ) * +
7136 .endd
7137 are converted to their hex values, preceded by a percent sign. For example:
7138 .code
7139 ${quote_ldap: a(bc)*, a<yz>; }
7140 .endd
7141 yields
7142 .code
7143 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7144 .endd
7145 Removing the URL quoting, this is (with a leading and a trailing space):
7146 .code
7147 a\28bc\29\2A, a<yz>;
7148 .endd
7149 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7150 base DN specifications in queries. Conceptually, it first converts the string
7151 by inserting a backslash in front of any of the following characters:
7152 .code
7153 , + " \ < > ;
7154 .endd
7155 It also inserts a backslash before any leading spaces or # characters, and
7156 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7157 is then quoted according to the rules for URLs. For example:
7158 .code
7159 ${quote_ldap_dn: a(bc)*, a<yz>; }
7160 .endd
7161 yields
7162 .code
7163 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7164 .endd
7165 Removing the URL quoting, this is (with a trailing space):
7166 .code
7167 \ a(bc)*\, a\<yz\>\;\
7168 .endd
7169 There are some further comments about quoting in the section on LDAP
7170 authentication below.
7171
7172
7173 .section "LDAP connections" "SECID69"
7174 .cindex "LDAP" "connections"
7175 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7176 is in use, via a Unix domain socket. The example given above does not specify
7177 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7178 by starting it with
7179 .code
7180 ldap://<hostname>:<port>/...
7181 .endd
7182 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7183 used. When no server is specified in a query, a list of default servers is
7184 taken from the &%ldap_default_servers%& configuration option. This supplies a
7185 colon-separated list of servers which are tried in turn until one successfully
7186 handles a query, or there is a serious error. Successful handling either
7187 returns the requested data, or indicates that it does not exist. Serious errors
7188 are syntactical, or multiple values when only a single value is expected.
7189 Errors which cause the next server to be tried are connection failures, bind
7190 failures, and timeouts.
7191
7192 For each server name in the list, a port number can be given. The standard way
7193 of specifying a host and port is to use a colon separator (RFC 1738). Because
7194 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7195 doubled. For example
7196 .code
7197 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7198 .endd
7199 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7200 to the LDAP library with no server name, and the library's default (normally
7201 the local host) is used.
7202
7203 If you are using the OpenLDAP library, you can connect to an LDAP server using
7204 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7205 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7206 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7207 not available.
7208
7209 For this type of connection, instead of a host name for the server, a pathname
7210 for the socket is required, and the port number is not relevant. The pathname
7211 can be specified either as an item in &%ldap_default_servers%&, or inline in
7212 the query. In the former case, you can have settings such as
7213 .code
7214 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7215 .endd
7216 When the pathname is given in the query, you have to escape the slashes as
7217 &`%2F`& to fit in with the LDAP URL syntax. For example:
7218 .code
7219 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7220 .endd
7221 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7222 a pathname, it uses the Unix domain socket code, even if the query actually
7223 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7224 socket connection. This behaviour means that you can use a setting of
7225 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7226 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7227 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7228 backup host.
7229
7230 If an explicit &`ldapi`& type is given in a query when a host name is
7231 specified, an error is diagnosed. However, if there are more items in
7232 &%ldap_default_servers%&, they are tried. In other words:
7233
7234 .ilist
7235 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7236 interface.
7237 .next
7238 Using &`ldapi`& with a host name causes an error.
7239 .endlist
7240
7241
7242 Using &`ldapi`& with no host or path in the query, and no setting of
7243 &%ldap_default_servers%&, does whatever the library does by default.
7244
7245
7246
7247 .section "LDAP authentication and control information" "SECID70"
7248 .cindex "LDAP" "authentication"
7249 The LDAP URL syntax provides no way of passing authentication and other control
7250 information to the server. To make this possible, the URL in an LDAP query may
7251 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7252 spaces. If a value contains spaces it must be enclosed in double quotes, and
7253 when double quotes are used, backslash is interpreted in the usual way inside
7254 them. The following names are recognized:
7255 .display
7256 &`DEREFERENCE`&  set the dereferencing parameter
7257 &`NETTIME    `&  set a timeout for a network operation
7258 &`USER       `&  set the DN, for authenticating the LDAP bind
7259 &`PASS       `&  set the password, likewise
7260 &`REFERRALS  `&  set the referrals parameter
7261 &`SERVERS    `&  set alternate server list for this query only
7262 &`SIZE       `&  set the limit for the number of entries returned
7263 &`TIME       `&  set the maximum waiting time for a query
7264 .endd
7265 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7266 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7267 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7268 library from trying to follow referrals issued by the LDAP server.
7269
7270 The name CONNECT is an obsolete name for NETTIME, retained for
7271 backwards compatibility. This timeout (specified as a number of seconds) is
7272 enforced from the client end for operations that can be carried out over a
7273 network. Specifically, it applies to network connections and calls to the
7274 &'ldap_result()'& function. If the value is greater than zero, it is used if
7275 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7276 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7277 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7278 Netscape SDK; for OpenLDAP no action is taken.
7279
7280 The TIME parameter (also a number of seconds) is passed to the server to
7281 set a server-side limit on the time taken to complete a search.
7282
7283 The SERVERS parameter allows you to specify an alternate list of ldap servers
7284 to use for an individual lookup.  The global ldap_servers option provides a
7285 default list of ldap servers, and a single lookup can specify a single ldap
7286 server to use.  But when you need to do a lookup with a list of servers that is
7287 different than the default list (maybe different order, maybe a completely
7288 different set of servers), the SERVERS parameter allows you to specify this
7289 alternate list (colon-separated).
7290
7291 Here is an example of an LDAP query in an Exim lookup that uses some of these
7292 values. This is a single line, folded to fit on the page:
7293 .code
7294 ${lookup ldap
7295   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7296   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7297   {$value}fail}
7298 .endd
7299 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7300 any of the auxiliary data. Exim configuration settings that include lookups
7301 which contain password information should be preceded by &"hide"& to prevent
7302 non-admin users from using the &%-bP%& option to see their values.
7303
7304 The auxiliary data items may be given in any order. The default is no
7305 connection timeout (the system timeout is used), no user or password, no limit
7306 on the number of entries returned, and no time limit on queries.
7307
7308 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7309 removes any URL quoting that it may contain before passing it LDAP. Apparently
7310 some libraries do this for themselves, but some do not. Removing the URL
7311 quoting has two advantages:
7312
7313 .ilist
7314 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7315 DNs as with DNs inside actual queries.
7316 .next
7317 It permits spaces inside USER= DNs.
7318 .endlist
7319
7320 For example, a setting such as
7321 .code
7322 USER=cn=${quote_ldap_dn:$1}
7323 .endd
7324 should work even if &$1$& contains spaces.
7325
7326 Expanded data for the PASS= value should be quoted using the &%quote%&
7327 expansion operator, rather than the LDAP quote operators. The only reason this
7328 field needs quoting is to ensure that it conforms to the Exim syntax, which
7329 does not allow unquoted spaces. For example:
7330 .code
7331 PASS=${quote:$3}
7332 .endd
7333 The LDAP authentication mechanism can be used to check passwords as part of
7334 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7335 &<<CHAPexpand>>&.
7336
7337
7338
7339 .section "Format of data returned by LDAP" "SECID71"
7340 .cindex "LDAP" "returned data formats"
7341 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7342 as a sequence of values, for example
7343 .code
7344 cn=manager, o=University of Cambridge, c=UK
7345 .endd
7346 The &(ldap)& lookup type generates an error if more than one entry matches the
7347 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7348 the result between the data from different entries. It is possible for multiple
7349 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7350 you know that whatever values are returned all came from a single entry in the
7351 directory.
7352
7353 In the common case where you specify a single attribute in your LDAP query, the
7354 result is not quoted, and does not contain the attribute name. If the attribute
7355 has multiple values, they are separated by commas.
7356
7357 If you specify multiple attributes, the result contains space-separated, quoted
7358 strings, each preceded by the attribute name and an equals sign. Within the
7359 quotes, the quote character, backslash, and newline are escaped with
7360 backslashes, and commas are used to separate multiple values for the attribute.
7361 Any commas in attribute values are doubled
7362 (permitting treatment of the values as a comma-separated list).
7363 Apart from the escaping, the string within quotes takes the same form as the
7364 output when a single attribute is requested. Specifying no attributes is the
7365 same as specifying all of an entry's attributes.
7366
7367 Here are some examples of the output format. The first line of each pair is an
7368 LDAP query, and the second is the data that is returned. The attribute called
7369 &%attr1%& has two values, one of them with an embedded comma, whereas
7370 &%attr2%& has only one value:
7371 .code
7372 ldap:///o=base?attr1?sub?(uid=fred)
7373 value1.1,value1,,2
7374
7375 ldap:///o=base?attr2?sub?(uid=fred)
7376 value two
7377
7378 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7379 attr1="value1.1,value1,,2" attr2="value two"
7380
7381 ldap:///o=base??sub?(uid=fred)
7382 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7383 .endd
7384 You can
7385 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7386 results of LDAP lookups.
7387 The &%extract%& operator in string expansions can be used to pick out
7388 individual fields from data that consists of &'key'&=&'value'& pairs.
7389 The &%listextract%& operator should be used to pick out individual values
7390 of attributes, even when only a single value is expected.
7391 The doubling of embedded commas allows you to use the returned data as a
7392 comma separated list (using the "<," syntax for changing the input list separator).
7393
7394
7395
7396
7397 .section "More about NIS+" "SECTnisplus"
7398 .cindex "NIS+ lookup type"
7399 .cindex "lookup" "NIS+"
7400 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7401 and field name. If this is given, the result of a successful query is the
7402 contents of the named field; otherwise the result consists of a concatenation
7403 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7404 values containing spaces are quoted. For example, the query
7405 .code
7406 [name=mg1456],passwd.org_dir
7407 .endd
7408 might return the string
7409 .code
7410 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7411 home=/home/mg1456 shell=/bin/bash shadow=""
7412 .endd
7413 (split over two lines here to fit on the page), whereas
7414 .code
7415 [name=mg1456],passwd.org_dir:gcos
7416 .endd
7417 would just return
7418 .code
7419 Martin Guerre
7420 .endd
7421 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7422 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7423 operator is to double any quote characters within the text.
7424
7425
7426
7427 .section "SQL lookups" "SECTsql"
7428 .cindex "SQL lookup types"
7429 .cindex "MySQL" "lookup type"
7430 .cindex "PostgreSQL lookup type"
7431 .cindex "lookup" "MySQL"
7432 .cindex "lookup" "PostgreSQL"
7433 .cindex "Oracle" "lookup type"
7434 .cindex "lookup" "Oracle"
7435 .cindex "InterBase lookup type"
7436 .cindex "lookup" "InterBase"
7437 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7438 databases. Queries for these databases contain SQL statements, so an example
7439 might be
7440 .code
7441 ${lookup mysql{select mailbox from users where id='userx'}\
7442   {$value}fail}
7443 .endd
7444 If the result of the query contains more than one field, the data for each
7445 field in the row is returned, preceded by its name, so the result of
7446 .code
7447 ${lookup pgsql{select home,name from users where id='userx'}\
7448   {$value}}
7449 .endd
7450 might be
7451 .code
7452 home=/home/userx name="Mister X"
7453 .endd
7454 Empty values and values containing spaces are double quoted, with embedded
7455 quotes escaped by a backslash. If the result of the query contains just one
7456 field, the value is passed back verbatim, without a field name, for example:
7457 .code
7458 Mister X
7459 .endd
7460 If the result of the query yields more than one row, it is all concatenated,
7461 with a newline between the data for each row.
7462
7463
7464 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7465 .cindex "MySQL" "lookup type"
7466 .cindex "PostgreSQL lookup type"
7467 .cindex "lookup" "MySQL"
7468 .cindex "lookup" "PostgreSQL"
7469 .cindex "Oracle" "lookup type"
7470 .cindex "lookup" "Oracle"
7471 .cindex "InterBase lookup type"
7472 .cindex "lookup" "InterBase"
7473 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7474 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7475 option (as appropriate) must be set to a colon-separated list of server
7476 information.
7477 (For MySQL and PostgreSQL only, the global option need not be set if all
7478 queries contain their own server information &-- see section
7479 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7480 items: host name, database name, user name, and password. In the case of
7481 Oracle, the host name field is used for the &"service name"&, and the database
7482 name field is not used and should be empty. For example:
7483 .code
7484 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7485 .endd
7486 Because password data is sensitive, you should always precede the setting with
7487 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7488 option. Here is an example where two MySQL servers are listed:
7489 .code
7490 hide mysql_servers = localhost/users/root/secret:\
7491                      otherhost/users/root/othersecret
7492 .endd
7493 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7494 because this is a colon-separated list, the colon has to be doubled. For each
7495 query, these parameter groups are tried in order until a connection is made and
7496 a query is successfully processed. The result of a query may be that no data is
7497 found, but that is still a successful query. In other words, the list of
7498 servers provides a backup facility, not a list of different places to look.
7499
7500 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7501 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7502 respectively, and the characters single-quote, double-quote, and backslash
7503 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7504 addition, escapes the percent and underscore characters. This cannot be done
7505 for MySQL because these escapes are not recognized in contexts where these
7506 characters are not special.
7507
7508 .section "Specifying the server in the query" "SECTspeserque"
7509 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7510 it is possible to specify a list of servers with an individual query. This is
7511 done by starting the query with
7512 .display
7513 &`servers=`&&'server1:server2:server3:...'&&`;`&
7514 .endd
7515 Each item in the list may take one of two forms:
7516 .olist
7517 If it contains no slashes it is assumed to be just a host name. The appropriate
7518 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7519 of the same name, and the remaining parameters (database, user, password) are
7520 taken from there.
7521 .next
7522 If it contains any slashes, it is taken as a complete parameter set.
7523 .endlist
7524 The list of servers is used in exactly the same way as the global list.
7525 Once a connection to a server has happened and a query has been
7526 successfully executed, processing of the lookup ceases.
7527
7528 This feature is intended for use in master/slave situations where updates
7529 are occurring and you want to update the master rather than a slave. If the
7530 master is in the list as a backup for reading, you might have a global setting
7531 like this:
7532 .code
7533 mysql_servers = slave1/db/name/pw:\
7534                 slave2/db/name/pw:\
7535                 master/db/name/pw
7536 .endd
7537 In an updating lookup, you could then write:
7538 .code
7539 ${lookup mysql{servers=master; UPDATE ...} }
7540 .endd
7541 That query would then be sent only to the master server. If, on the other hand,
7542 the master is not to be used for reading, and so is not present in the global
7543 option, you can still update it by a query of this form:
7544 .code
7545 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7546 .endd
7547
7548
7549 .section "Special MySQL features" "SECID73"
7550 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7551 causes a connection to the server on the local host by means of a Unix domain
7552 socket. An alternate socket can be specified in parentheses. The full syntax of
7553 each item in &%mysql_servers%& is:
7554 .display
7555 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7556   <&'user'&>/<&'password'&>
7557 .endd
7558 Any of the three sub-parts of the first field can be omitted. For normal use on
7559 the local host it can be left blank or set to just &"localhost"&.
7560
7561 No database need be supplied &-- but if it is absent here, it must be given in
7562 the queries.
7563
7564 If a MySQL query is issued that does not request any data (an insert, update,
7565 or delete command), the result of the lookup is the number of rows affected.
7566
7567 &*Warning*&: This can be misleading. If an update does not actually change
7568 anything (for example, setting a field to the value it already has), the result
7569 is zero because no rows are affected.
7570
7571
7572 .section "Special PostgreSQL features" "SECID74"
7573 PostgreSQL lookups can also use Unix domain socket connections to the database.
7574 This is usually faster and costs less CPU time than a TCP/IP connection.
7575 However it can be used only if the mail server runs on the same machine as the
7576 database server. A configuration line for PostgreSQL via Unix domain sockets
7577 looks like this:
7578 .code
7579 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7580 .endd
7581 In other words, instead of supplying a host name, a path to the socket is
7582 given. The path name is enclosed in parentheses so that its slashes aren't
7583 visually confused with the delimiters for the other server parameters.
7584
7585 If a PostgreSQL query is issued that does not request any data (an insert,
7586 update, or delete command), the result of the lookup is the number of rows
7587 affected.
7588
7589 .section "More about SQLite" "SECTsqlite"
7590 .cindex "lookup" "SQLite"
7591 .cindex "sqlite lookup type"
7592 SQLite is different to the other SQL lookups because a file name is required in
7593 addition to the SQL query. An SQLite database is a single file, and there is no
7594 daemon as in the other SQL databases. The interface to Exim requires the name
7595 of the file, as an absolute path, to be given at the start of the query. It is
7596 separated from the query by white space. This means that the path name cannot
7597 contain white space. Here is a lookup expansion example:
7598 .code
7599 ${lookup sqlite {/some/thing/sqlitedb \
7600   select name from aliases where id='userx';}}
7601 .endd
7602 In a list, the syntax is similar. For example:
7603 .code
7604 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7605    select * from relays where ip='$sender_host_address';
7606 .endd
7607 The only character affected by the &%quote_sqlite%& operator is a single
7608 quote, which it doubles.
7609
7610 The SQLite library handles multiple simultaneous accesses to the database
7611 internally. Multiple readers are permitted, but only one process can
7612 update at once. Attempts to access the database while it is being updated
7613 are rejected after a timeout period, during which the SQLite library
7614 waits for the lock to be released. In Exim, the default timeout is set
7615 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7616 option.
7617 .ecindex IIDfidalo1
7618 .ecindex IIDfidalo2
7619
7620
7621 . ////////////////////////////////////////////////////////////////////////////
7622 . ////////////////////////////////////////////////////////////////////////////
7623
7624 .chapter "Domain, host, address, and local part lists" &&&
7625          "CHAPdomhosaddlists" &&&
7626          "Domain, host, and address lists"
7627 .scindex IIDdohoadli "lists of domains; hosts; etc."
7628 A number of Exim configuration options contain lists of domains, hosts,
7629 email addresses, or local parts. For example, the &%hold_domains%& option
7630 contains a list of domains whose delivery is currently suspended. These lists
7631 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7632 arguments to expansion conditions such as &%match_domain%&.
7633
7634 Each item in one of these lists is a pattern to be matched against a domain,
7635 host, email address, or local part, respectively. In the sections below, the
7636 different types of pattern for each case are described, but first we cover some
7637 general facilities that apply to all four kinds of list.
7638
7639
7640
7641 .section "Expansion of lists" "SECID75"
7642 .cindex "expansion" "of lists"
7643 Each list is expanded as a single string before it is used. The result of
7644 expansion must be a list, possibly containing empty items, which is split up
7645 into separate items for matching. By default, colon is the separator character,
7646 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7647 &<<SECTempitelis>>& for details of the list syntax; the second of these
7648 discusses the way to specify empty list items.
7649
7650
7651 If the string expansion is forced to fail, Exim behaves as if the item it is
7652 testing (domain, host, address, or local part) is not in the list. Other
7653 expansion failures cause temporary errors.
7654
7655 If an item in a list is a regular expression, backslashes, dollars and possibly
7656 other special characters in the expression must be protected against
7657 misinterpretation by the string expander. The easiest way to do this is to use
7658 the &`\N`& expansion feature to indicate that the contents of the regular
7659 expression should not be expanded. For example, in an ACL you might have:
7660 .code
7661 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7662                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7663 .endd
7664 The first item is a regular expression that is protected from expansion by
7665 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7666 senders based on the receiving domain.
7667
7668
7669
7670
7671 .section "Negated items in lists" "SECID76"
7672 .cindex "list" "negation"
7673 .cindex "negation" "in lists"
7674 Items in a list may be positive or negative. Negative items are indicated by a
7675 leading exclamation mark, which may be followed by optional white space. A list
7676 defines a set of items (domains, etc). When Exim processes one of these lists,
7677 it is trying to find out whether a domain, host, address, or local part
7678 (respectively) is in the set that is defined by the list. It works like this:
7679
7680 The list is scanned from left to right. If a positive item is matched, the
7681 subject that is being checked is in the set; if a negative item is matched, the
7682 subject is not in the set. If the end of the list is reached without the
7683 subject having matched any of the patterns, it is in the set if the last item
7684 was a negative one, but not if it was a positive one. For example, the list in
7685 .code
7686 domainlist relay_to_domains = !a.b.c : *.b.c
7687 .endd
7688 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7689 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7690 list is positive. However, if the setting were
7691 .code
7692 domainlist relay_to_domains = !a.b.c
7693 .endd
7694 then all domains other than &'a.b.c'& would match because the last item in the
7695 list is negative. In other words, a list that ends with a negative item behaves
7696 as if it had an extra item &`:*`& on the end.
7697
7698 Another way of thinking about positive and negative items in lists is to read
7699 the connector as &"or"& after a positive item and as &"and"& after a negative
7700 item.
7701
7702
7703
7704 .section "File names in lists" "SECTfilnamlis"
7705 .cindex "list" "file name in"
7706 If an item in a domain, host, address, or local part list is an absolute file
7707 name (beginning with a slash character), each line of the file is read and
7708 processed as if it were an independent item in the list, except that further
7709 file names are not allowed,
7710 and no expansion of the data from the file takes place.
7711 Empty lines in the file are ignored, and the file may also contain comment
7712 lines:
7713
7714 .ilist
7715 For domain and host lists, if a # character appears anywhere in a line of the
7716 file, it and all following characters are ignored.
7717 .next
7718 Because local parts may legitimately contain # characters, a comment in an
7719 address list or local part list file is recognized only if # is preceded by
7720 white space or the start of the line. For example:
7721 .code
7722 not#comment@x.y.z   # but this is a comment
7723 .endd
7724 .endlist
7725
7726 Putting a file name in a list has the same effect as inserting each line of the
7727 file as an item in the list (blank lines and comments excepted). However, there
7728 is one important difference: the file is read each time the list is processed,
7729 so if its contents vary over time, Exim's behaviour changes.
7730
7731 If a file name is preceded by an exclamation mark, the sense of any match
7732 within the file is inverted. For example, if
7733 .code
7734 hold_domains = !/etc/nohold-domains
7735 .endd
7736 and the file contains the lines
7737 .code
7738 !a.b.c
7739 *.b.c
7740 .endd
7741 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7742 any domain matching &`*.b.c`& is not.
7743
7744
7745
7746 .section "An lsearch file is not an out-of-line list" "SECID77"
7747 As will be described in the sections that follow, lookups can be used in lists
7748 to provide indexed methods of checking list membership. There has been some
7749 confusion about the way &(lsearch)& lookups work in lists. Because
7750 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7751 sometimes thought that it is allowed to contain wild cards and other kinds of
7752 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7753 always fixed strings, just as for any other single-key lookup type.
7754
7755 If you want to use a file to contain wild-card patterns that form part of a
7756 list, just give the file name on its own, without a search type, as described
7757 in the previous section. You could also use the &(wildlsearch)& or
7758 &(nwildlsearch)&, but there is no advantage in doing this.
7759
7760
7761
7762
7763 .section "Named lists" "SECTnamedlists"
7764 .cindex "named lists"
7765 .cindex "list" "named"
7766 A list of domains, hosts, email addresses, or local parts can be given a name
7767 which is then used to refer to the list elsewhere in the configuration. This is
7768 particularly convenient if the same list is required in several different
7769 places. It also allows lists to be given meaningful names, which can improve
7770 the readability of the configuration. For example, it is conventional to define
7771 a domain list called &'local_domains'& for all the domains that are handled
7772 locally on a host, using a configuration line such as
7773 .code
7774 domainlist local_domains = localhost:my.dom.example
7775 .endd
7776 Named lists are referenced by giving their name preceded by a plus sign, so,
7777 for example, a router that is intended to handle local domains would be
7778 configured with the line
7779 .code
7780 domains = +local_domains
7781 .endd
7782 The first router in a configuration is often one that handles all domains
7783 except the local ones, using a configuration with a negated item like this:
7784 .code
7785 dnslookup:
7786   driver = dnslookup
7787   domains = ! +local_domains
7788   transport = remote_smtp
7789   no_more
7790 .endd
7791 The four kinds of named list are created by configuration lines starting with
7792 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7793 respectively. Then there follows the name that you are defining, followed by an
7794 equals sign and the list itself. For example:
7795 .code
7796 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7797 addresslist bad_senders = cdb;/etc/badsenders
7798 .endd
7799 A named list may refer to other named lists:
7800 .code
7801 domainlist  dom1 = first.example : second.example
7802 domainlist  dom2 = +dom1 : third.example
7803 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7804 .endd
7805 &*Warning*&: If the last item in a referenced list is a negative one, the
7806 effect may not be what you intended, because the negation does not propagate
7807 out to the higher level. For example, consider:
7808 .code
7809 domainlist  dom1 = !a.b
7810 domainlist  dom2 = +dom1 : *.b
7811 .endd
7812 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7813 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7814 means it matches the second list as well. The effect is not the same as
7815 .code
7816 domainlist  dom2 = !a.b : *.b
7817 .endd
7818 where &'x.y'& does not match. It's best to avoid negation altogether in
7819 referenced lists if you can.
7820
7821 Named lists may have a performance advantage. When Exim is routing an
7822 address or checking an incoming message, it caches the result of tests on named
7823 lists. So, if you have a setting such as
7824 .code
7825 domains = +local_domains
7826 .endd
7827 on several of your routers
7828 or in several ACL statements,
7829 the actual test is done only for the first one. However, the caching works only
7830 if there are no expansions within the list itself or any sublists that it
7831 references. In other words, caching happens only for lists that are known to be
7832 the same each time they are referenced.
7833
7834 By default, there may be up to 16 named lists of each type. This limit can be
7835 extended by changing a compile-time variable. The use of domain and host lists
7836 is recommended for concepts such as local domains, relay domains, and relay
7837 hosts. The default configuration is set up like this.
7838
7839
7840
7841 .section "Named lists compared with macros" "SECID78"
7842 .cindex "list" "named compared with macro"
7843 .cindex "macro" "compared with named list"
7844 At first sight, named lists might seem to be no different from macros in the
7845 configuration file. However, macros are just textual substitutions. If you
7846 write
7847 .code
7848 ALIST = host1 : host2
7849 auth_advertise_hosts = !ALIST
7850 .endd
7851 it probably won't do what you want, because that is exactly the same as
7852 .code
7853 auth_advertise_hosts = !host1 : host2
7854 .endd
7855 Notice that the second host name is not negated. However, if you use a host
7856 list, and write
7857 .code
7858 hostlist alist = host1 : host2
7859 auth_advertise_hosts = ! +alist
7860 .endd
7861 the negation applies to the whole list, and so that is equivalent to
7862 .code
7863 auth_advertise_hosts = !host1 : !host2
7864 .endd
7865
7866
7867 .section "Named list caching" "SECID79"
7868 .cindex "list" "caching of named"
7869 .cindex "caching" "named lists"
7870 While processing a message, Exim caches the result of checking a named list if
7871 it is sure that the list is the same each time. In practice, this means that
7872 the cache operates only if the list contains no $ characters, which guarantees
7873 that it will not change when it is expanded. Sometimes, however, you may have
7874 an expanded list that you know will be the same each time within a given
7875 message. For example:
7876 .code
7877 domainlist special_domains = \
7878            ${lookup{$sender_host_address}cdb{/some/file}}
7879 .endd
7880 This provides a list of domains that depends only on the sending host's IP
7881 address. If this domain list is referenced a number of times (for example,
7882 in several ACL lines, or in several routers) the result of the check is not
7883 cached by default, because Exim does not know that it is going to be the
7884 same list each time.
7885
7886 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7887 cache the result anyway. For example:
7888 .code
7889 domainlist_cache special_domains = ${lookup{...
7890 .endd
7891 If you do this, you should be absolutely sure that caching is going to do
7892 the right thing in all cases. When in doubt, leave it out.
7893
7894
7895
7896 .section "Domain lists" "SECTdomainlist"
7897 .cindex "domain list" "patterns for"
7898 .cindex "list" "domain list"
7899 Domain lists contain patterns that are to be matched against a mail domain.
7900 The following types of item may appear in domain lists:
7901
7902 .ilist
7903 .cindex "primary host name"
7904 .cindex "host name" "matched in domain list"
7905 .oindex "&%primary_hostname%&"
7906 .cindex "domain list" "matching primary host name"
7907 .cindex "@ in a domain list"
7908 If a pattern consists of a single @ character, it matches the local host name,
7909 as set by the &%primary_hostname%& option (or defaulted). This makes it
7910 possible to use the same configuration file on several different hosts that
7911 differ only in their names.
7912 .next
7913 .cindex "@[] in a domain list"
7914 .cindex "domain list" "matching local IP interfaces"
7915 .cindex "domain literal"
7916 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7917 in square brackets (as in an email address that contains a domain literal), but
7918 only if that IP address is recognized as local for email routing purposes. The
7919 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7920 control which of a host's several IP addresses are treated as local.
7921 In today's Internet, the use of domain literals is controversial.
7922 .next
7923 .cindex "@mx_any"
7924 .cindex "@mx_primary"
7925 .cindex "@mx_secondary"
7926 .cindex "domain list" "matching MX pointers to local host"
7927 If a pattern consists of the string &`@mx_any`& it matches any domain that
7928 has an MX record pointing to the local host or to any host that is listed in
7929 .oindex "&%hosts_treat_as_local%&"
7930 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7931 are similar, except that the first matches only when a primary MX target is the
7932 local host, and the second only when no primary MX target is the local host,
7933 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7934 preference value &-- there may of course be more than one of them.
7935
7936 The MX lookup that takes place when matching a pattern of this type is
7937 performed with the resolver options for widening names turned off. Thus, for
7938 example, a single-component domain will &'not'& be expanded by adding the
7939 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7940 options of the &(dnslookup)& router for a discussion of domain widening.
7941
7942 Sometimes you may want to ignore certain IP addresses when using one of these
7943 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7944 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7945 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7946 on a router). For example:
7947 .code
7948 domains = @mx_any/ignore=127.0.0.1
7949 .endd
7950 This example matches any domain that has an MX record pointing to one of
7951 the local host's IP addresses other than 127.0.0.1.
7952
7953 The list of IP addresses is in fact processed by the same code that processes
7954 host lists, so it may contain CIDR-coded network specifications and it may also
7955 contain negative items.
7956
7957 Because the list of IP addresses is a sublist within a domain list, you have to
7958 be careful about delimiters if there is more than one address. Like any other
7959 list, the default delimiter can be changed. Thus, you might have:
7960 .code
7961 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7962           an.other.domain : ...
7963 .endd
7964 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7965 involved, it is easiest to change the delimiter for the main list as well:
7966 .code
7967 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7968           an.other.domain ? ...
7969 .endd
7970 .next
7971 .cindex "asterisk" "in domain list"
7972 .cindex "domain list" "asterisk in"
7973 .cindex "domain list" "matching &""ends with""&"
7974 If a pattern starts with an asterisk, the remaining characters of the pattern
7975 are compared with the terminating characters of the domain. The use of &"*"& in
7976 domain lists differs from its use in partial matching lookups. In a domain
7977 list, the character following the asterisk need not be a dot, whereas partial
7978 matching works only in terms of dot-separated components. For example, a domain
7979 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7980 &'cipher.key.ex'&.
7981
7982 .next
7983 .cindex "regular expressions" "in domain list"
7984 .cindex "domain list" "matching regular expression"
7985 If a pattern starts with a circumflex character, it is treated as a regular
7986 expression, and matched against the domain using a regular expression matching
7987 function. The circumflex is treated as part of the regular expression.
7988 Email domains are case-independent, so this regular expression match is by
7989 default case-independent, but you can make it case-dependent by starting it
7990 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7991 are given in chapter &<<CHAPregexp>>&.
7992
7993 &*Warning*&: Because domain lists are expanded before being processed, you
7994 must escape any backslash and dollar characters in the regular expression, or
7995 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7996 it is not to be expanded (unless you really do want to build a regular
7997 expression by expansion, of course).
7998 .next
7999 .cindex "lookup" "in domain list"
8000 .cindex "domain list" "matching by lookup"
8001 If a pattern starts with the name of a single-key lookup type followed by a
8002 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8003 must be a file name in a suitable format for the lookup type. For example, for
8004 &"cdb;"& it must be an absolute path:
8005 .code
8006 domains = cdb;/etc/mail/local_domains.cdb
8007 .endd
8008 The appropriate type of lookup is done on the file using the domain name as the
8009 key. In most cases, the data that is looked up is not used; Exim is interested
8010 only in whether or not the key is present in the file. However, when a lookup
8011 is used for the &%domains%& option on a router
8012 or a &%domains%& condition in an ACL statement, the data is preserved in the
8013 &$domain_data$& variable and can be referred to in other router options or
8014 other statements in the same ACL.
8015
8016 .next
8017 Any of the single-key lookup type names may be preceded by
8018 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8019 .code
8020 domains = partial-dbm;/partial/domains
8021 .endd
8022 This causes partial matching logic to be invoked; a description of how this
8023 works is given in section &<<SECTpartiallookup>>&.
8024
8025 .next
8026 .cindex "asterisk" "in lookup type"
8027 Any of the single-key lookup types may be followed by an asterisk. This causes
8028 a default lookup for a key consisting of a single asterisk to be done if the
8029 original lookup fails. This is not a useful feature when using a domain list to
8030 select particular domains (because any domain would match), but it might have
8031 value if the result of the lookup is being used via the &$domain_data$&
8032 expansion variable.
8033 .next
8034 If the pattern starts with the name of a query-style lookup type followed by a
8035 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8036 pattern must be an appropriate query for the lookup type, as described in
8037 chapter &<<CHAPfdlookup>>&. For example:
8038 .code
8039 hold_domains = mysql;select domain from holdlist \
8040   where domain = '${quote_mysql:$domain}';
8041 .endd
8042 In most cases, the data that is looked up is not used (so for an SQL query, for
8043 example, it doesn't matter what field you select). Exim is interested only in
8044 whether or not the query succeeds. However, when a lookup is used for the
8045 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8046 variable and can be referred to in other options.
8047 .next
8048 .cindex "domain list" "matching literal domain name"
8049 If none of the above cases apply, a caseless textual comparison is made
8050 between the pattern and the domain.
8051 .endlist
8052
8053 Here is an example that uses several different kinds of pattern:
8054 .code
8055 domainlist funny_domains = \
8056   @ : \
8057   lib.unseen.edu : \
8058   *.foundation.fict.example : \
8059   \N^[1-2]\d{3}\.fict\.example$\N : \
8060   partial-dbm;/opt/data/penguin/book : \
8061   nis;domains.byname : \
8062   nisplus;[name=$domain,status=local],domains.org_dir
8063 .endd
8064 There are obvious processing trade-offs among the various matching modes. Using
8065 an asterisk is faster than a regular expression, and listing a few names
8066 explicitly probably is too. The use of a file or database lookup is expensive,
8067 but may be the only option if hundreds of names are required. Because the
8068 patterns are tested in order, it makes sense to put the most commonly matched
8069 patterns earlier.
8070
8071
8072
8073 .section "Host lists" "SECThostlist"
8074 .cindex "host list" "patterns in"
8075 .cindex "list" "host list"
8076 Host lists are used to control what remote hosts are allowed to do. For
8077 example, some hosts may be allowed to use the local host as a relay, and some
8078 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8079 two different ways, by name or by IP address. In a host list, some types of
8080 pattern are matched to a host name, and some are matched to an IP address.
8081 You need to be particularly careful with this when single-key lookups are
8082 involved, to ensure that the right value is being used as the key.
8083
8084
8085 .section "Special host list patterns" "SECID80"
8086 .cindex "empty item in hosts list"
8087 .cindex "host list" "empty string in"
8088 If a host list item is the empty string, it matches only when no remote host is
8089 involved. This is the case when a message is being received from a local
8090 process using SMTP on the standard input, that is, when a TCP/IP connection is
8091 not used.
8092
8093 .cindex "asterisk" "in host list"
8094 The special pattern &"*"& in a host list matches any host or no host. Neither
8095 the IP address nor the name is actually inspected.
8096
8097
8098
8099 .section "Host list patterns that match by IP address" "SECThoslispatip"
8100 .cindex "host list" "matching IP addresses"
8101 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8102 the incoming address actually appears in the IPv6 host as
8103 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8104 list, it is converted into a traditional IPv4 address first. (Not all operating
8105 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8106 concerns.)
8107
8108 The following types of pattern in a host list check the remote host by
8109 inspecting its IP address:
8110
8111 .ilist
8112 If the pattern is a plain domain name (not a regular expression, not starting
8113 with *, not a lookup of any kind), Exim calls the operating system function
8114 to find the associated IP address(es). Exim uses the newer
8115 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8116 This typically causes a forward DNS lookup of the name. The result is compared
8117 with the IP address of the subject host.
8118
8119 If there is a temporary problem (such as a DNS timeout) with the host name
8120 lookup, a temporary error occurs. For example, if the list is being used in an
8121 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8122 temporary SMTP error code. If no IP address can be found for the host name,
8123 what happens is described in section &<<SECTbehipnot>>& below.
8124
8125 .next
8126 .cindex "@ in a host list"
8127 If the pattern is &"@"&, the primary host name is substituted and used as a
8128 domain name, as just described.
8129
8130 .next
8131 If the pattern is an IP address, it is matched against the IP address of the
8132 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8133 IPv6 addresses can be given in colon-separated format, but the colons have to
8134 be doubled so as not to be taken as item separators when the default list
8135 separator is used. IPv6 addresses are recognized even when Exim is compiled
8136 without IPv6 support. This means that if they appear in a host list on an
8137 IPv4-only host, Exim will not treat them as host names. They are just addresses
8138 that can never match a client host.
8139
8140 .next
8141 .cindex "@[] in a host list"
8142 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8143 the local host. For example, if the local host is an IPv4 host with one
8144 interface address 10.45.23.56, these two ACL statements have the same effect:
8145 .code
8146 accept hosts = 127.0.0.1 : 10.45.23.56
8147 accept hosts = @[]
8148 .endd
8149 .next
8150 .cindex "CIDR notation"
8151 If the pattern is an IP address followed by a slash and a mask length (for
8152 example 10.11.42.0/24), it is matched against the IP address of the subject
8153 host under the given mask. This allows, an entire network of hosts to be
8154 included (or excluded) by a single item. The mask uses CIDR notation; it
8155 specifies the number of address bits that must match, starting from the most
8156 significant end of the address.
8157
8158 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8159 of a range of addresses. It is the number of bits in the network portion of the
8160 address. The above example specifies a 24-bit netmask, so it matches all 256
8161 addresses in the 10.11.42.0 network. An item such as
8162 .code
8163 192.168.23.236/31
8164 .endd
8165 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8166 32 for an IPv4 address is the same as no mask at all; just a single address
8167 matches.
8168
8169 Here is another example which shows an IPv4 and an IPv6 network:
8170 .code
8171 recipient_unqualified_hosts = 192.168.0.0/16: \
8172                               3ffe::ffff::836f::::/48
8173 .endd
8174 The doubling of list separator characters applies only when these items
8175 appear inline in a host list. It is not required when indirecting via a file.
8176 For example:
8177 .code
8178 recipient_unqualified_hosts = /opt/exim/unqualnets
8179 .endd
8180 could make use of a file containing
8181 .code
8182 172.16.0.0/12
8183 3ffe:ffff:836f::/48
8184 .endd
8185 to have exactly the same effect as the previous example. When listing IPv6
8186 addresses inline, it is usually more convenient to use the facility for
8187 changing separator characters. This list contains the same two networks:
8188 .code
8189 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8190                                  3ffe:ffff:836f::/48
8191 .endd
8192 The separator is changed to semicolon by the leading &"<;"& at the start of the
8193 list.
8194 .endlist
8195
8196
8197
8198 .section "Host list patterns for single-key lookups by host address" &&&
8199          "SECThoslispatsikey"
8200 .cindex "host list" "lookup of IP address"
8201 When a host is to be identified by a single-key lookup of its complete IP
8202 address, the pattern takes this form:
8203 .display
8204 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8205 .endd
8206 For example:
8207 .code
8208 hosts_lookup = net-cdb;/hosts-by-ip.db
8209 .endd
8210 The text form of the IP address of the subject host is used as the lookup key.
8211 IPv6 addresses are converted to an unabbreviated form, using lower case
8212 letters, with dots as separators because colon is the key terminator in
8213 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8214 quoting the keys, but this is a facility that was added later.] The data
8215 returned by the lookup is not used.
8216
8217 .cindex "IP address" "masking"
8218 .cindex "host list" "masked IP address"
8219 Single-key lookups can also be performed using masked IP addresses, using
8220 patterns of this form:
8221 .display
8222 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8223 .endd
8224 For example:
8225 .code
8226 net24-dbm;/networks.db
8227 .endd
8228 The IP address of the subject host is masked using <&'number'&> as the mask
8229 length. A textual string is constructed from the masked value, followed by the
8230 mask, and this is used as the lookup key. For example, if the host's IP address
8231 is 192.168.34.6, the key that is looked up for the above example is
8232 &"192.168.34.0/24"&.
8233
8234 When an IPv6 address is converted to a string, dots are normally used instead
8235 of colons, so that keys in &(lsearch)& files need not contain colons (which
8236 terminate &(lsearch)& keys). This was implemented some time before the ability
8237 to quote keys was made available in &(lsearch)& files. However, the more
8238 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8239 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8240 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8241 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8242 addresses are always used.
8243
8244 Ideally, it would be nice to tidy up this anomalous situation by changing to
8245 colons in all cases, given that quoting is now available for &(lsearch)&.
8246 However, this would be an incompatible change that might break some existing
8247 configurations.
8248
8249 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8250 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8251 the former case the key strings include the mask value, whereas in the latter
8252 case the IP address is used on its own.
8253
8254
8255
8256 .section "Host list patterns that match by host name" "SECThoslispatnam"
8257 .cindex "host" "lookup failures"
8258 .cindex "unknown host name"
8259 .cindex "host list" "matching host name"
8260 There are several types of pattern that require Exim to know the name of the
8261 remote host. These are either wildcard patterns or lookups by name. (If a
8262 complete hostname is given without any wildcarding, it is used to find an IP
8263 address to match against, as described in section &<<SECThoslispatip>>&
8264 above.)
8265
8266 If the remote host name is not already known when Exim encounters one of these
8267 patterns, it has to be found from the IP address.
8268 Although many sites on the Internet are conscientious about maintaining reverse
8269 DNS data for their hosts, there are also many that do not do this.
8270 Consequently, a name cannot always be found, and this may lead to unwanted
8271 effects. Take care when configuring host lists with wildcarded name patterns.
8272 Consider what will happen if a name cannot be found.
8273
8274 Because of the problems of determining host names from IP addresses, matching
8275 against host names is not as common as matching against IP addresses.
8276
8277 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8278 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8279 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8280 are done can be changed by setting the &%host_lookup_order%& option. For
8281 security, once Exim has found one or more names, it looks up the IP addresses
8282 for these names and compares them with the IP address that it started with.
8283 Only those names whose IP addresses match are accepted. Any other names are
8284 discarded. If no names are left, Exim behaves as if the host name cannot be
8285 found. In the most common case there is only one name and one IP address.
8286
8287 There are some options that control what happens if a host name cannot be
8288 found. These are described in section &<<SECTbehipnot>>& below.
8289
8290 .cindex "host" "alias for"
8291 .cindex "alias for host"
8292 As a result of aliasing, hosts may have more than one name. When processing any
8293 of the following types of pattern, all the host's names are checked:
8294
8295 .ilist
8296 .cindex "asterisk" "in host list"
8297 If a pattern starts with &"*"& the remainder of the item must match the end of
8298 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8299 &'.b.c'&. This special simple form is provided because this is a very common
8300 requirement. Other kinds of wildcarding require the use of a regular
8301 expression.
8302 .next
8303 .cindex "regular expressions" "in host list"
8304 .cindex "host list" "regular expression in"
8305 If the item starts with &"^"& it is taken to be a regular expression which is
8306 matched against the host name. Host names are case-independent, so this regular
8307 expression match is by default case-independent, but you can make it
8308 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8309 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8310 example,
8311 .code
8312 ^(a|b)\.c\.d$
8313 .endd
8314 is a regular expression that matches either of the two hosts &'a.c.d'& or
8315 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8316 that backslash and dollar characters are not misinterpreted as part of the
8317 string expansion. The simplest way to do this is to use &`\N`& to mark that
8318 part of the string as non-expandable. For example:
8319 .code
8320 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8321 .endd
8322 &*Warning*&: If you want to match a complete host name, you must include the
8323 &`$`& terminating metacharacter in the regular expression, as in the above
8324 example. Without it, a match at the start of the host name is all that is
8325 required.
8326 .endlist
8327
8328
8329
8330
8331 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8332 .cindex "host" "lookup failures, permanent"
8333 While processing a host list, Exim may need to look up an IP address from a
8334 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8335 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8336 behaviour when it fails to find the information it is seeking is the same.
8337
8338 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8339 apply to temporary DNS errors, whose handling is described in the next section.
8340
8341 .cindex "&`+include_unknown`&"
8342 .cindex "&`+ignore_unknown`&"
8343 Exim parses a host list from left to right. If it encounters a permanent
8344 lookup failure in any item in the host list before it has found a match,
8345 Exim treats it as a failure and the default behavior is as if the host
8346 does not match the list. This may not always be what you want to happen.
8347 To change Exim's behaviour, the special items &`+include_unknown`& or
8348 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8349 not recognized in an indirected file).
8350
8351 .ilist
8352 If any item that follows &`+include_unknown`& requires information that
8353 cannot found, Exim behaves as if the host does match the list. For example,
8354 .code
8355 host_reject_connection = +include_unknown:*.enemy.ex
8356 .endd
8357 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8358 any hosts whose name it cannot find.
8359
8360 .next
8361 If any item that follows &`+ignore_unknown`& requires information that cannot
8362 be found, Exim ignores that item and proceeds to the rest of the list. For
8363 example:
8364 .code
8365 accept hosts = +ignore_unknown : friend.example : \
8366                192.168.4.5
8367 .endd
8368 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8369 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8370 name can be found for 192.168.4.5, it is rejected.
8371 .endlist
8372
8373 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8374 list. The effect of each one lasts until the next, or until the end of the
8375 list.
8376
8377 .section "Mixing wildcarded host names and addresses in host lists" &&&
8378          "SECTmixwilhos"
8379 .cindex "host list" "mixing names and addresses in"
8380
8381 This section explains the host/ip processing logic with the same concepts
8382 as the previous section, but specifically addresses what happens when a
8383 wildcarded hostname is one of the items in the hostlist.
8384
8385 .ilist
8386 If you have name lookups or wildcarded host names and
8387 IP addresses in the same host list, you should normally put the IP
8388 addresses first. For example, in an ACL you could have:
8389 .code
8390 accept hosts = 10.9.8.7 : *.friend.example
8391 .endd
8392 The reason you normally would order it this way lies in the
8393 left-to-right way that Exim processes lists.  It can test IP addresses
8394 without doing any DNS lookups, but when it reaches an item that requires
8395 a host name, it fails if it cannot find a host name to compare with the
8396 pattern. If the above list is given in the opposite order, the
8397 &%accept%& statement fails for a host whose name cannot be found, even
8398 if its IP address is 10.9.8.7.
8399
8400 .next
8401 If you really do want to do the name check first, and still recognize the IP
8402 address, you can rewrite the ACL like this:
8403 .code
8404 accept hosts = *.friend.example
8405 accept hosts = 10.9.8.7
8406 .endd
8407 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8408 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8409 &`+ignore_unknown`&, which was discussed in depth in the first example in
8410 this section.
8411 .endlist
8412
8413
8414 .section "Temporary DNS errors when looking up host information" &&&
8415          "SECTtemdnserr"
8416 .cindex "host" "lookup failures, temporary"
8417 .cindex "&`+include_defer`&"
8418 .cindex "&`+ignore_defer`&"
8419 A temporary DNS lookup failure normally causes a defer action (except when
8420 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8421 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8422 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8423 section. These options should be used with care, probably only in non-critical
8424 host lists such as whitelists.
8425
8426
8427
8428 .section "Host list patterns for single-key lookups by host name" &&&
8429          "SECThoslispatnamsk"
8430 .cindex "unknown host name"
8431 .cindex "host list" "matching host name"
8432 If a pattern is of the form
8433 .display
8434 <&'single-key-search-type'&>;<&'search-data'&>
8435 .endd
8436 for example
8437 .code
8438 dbm;/host/accept/list
8439 .endd
8440 a single-key lookup is performed, using the host name as its key. If the
8441 lookup succeeds, the host matches the item. The actual data that is looked up
8442 is not used.
8443
8444 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8445 keys in the file, not IP addresses. If you want to do lookups based on IP
8446 addresses, you must precede the search type with &"net-"& (see section
8447 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8448 two items in the same list, one doing an address lookup and one doing a name
8449 lookup, both using the same file.
8450
8451
8452
8453 .section "Host list patterns for query-style lookups" "SECID81"
8454 If a pattern is of the form
8455 .display
8456 <&'query-style-search-type'&>;<&'query'&>
8457 .endd
8458 the query is obeyed, and if it succeeds, the host matches the item. The actual
8459 data that is looked up is not used. The variables &$sender_host_address$& and
8460 &$sender_host_name$& can be used in the query. For example:
8461 .code
8462 hosts_lookup = pgsql;\
8463   select ip from hostlist where ip='$sender_host_address'
8464 .endd
8465 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8466 can use the &%sg%& expansion item to change this if you need to. If you want to
8467 use masked IP addresses in database queries, you can use the &%mask%& expansion
8468 operator.
8469
8470 If the query contains a reference to &$sender_host_name$&, Exim automatically
8471 looks up the host name if it has not already done so. (See section
8472 &<<SECThoslispatnam>>& for comments on finding host names.)
8473
8474 Historical note: prior to release 4.30, Exim would always attempt to find a
8475 host name before running the query, unless the search type was preceded by
8476 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8477 still recognized for query-style lookups, but its presence or absence has no
8478 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8479 See section &<<SECThoslispatsikey>>&.)
8480
8481
8482
8483
8484
8485 .section "Address lists" "SECTaddresslist"
8486 .cindex "list" "address list"
8487 .cindex "address list" "empty item"
8488 .cindex "address list" "patterns"
8489 Address lists contain patterns that are matched against mail addresses. There
8490 is one special case to be considered: the sender address of a bounce message is
8491 always empty. You can test for this by providing an empty item in an address
8492 list. For example, you can set up a router to process bounce messages by
8493 using this option setting:
8494 .code
8495 senders = :
8496 .endd
8497 The presence of the colon creates an empty item. If you do not provide any
8498 data, the list is empty and matches nothing. The empty sender can also be
8499 detected by a regular expression that matches an empty string,
8500 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8501
8502 Non-empty items in an address list can be straightforward email addresses. For
8503 example:
8504 .code
8505 senders = jbc@askone.example : hs@anacreon.example
8506 .endd
8507 A certain amount of wildcarding is permitted. If a pattern contains an @
8508 character, but is not a regular expression and does not begin with a
8509 semicolon-terminated lookup type (described below), the local part of the
8510 subject address is compared with the local part of the pattern, which may start
8511 with an asterisk. If the local parts match, the domain is checked in exactly
8512 the same way as for a pattern in a domain list. For example, the domain can be
8513 wildcarded, refer to a named list, or be a lookup:
8514 .code
8515 deny senders = *@*.spamming.site:\
8516                *@+hostile_domains:\
8517                bozo@partial-lsearch;/list/of/dodgy/sites:\
8518                *@dbm;/bad/domains.db
8519 .endd
8520 .cindex "local part" "starting with !"
8521 .cindex "address list" "local part starting with !"
8522 If a local part that begins with an exclamation mark is required, it has to be
8523 specified using a regular expression, because otherwise the exclamation mark is
8524 treated as a sign of negation, as is standard in lists.
8525
8526 If a non-empty pattern that is not a regular expression or a lookup does not
8527 contain an @ character, it is matched against the domain part of the subject
8528 address. The only two formats that are recognized this way are a literal
8529 domain, or a domain pattern that starts with *. In both these cases, the effect
8530 is the same as if &`*@`& preceded the pattern. For example:
8531 .code
8532 deny senders = enemy.domain : *.enemy.domain
8533 .endd
8534
8535 The following kinds of more complicated address list pattern can match any
8536 address, including the empty address that is characteristic of bounce message
8537 senders:
8538
8539 .ilist
8540 .cindex "regular expressions" "in address list"
8541 .cindex "address list" "regular expression in"
8542 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8543 done against the complete address, with the pattern as the regular expression.
8544 You must take care that backslash and dollar characters are not misinterpreted
8545 as part of the string expansion. The simplest way to do this is to use &`\N`&
8546 to mark that part of the string as non-expandable. For example:
8547 .code
8548 deny senders = \N^.*this.*@example\.com$\N : \
8549                \N^\d{8}.+@spamhaus.example$\N : ...
8550 .endd
8551 The &`\N`& sequences are removed by the expansion, so these items do indeed
8552 start with &"^"& by the time they are being interpreted as address patterns.
8553
8554 .next
8555 .cindex "address list" "lookup for complete address"
8556 Complete addresses can be looked up by using a pattern that starts with a
8557 lookup type terminated by a semicolon, followed by the data for the lookup. For
8558 example:
8559 .code
8560 deny senders = cdb;/etc/blocked.senders : \
8561   mysql;select address from blocked where \
8562   address='${quote_mysql:$sender_address}'
8563 .endd
8564 Both query-style and single-key lookup types can be used. For a single-key
8565 lookup type, Exim uses the complete address as the key. However, empty keys are
8566 not supported for single-key lookups, so a match against the empty address
8567 always fails. This restriction does not apply to query-style lookups.
8568
8569 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8570 cannot be used, and is ignored if specified, with an entry being written to the
8571 panic log.
8572 .cindex "*@ with single-key lookup"
8573 However, you can configure lookup defaults, as described in section
8574 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8575 default. For example, with this lookup:
8576 .code
8577 accept senders = lsearch*@;/some/file
8578 .endd
8579 the file could contains lines like this:
8580 .code
8581 user1@domain1.example
8582 *@domain2.example
8583 .endd
8584 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8585 that are tried is:
8586 .code
8587 nimrod@jaeger.example
8588 *@jaeger.example
8589 *
8590 .endd
8591 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8592 would mean that every address matches, thus rendering the test useless.
8593
8594 &*Warning 2*&: Do not confuse these two kinds of item:
8595 .code
8596 deny recipients = dbm*@;/some/file
8597 deny recipients = *@dbm;/some/file
8598 .endd
8599 The first does a whole address lookup, with defaulting, as just described,
8600 because it starts with a lookup type. The second matches the local part and
8601 domain independently, as described in a bullet point below.
8602 .endlist
8603
8604
8605 The following kinds of address list pattern can match only non-empty addresses.
8606 If the subject address is empty, a match against any of these pattern types
8607 always fails.
8608
8609
8610 .ilist
8611 .cindex "@@ with single-key lookup"
8612 .cindex "address list" "@@ lookup type"
8613 .cindex "address list" "split local part and domain"
8614 If a pattern starts with &"@@"& followed by a single-key lookup item
8615 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8616 split into a local part and a domain. The domain is looked up in the file. If
8617 it is not found, there is no match. If it is found, the data that is looked up
8618 from the file is treated as a colon-separated list of local part patterns, each
8619 of which is matched against the subject local part in turn.
8620
8621 .cindex "asterisk" "in address list"
8622 The lookup may be a partial one, and/or one involving a search for a default
8623 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8624 patterns that are looked up can be regular expressions or begin with &"*"&, or
8625 even be further lookups. They may also be independently negated. For example,
8626 with
8627 .code
8628 deny senders = @@dbm;/etc/reject-by-domain
8629 .endd
8630 the data from which the DBM file is built could contain lines like
8631 .code
8632 baddomain.com:  !postmaster : *
8633 .endd
8634 to reject all senders except &%postmaster%& from that domain.
8635
8636 .cindex "local part" "starting with !"
8637 If a local part that actually begins with an exclamation mark is required, it
8638 has to be specified using a regular expression. In &(lsearch)& files, an entry
8639 may be split over several lines by indenting the second and subsequent lines,
8640 but the separating colon must still be included at line breaks. White space
8641 surrounding the colons is ignored. For example:
8642 .code
8643 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8644   spammer3 : spammer4
8645 .endd
8646 As in all colon-separated lists in Exim, a colon can be included in an item by
8647 doubling.
8648
8649 If the last item in the list starts with a right angle-bracket, the remainder
8650 of the item is taken as a new key to look up in order to obtain a continuation
8651 list of local parts. The new key can be any sequence of characters. Thus one
8652 might have entries like
8653 .code
8654 aol.com: spammer1 : spammer 2 : >*
8655 xyz.com: spammer3 : >*
8656 *:       ^\d{8}$
8657 .endd
8658 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8659 local parts for all domains, in addition to the specific local parts listed for
8660 each domain. Of course, using this feature costs another lookup each time a
8661 chain is followed, but the effort needed to maintain the data is reduced.
8662
8663 .cindex "loop" "in lookups"
8664 It is possible to construct loops using this facility, and in order to catch
8665 them, the chains may be no more than fifty items long.
8666
8667 .next
8668 The @@<&'lookup'&> style of item can also be used with a query-style
8669 lookup, but in this case, the chaining facility is not available. The lookup
8670 can only return a single list of local parts.
8671 .endlist
8672
8673 &*Warning*&: There is an important difference between the address list items
8674 in these two examples:
8675 .code
8676 senders = +my_list
8677 senders = *@+my_list
8678 .endd
8679 In the first one, &`my_list`& is a named address list, whereas in the second
8680 example it is a named domain list.
8681
8682
8683
8684
8685 .section "Case of letters in address lists" "SECTcasletadd"
8686 .cindex "case of local parts"
8687 .cindex "address list" "case forcing"
8688 .cindex "case forcing in address lists"
8689 Domains in email addresses are always handled caselessly, but for local parts
8690 case may be significant on some systems (see &%caseful_local_part%& for how
8691 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8692 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8693 blocking lists should be done in a case-independent manner. Since most address
8694 lists in Exim are used for this kind of control, Exim attempts to do this by
8695 default.
8696
8697 The domain portion of an address is always lowercased before matching it to an
8698 address list. The local part is lowercased by default, and any string
8699 comparisons that take place are done caselessly. This means that the data in
8700 the address list itself, in files included as plain file names, and in any file
8701 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8702 keys in files that are looked up by a search type other than &(lsearch)& (which
8703 works caselessly) must be in lower case, because these lookups are not
8704 case-independent.
8705
8706 .cindex "&`+caseful`&"
8707 To allow for the possibility of caseful address list matching, if an item in
8708 an address list is the string &"+caseful"&, the original case of the local
8709 part is restored for any comparisons that follow, and string comparisons are no
8710 longer case-independent. This does not affect the domain, which remains in
8711 lower case. However, although independent matches on the domain alone are still
8712 performed caselessly, regular expressions that match against an entire address
8713 become case-sensitive after &"+caseful"& has been seen.
8714
8715
8716
8717 .section "Local part lists" "SECTlocparlis"
8718 .cindex "list" "local part list"
8719 .cindex "local part" "list"
8720 Case-sensitivity in local part lists is handled in the same way as for address
8721 lists, as just described. The &"+caseful"& item can be used if required. In a
8722 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8723 set false, the subject is lowercased and the matching is initially
8724 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8725 matching in the local part list, but not elsewhere in the router. If
8726 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8727 option is case-sensitive from the start.
8728
8729 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8730 comments are handled in the same way as address lists &-- they are recognized
8731 only if the # is preceded by white space or the start of the line.
8732 Otherwise, local part lists are matched in the same way as domain lists, except
8733 that the special items that refer to the local host (&`@`&, &`@[]`&,
8734 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8735 Refer to section &<<SECTdomainlist>>& for details of the other available item
8736 types.
8737 .ecindex IIDdohoadli
8738
8739
8740
8741
8742 . ////////////////////////////////////////////////////////////////////////////
8743 . ////////////////////////////////////////////////////////////////////////////
8744
8745 .chapter "String expansions" "CHAPexpand"
8746 .scindex IIDstrexp "expansion" "of strings"
8747 Many strings in Exim's run time configuration are expanded before use. Some of
8748 them are expanded every time they are used; others are expanded only once.
8749
8750 When a string is being expanded it is copied verbatim from left to right except
8751 when a dollar or backslash character is encountered. A dollar specifies the
8752 start of a portion of the string that is interpreted and replaced as described
8753 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8754 escape character, as described in the following section.
8755
8756 Whether a string is expanded depends upon the context.  Usually this is solely
8757 dependent upon the option for which a value is sought; in this documentation,
8758 options for which string expansion is performed are marked with &dagger; after
8759 the data type.  ACL rules always expand strings.  A couple of expansion
8760 conditions do not expand some of the brace-delimited branches, for security
8761 reasons.
8762
8763
8764
8765 .section "Literal text in expanded strings" "SECTlittext"
8766 .cindex "expansion" "including literal text"
8767 An uninterpreted dollar can be included in an expanded string by putting a
8768 backslash in front of it. A backslash can be used to prevent any special
8769 character being treated specially in an expansion, including backslash itself.
8770 If the string appears in quotes in the configuration file, two backslashes are
8771 required because the quotes themselves cause interpretation of backslashes when
8772 the string is read in (see section &<<SECTstrings>>&).
8773
8774 .cindex "expansion" "non-expandable substrings"
8775 A portion of the string can specified as non-expandable by placing it between
8776 two occurrences of &`\N`&. This is particularly useful for protecting regular
8777 expressions, which often contain backslashes and dollar signs. For example:
8778 .code
8779 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8780 .endd
8781 On encountering the first &`\N`&, the expander copies subsequent characters
8782 without interpretation until it reaches the next &`\N`& or the end of the
8783 string.
8784
8785
8786
8787 .section "Character escape sequences in expanded strings" "SECID82"
8788 .cindex "expansion" "escape sequences"
8789 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8790 expanded string is recognized as an escape sequence for the character newline,
8791 carriage return, or tab, respectively. A backslash followed by up to three
8792 octal digits is recognized as an octal encoding for a single character, and a
8793 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8794 encoding.
8795
8796 These escape sequences are also recognized in quoted strings when they are read
8797 in. Their interpretation in expansions as well is useful for unquoted strings,
8798 and for other cases such as looked-up strings that are then expanded.
8799
8800
8801 .section "Testing string expansions" "SECID83"
8802 .cindex "expansion" "testing"
8803 .cindex "testing" "string expansion"
8804 .oindex "&%-be%&"
8805 Many expansions can be tested by calling Exim with the &%-be%& option. This
8806 takes the command arguments, or lines from the standard input if there are no
8807 arguments, runs them through the string expansion code, and writes the results
8808 to the standard output. Variables based on configuration values are set up, but
8809 since no message is being processed, variables such as &$local_part$& have no
8810 value. Nevertheless the &%-be%& option can be useful for checking out file and
8811 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8812 and &%nhash%&.
8813
8814 Exim gives up its root privilege when it is called with the &%-be%& option, and
8815 instead runs under the uid and gid it was called with, to prevent users from
8816 using &%-be%& for reading files to which they do not have access.
8817
8818 .oindex "&%-bem%&"
8819 If you want to test expansions that include variables whose values are taken
8820 from a message, there are two other options that can be used. The &%-bem%&
8821 option is like &%-be%& except that it is followed by a file name. The file is
8822 read as a message before doing the test expansions. For example:
8823 .code
8824 exim -bem /tmp/test.message '$h_subject:'
8825 .endd
8826 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8827 Exim message identifier. For example:
8828 .code
8829 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8830 .endd
8831 This loads the message from Exim's spool before doing the test expansions, and
8832 is therefore restricted to admin users.
8833
8834
8835 .section "Forced expansion failure" "SECTforexpfai"
8836 .cindex "expansion" "forced failure"
8837 A number of expansions that are described in the following section have
8838 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8839 (which are sometimes called &"curly brackets"&). Which of the two strings is
8840 used depends on some condition that is evaluated as part of the expansion. If,
8841 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8842 the entire string expansion fails in a way that can be detected by the code
8843 that requested the expansion. This is called &"forced expansion failure"&, and
8844 its consequences depend on the circumstances. In some cases it is no different
8845 from any other expansion failure, but in others a different action may be
8846 taken. Such variations are mentioned in the documentation of the option that is
8847 being expanded.
8848
8849
8850
8851
8852 .section "Expansion items" "SECTexpansionitems"
8853 The following items are recognized in expanded strings. White space may be used
8854 between sub-items that are keywords or substrings enclosed in braces inside an
8855 outer set of braces, to improve readability. &*Warning*&: Within braces,
8856 white space is significant.
8857
8858 .vlist
8859 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8860 .cindex "expansion" "variables"
8861 Substitute the contents of the named variable, for example:
8862 .code
8863 $local_part
8864 ${domain}
8865 .endd
8866 The second form can be used to separate the name from subsequent alphanumeric
8867 characters. This form (using braces) is available only for variables; it does
8868 &'not'& apply to message headers. The names of the variables are given in
8869 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8870 given, the expansion fails.
8871
8872 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8873 .cindex "expansion" "operators"
8874 The string is first itself expanded, and then the operation specified by
8875 <&'op'&> is applied to it. For example:
8876 .code
8877 ${lc:$local_part}
8878 .endd
8879 The string starts with the first character after the colon, which may be
8880 leading white space. A list of operators is given in section &<<SECTexpop>>&
8881 below. The operator notation is used for simple expansion items that have just
8882 one argument, because it reduces the number of braces and therefore makes the
8883 string easier to understand.
8884
8885 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8886 This item inserts &"basic"& header lines. It is described with the &%header%&
8887 expansion item below.
8888
8889
8890 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8891 .cindex "expansion" "calling an acl"
8892 .cindex "&%acl%&" "call from expansion"
8893 The name and zero to nine argument strings are first expanded separately.  The expanded
8894 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8895 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8896 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8897 and may use the variables; if another acl expansion is used the values
8898 are restored after it returns.  If the ACL sets
8899 a value using a "message =" modifier and returns accept or deny, the value becomes
8900 the result of the expansion.
8901 If no message is set and the ACL returns accept or deny
8902 the expansion result is an empty string.
8903 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8904
8905
8906 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8907        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8908 .cindex "expansion" "extracting cerificate fields"
8909 .cindex "&%certextract%&" "certificate fields"
8910 .cindex "certificate" "extracting fields"
8911 The <&'certificate'&> must be a variable of type certificate.
8912 The field name is expanded and used to retrive the relevant field from
8913 the certificate.  Supported fields are:
8914 .display
8915 &`version        `&
8916 &`serial_number  `&
8917 &`subject        `& RFC4514 DN
8918 &`issuer         `& RFC4514 DN
8919 &`notbefore      `& time
8920 &`notafter       `& time
8921 &`sig_algorithm  `&
8922 &`signature      `&
8923 &`subj_altname   `& tagged list
8924 &`ocsp_uri       `& list
8925 &`crl_uri        `& list
8926 .endd
8927 If the field is found,
8928 <&'string2'&> is expanded, and replaces the whole item;
8929 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8930 variable &$value$& contains the value that has been extracted. Afterwards, it
8931 is restored to any previous value it might have had.
8932
8933 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8934 key is not found. If {<&'string2'&>} is also omitted, the value that was
8935 extracted is used.
8936
8937 Some field names take optional modifiers, appended and separated by commas.
8938
8939 The field selectors marked as "RFC4514" above
8940 output a Distinguished Name string which is
8941 not quite
8942 parseable by Exim as a comma-separated tagged list
8943 (the exceptions being elements containin commas).
8944 RDN elements of a single type may be selected by
8945 a modifier of the type label; if so the expansion
8946 result is a list (newline-separated by default).
8947 The separator may be changed by another modifer of
8948 a right angle-bracket followed immediately by the new separator.
8949 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8950
8951 The field selectors marked as "time" above
8952 take an optional modifier of "int"
8953 for which the result is the number of seconds since epoch.
8954 Otherwise the result is a human-readable string
8955 in the timezone selected by the main "timezone" option.
8956
8957 The field selectors marked as "list" above return a list,
8958 newline-separated by default,
8959 (embedded separator characters in elements are doubled).
8960 The separator may be changed by a modifier of
8961 a right angle-bracket followed immediately by the new separator.
8962
8963 The field selectors marked as "tagged" above
8964 prefix each list element with a type string and an equals sign.
8965 Elements of only one type may be selected by a modifier
8966 which is one of "dns", "uri" or "mail";
8967 if so the elenment tags are omitted.
8968
8969 If not otherwise noted field values are presented in human-readable form.
8970
8971 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8972        {*&<&'arg'&>&*}...}*&"
8973 .cindex &%dlfunc%&
8974 This expansion dynamically loads and then calls a locally-written C function.
8975 This functionality is available only if Exim is compiled with
8976 .code
8977 EXPAND_DLFUNC=yes
8978 .endd
8979 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8980 object so that it doesn't reload the same object file in the same Exim process
8981 (but of course Exim does start new processes frequently).
8982
8983 There may be from zero to eight arguments to the function. When compiling
8984 a local function that is to be called in this way, &_local_scan.h_& should be
8985 included. The Exim variables and functions that are defined by that API
8986 are also available for dynamically loaded functions. The function itself
8987 must have the following type:
8988 .code
8989 int dlfunction(uschar **yield, int argc, uschar *argv[])
8990 .endd
8991 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8992 function should return one of the following values:
8993
8994 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8995 into the expanded string that is being built.
8996
8997 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8998 from &'yield'&, if it is set.
8999
9000 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9001 taken from &'yield'& if it is set.
9002
9003 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9004
9005 When compiling a function that is to be used in this way with gcc,
9006 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9007 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9008
9009 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9010        {*&<&'string3'&>&*}}*&"
9011 .cindex "expansion" "extracting substrings by key"
9012 .cindex "&%extract%&" "substrings by key"
9013 The key and <&'string1'&> are first expanded separately. Leading and trailing
9014 white space is removed from the key (but not from any of the strings). The key
9015 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9016 form:
9017 .display
9018 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9019 .endd
9020 .vindex "&$value$&"
9021 where the equals signs and spaces (but not both) are optional. If any of the
9022 values contain white space, they must be enclosed in double quotes, and any
9023 values that are enclosed in double quotes are subject to escape processing as
9024 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9025 for the value that corresponds to the key. The search is case-insensitive. If
9026 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9027 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9028 variable &$value$& contains the value that has been extracted. Afterwards, it
9029 is restored to any previous value it might have had.
9030
9031 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9032 key is not found. If {<&'string2'&>} is also omitted, the value that was
9033 extracted is used. Thus, for example, these two expansions are identical, and
9034 yield &"2001"&:
9035 .code
9036 ${extract{gid}{uid=1984 gid=2001}}
9037 ${extract{gid}{uid=1984 gid=2001}{$value}}
9038 .endd
9039 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9040 appear, for example:
9041 .code
9042 ${extract{Z}{A=... B=...}{$value} fail }
9043 .endd
9044 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9045 {<&'string2'&>} must be present for &"fail"& to be recognized.
9046
9047
9048 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9049         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9050 .cindex "expansion" "extracting substrings by number"
9051 .cindex "&%extract%&" "substrings by number"
9052 The <&'number'&> argument must consist entirely of decimal digits,
9053 apart from leading and trailing white space, which is ignored.
9054 This is what distinguishes this form of &%extract%& from the previous kind. It
9055 behaves in the same way, except that, instead of extracting a named field, it
9056 extracts from <&'string1'&> the field whose number is given as the first
9057 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9058 <&'string3'&> as before.
9059
9060 The fields in the string are separated by any one of the characters in the
9061 separator string. These may include space or tab characters.
9062 The first field is numbered one. If the number is negative, the fields are
9063 counted from the end of the string, with the rightmost one numbered -1. If the
9064 number given is zero, the entire string is returned. If the modulus of the
9065 number is greater than the number of fields in the string, the result is the
9066 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9067 provided. For example:
9068 .code
9069 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9070 .endd
9071 yields &"42"&, and
9072 .code
9073 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9074 .endd
9075 yields &"99"&. Two successive separators mean that the field between them is
9076 empty (for example, the fifth field above).
9077
9078
9079 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9080 .cindex "list" "selecting by condition"
9081 .cindex "expansion" "selecting from list by condition"
9082 .vindex "&$item$&"
9083 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9084 default, but the separator can be changed in the usual way. For each item
9085 in this list, its value is place in &$item$&, and then the condition is
9086 evaluated. If the condition is true, &$item$& is added to the output as an
9087 item in a new list; if the condition is false, the item is discarded. The
9088 separator used for the output list is the same as the one used for the
9089 input, but a separator setting is not included in the output. For example:
9090 .code
9091 ${filter{a:b:c}{!eq{$item}{b}}
9092 .endd
9093 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9094 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9095
9096
9097 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9098 .cindex "hash function" "textual"
9099 .cindex "expansion" "textual hash"
9100 This is a textual hashing function, and was the first to be implemented in
9101 early versions of Exim. In current releases, there are other hashing functions
9102 (numeric, MD5, and SHA-1), which are described below.
9103
9104 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9105 <&'n'&>. If you are using fixed values for these numbers, that is, if
9106 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9107 use the simpler operator notation that avoids some of the braces:
9108 .code
9109 ${hash_<n>_<m>:<string>}
9110 .endd
9111 The second number is optional (in both notations). If <&'n'&> is greater than
9112 or equal to the length of the string, the expansion item returns the string.
9113 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9114 function to the string. The new string consists of characters taken from the
9115 first <&'m'&> characters of the string
9116 .code
9117 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9118 .endd
9119 If <&'m'&> is not present the value 26 is used, so that only lower case
9120 letters appear. For example:
9121 .display
9122 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9123 &`$hash{5}{monty}}           `&   yields  &`monty`&
9124 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9125 .endd
9126
9127 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9128         &*$h_*&<&'header&~name'&>&*:*&" &&&
9129        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9130         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9131        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9132         &*$rh_*&<&'header&~name'&>&*:*&"
9133 .cindex "expansion" "header insertion"
9134 .vindex "&$header_$&"
9135 .vindex "&$bheader_$&"
9136 .vindex "&$rheader_$&"
9137 .cindex "header lines" "in expansion strings"
9138 .cindex "header lines" "character sets"
9139 .cindex "header lines" "decoding"
9140 Substitute the contents of the named message header line, for example
9141 .code
9142 $header_reply-to:
9143 .endd
9144 The newline that terminates a header line is not included in the expansion, but
9145 internal newlines (caused by splitting the header line over several physical
9146 lines) may be present.
9147
9148 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9149 the data in the header line is interpreted.
9150
9151 .ilist
9152 .cindex "white space" "in header lines"
9153 &%rheader%& gives the original &"raw"& content of the header line, with no
9154 processing at all, and without the removal of leading and trailing white space.
9155
9156 .next
9157 .cindex "base64 encoding" "in header lines"
9158 &%bheader%& removes leading and trailing white space, and then decodes base64
9159 or quoted-printable MIME &"words"& within the header text, but does no
9160 character set translation. If decoding of what looks superficially like a MIME
9161 &"word"& fails, the raw string is returned. If decoding
9162 .cindex "binary zero" "in header line"
9163 produces a binary zero character, it is replaced by a question mark &-- this is
9164 what Exim does for binary zeros that are actually received in header lines.
9165
9166 .next
9167 &%header%& tries to translate the string as decoded by &%bheader%& to a
9168 standard character set. This is an attempt to produce the same string as would
9169 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9170 returned. Translation is attempted only on operating systems that support the
9171 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9172 a system Makefile or in &_Local/Makefile_&.
9173 .endlist ilist
9174
9175 In a filter file, the target character set for &%header%& can be specified by a
9176 command of the following form:
9177 .code
9178 headers charset "UTF-8"
9179 .endd
9180 This command affects all references to &$h_$& (or &$header_$&) expansions in
9181 subsequently obeyed filter commands. In the absence of this command, the target
9182 character set in a filter is taken from the setting of the &%headers_charset%&
9183 option in the runtime configuration. The value of this option defaults to the
9184 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9185 ISO-8859-1.
9186
9187 Header names follow the syntax of RFC 2822, which states that they may contain
9188 any printing characters except space and colon. Consequently, curly brackets
9189 &'do not'& terminate header names, and should not be used to enclose them as
9190 if they were variables. Attempting to do so causes a syntax error.
9191
9192 Only header lines that are common to all copies of a message are visible to
9193 this mechanism. These are the original header lines that are received with the
9194 message, and any that are added by an ACL statement or by a system
9195 filter. Header lines that are added to a particular copy of a message by a
9196 router or transport are not accessible.
9197
9198 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9199 before the DATA ACL, because the header structure is not set up until the
9200 message is received. Header lines that are added in a RCPT ACL (for example)
9201 are saved until the message's incoming header lines are available, at which
9202 point they are added. When a DATA ACL is running, however, header lines added
9203 by earlier ACLs are visible.
9204
9205 Upper case and lower case letters are synonymous in header names. If the
9206 following character is white space, the terminating colon may be omitted, but
9207 this is not recommended, because you may then forget it when it is needed. When
9208 white space terminates the header name, it is included in the expanded string.
9209 If the message does not contain the given header, the expansion item is
9210 replaced by an empty string. (See the &%def%& condition in section
9211 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9212
9213 If there is more than one header with the same name, they are all concatenated
9214 to form the substitution string, up to a maximum length of 64K. Unless
9215 &%rheader%& is being used, leading and trailing white space is removed from
9216 each header before concatenation, and a completely empty header is ignored. A
9217 newline character is then inserted between non-empty headers, but there is no
9218 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9219 those headers that contain lists of addresses, a comma is also inserted at the
9220 junctions between headers. This does not happen for the &%rheader%& expansion.
9221
9222
9223 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9224 .cindex "expansion" "hmac hashing"
9225 .cindex &%hmac%&
9226 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9227 shared secret and some text into a message authentication code, as specified in
9228 RFC 2104. This differs from &`${md5:secret_text...}`& or
9229 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9230 cryptographic hash, allowing for authentication that is not possible with MD5
9231 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9232 present. For example:
9233 .code
9234 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9235 .endd
9236 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9237 produces:
9238 .code
9239 dd97e3ba5d1a61b5006108f8c8252953
9240 .endd
9241 As an example of how this might be used, you might put in the main part of
9242 an Exim configuration:
9243 .code
9244 SPAMSCAN_SECRET=cohgheeLei2thahw
9245 .endd
9246 In a router or a transport you could then have:
9247 .code
9248 headers_add = \
9249   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9250   ${hmac{md5}{SPAMSCAN_SECRET}\
9251   {${primary_hostname},${message_exim_id},$h_message-id:}}
9252 .endd
9253 Then given a message, you can check where it was scanned by looking at the
9254 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9255 this header line is authentic by recomputing the authentication code from the
9256 host name, message ID and the &'Message-id:'& header line. This can be done
9257 using Exim's &%-be%& option, or by other means, for example by using the
9258 &'hmac_md5_hex()'& function in Perl.
9259
9260
9261 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9262 .cindex "expansion" "conditional"
9263 .cindex "&%if%&, expansion item"
9264 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9265 item; otherwise <&'string2'&> is used. The available conditions are described
9266 in section &<<SECTexpcond>>& below. For example:
9267 .code
9268 ${if eq {$local_part}{postmaster} {yes}{no} }
9269 .endd
9270 The second string need not be present; if it is not and the condition is not
9271 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9272 be present instead of the second string (without any curly brackets). In this
9273 case, the expansion is forced to fail if the condition is not true (see section
9274 &<<SECTforexpfai>>&).
9275
9276 If both strings are omitted, the result is the string &`true`& if the condition
9277 is true, and the empty string if the condition is false. This makes it less
9278 cumbersome to write custom ACL and router conditions. For example, instead of
9279 .code
9280 condition = ${if >{$acl_m4}{3}{true}{false}}
9281 .endd
9282 you can use
9283 .code
9284 condition = ${if >{$acl_m4}{3}}
9285 .endd
9286
9287 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9288 .cindex "expansion" "string truncation"
9289 .cindex "&%length%& expansion item"
9290 The &%length%& item is used to extract the initial portion of a string. Both
9291 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9292 you are using a fixed value for the number, that is, if <&'string1'&> does not
9293 change when expanded, you can use the simpler operator notation that avoids
9294 some of the braces:
9295 .code
9296 ${length_<n>:<string>}
9297 .endd
9298 The result of this item is either the first <&'n'&> characters or the whole
9299 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9300 &%strlen%&, which gives the length of a string.
9301
9302
9303 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9304         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9305 .cindex "expansion" "extracting list elements by number"
9306 .cindex "&%listextract%&" "extract list elements by number"
9307 .cindex "list" "extracting elements by number"
9308 The <&'number'&> argument must consist entirely of decimal digits,
9309 apart from an optional leading minus,
9310 and leading and trailing white space (which is ignored).
9311
9312 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9313 default, but the separator can be changed in the usual way.
9314
9315 The first field of the list is numbered one.
9316 If the number is negative, the fields are
9317 counted from the end of the list, with the rightmost one numbered -1.
9318 The numbered element of the list is extracted and placed in &$value$&,
9319 then <&'string2'&> is expanded as the result.
9320
9321 If the modulus of the
9322 number is zero or greater than the number of fields in the string,
9323 the result is the expansion of <&'string3'&>.
9324
9325 For example:
9326 .code
9327 ${listextract{2}{x:42:99}}
9328 .endd
9329 yields &"42"&, and
9330 .code
9331 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9332 .endd
9333 yields &"result: 99"&.
9334
9335 If {<&'string3'&>} is omitted, an empty string is used for string3.
9336 If {<&'string2'&>} is also omitted, the value that was
9337 extracted is used.
9338 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9339
9340
9341 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9342         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9343 This is the first of one of two different types of lookup item, which are both
9344 described in the next item.
9345
9346 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9347         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9348 .cindex "expansion" "lookup in"
9349 .cindex "file" "lookups"
9350 .cindex "lookup" "in expanded string"
9351 The two forms of lookup item specify data lookups in files and databases, as
9352 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9353 lookups, and the second is used for query-style lookups. The <&'key'&>,
9354 <&'file'&>, and <&'query'&> strings are expanded before use.
9355
9356 If there is any white space in a lookup item which is part of a filter command,
9357 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9358 other place where white space is significant, the lookup item must be enclosed
9359 in double quotes. The use of data lookups in users' filter files may be locked
9360 out by the system administrator.
9361
9362 .vindex "&$value$&"
9363 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9364 During its expansion, the variable &$value$& contains the data returned by the
9365 lookup. Afterwards it reverts to the value it had previously (at the outer
9366 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9367 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9368 string on failure. If <&'string2'&> is provided, it can itself be a nested
9369 lookup, thus providing a mechanism for looking up a default value when the
9370 original lookup fails.
9371
9372 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9373 data for the outer lookup while the parameters of the second lookup are
9374 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9375 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9376 appear, and in this case, if the lookup fails, the entire expansion is forced
9377 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9378 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9379 successful lookup, and nothing in the case of failure.
9380
9381 For single-key lookups, the string &"partial"& is permitted to precede the
9382 search type in order to do partial matching, and * or *@ may follow a search
9383 type to request default lookups if the key does not match (see sections
9384 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9385
9386 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9387 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9388 and non-wild parts of the key during the expansion of the replacement text.
9389 They return to their previous values at the end of the lookup item.
9390
9391 This example looks up the postmaster alias in the conventional alias file:
9392 .code
9393 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9394 .endd
9395 This example uses NIS+ to look up the full name of the user corresponding to
9396 the local part of an address, forcing the expansion to fail if it is not found:
9397 .code
9398 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9399   {$value}fail}
9400 .endd
9401
9402
9403 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9404 .cindex "expansion" "list creation"
9405 .vindex "&$item$&"
9406 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9407 default, but the separator can be changed in the usual way. For each item
9408 in this list, its value is place in &$item$&, and then <&'string2'&> is
9409 expanded and added to the output as an item in a new list. The separator used
9410 for the output list is the same as the one used for the input, but a separator
9411 setting is not included in the output. For example:
9412 .code
9413 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9414 .endd
9415 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9416 value of &$item$& is restored to what it was before. See also the &*filter*&
9417 and &*reduce*& expansion items.
9418
9419 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9420 .cindex "expansion" "numeric hash"
9421 .cindex "hash function" "numeric"
9422 The three strings are expanded; the first two must yield numbers. Call them
9423 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9424 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9425 can use the simpler operator notation that avoids some of the braces:
9426 .code
9427 ${nhash_<n>_<m>:<string>}
9428 .endd
9429 The second number is optional (in both notations). If there is only one number,
9430 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9431 processed by a div/mod hash function that returns two numbers, separated by a
9432 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9433 example,
9434 .code
9435 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9436 .endd
9437 returns the string &"6/33"&.
9438
9439
9440
9441 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9442 .cindex "Perl" "use in expanded string"
9443 .cindex "expansion" "calling Perl from"
9444 This item is available only if Exim has been built to include an embedded Perl
9445 interpreter. The subroutine name and the arguments are first separately
9446 expanded, and then the Perl subroutine is called with those arguments. No
9447 additional arguments need be given; the maximum number permitted, including the
9448 name of the subroutine, is nine.
9449
9450 The return value of the subroutine is inserted into the expanded string, unless
9451 the return value is &%undef%&. In that case, the expansion fails in the same
9452 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9453 Whatever you return is evaluated in a scalar context. For example, if you
9454 return the name of a Perl vector, the return value is the size of the vector,
9455 not its contents.
9456
9457 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9458 with the error message that was passed to &%die%&. More details of the embedded
9459 Perl facility are given in chapter &<<CHAPperl>>&.
9460
9461 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9462 out the use of this expansion item in filter files.
9463
9464
9465 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9466 .cindex "&%prvs%& expansion item"
9467 The first argument is a complete email address and the second is secret
9468 keystring. The third argument, specifying a key number, is optional. If absent,
9469 it defaults to 0. The result of the expansion is a prvs-signed email address,
9470 to be typically used with the &%return_path%& option on an &(smtp)& transport
9471 as part of a bounce address tag validation (BATV) scheme. For more discussion
9472 and an example, see section &<<SECTverifyPRVS>>&.
9473
9474 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9475         {*&<&'string'&>&*}}*&"
9476 .cindex "&%prvscheck%& expansion item"
9477 This expansion item is the complement of the &%prvs%& item. It is used for
9478 checking prvs-signed addresses. If the expansion of the first argument does not
9479 yield a syntactically valid prvs-signed address, the whole item expands to the
9480 empty string. When the first argument does expand to a syntactically valid
9481 prvs-signed address, the second argument is expanded, with the prvs-decoded
9482 version of the address and the key number extracted from the address in the
9483 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9484
9485 These two variables can be used in the expansion of the second argument to
9486 retrieve the secret. The validity of the prvs-signed address is then checked
9487 against the secret. The result is stored in the variable &$prvscheck_result$&,
9488 which is empty for failure or &"1"& for success.
9489
9490 The third argument is optional; if it is missing, it defaults to an empty
9491 string. This argument is now expanded. If the result is an empty string, the
9492 result of the expansion is the decoded version of the address. This is the case
9493 whether or not the signature was valid. Otherwise, the result of the expansion
9494 is the expansion of the third argument.
9495
9496 All three variables can be used in the expansion of the third argument.
9497 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9498 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9499
9500 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9501 .cindex "expansion" "inserting an entire file"
9502 .cindex "file" "inserting into expansion"
9503 .cindex "&%readfile%& expansion item"
9504 The file name and end-of-line string are first expanded separately. The file is
9505 then read, and its contents replace the entire item. All newline characters in
9506 the file are replaced by the end-of-line string if it is present. Otherwise,
9507 newlines are left in the string.
9508 String expansion is not applied to the contents of the file. If you want this,
9509 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9510 the string expansion fails.
9511
9512 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9513 locks out the use of this expansion item in filter files.
9514
9515
9516
9517 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9518         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9519 .cindex "expansion" "inserting from a socket"
9520 .cindex "socket, use of in expansion"
9521 .cindex "&%readsocket%& expansion item"
9522 This item inserts data from a Unix domain or TCP socket into the expanded
9523 string. The minimal way of using it uses just two arguments, as in these
9524 examples:
9525 .code
9526 ${readsocket{/socket/name}{request string}}
9527 ${readsocket{inet:some.host:1234}{request string}}
9528 .endd
9529 For a Unix domain socket, the first substring must be the path to the socket.
9530 For an Internet socket, the first substring must contain &`inet:`& followed by
9531 a host name or IP address, followed by a colon and a port, which can be a
9532 number or the name of a TCP port in &_/etc/services_&. An IP address may
9533 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9534 example:
9535 .code
9536 ${readsocket{inet:[::1]:1234}{request string}}
9537 .endd
9538 Only a single host name may be given, but if looking it up yields more than
9539 one IP address, they are each tried in turn until a connection is made. For
9540 both kinds of socket, Exim makes a connection, writes the request string
9541 (unless it is an empty string) and reads from the socket until an end-of-file
9542 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9543 extend what can be done. Firstly, you can vary the timeout. For example:
9544 .code
9545 ${readsocket{/socket/name}{request string}{3s}}
9546 .endd
9547 A fourth argument allows you to change any newlines that are in the data
9548 that is read, in the same way as for &%readfile%& (see above). This example
9549 turns them into spaces:
9550 .code
9551 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9552 .endd
9553 As with all expansions, the substrings are expanded before the processing
9554 happens. Errors in these sub-expansions cause the expansion to fail. In
9555 addition, the following errors can occur:
9556
9557 .ilist
9558 Failure to create a socket file descriptor;
9559 .next
9560 Failure to connect the socket;
9561 .next
9562 Failure to write the request string;
9563 .next
9564 Timeout on reading from the socket.
9565 .endlist
9566
9567 By default, any of these errors causes the expansion to fail. However, if
9568 you supply a fifth substring, it is expanded and used when any of the above
9569 errors occurs. For example:
9570 .code
9571 ${readsocket{/socket/name}{request string}{3s}{\n}\
9572   {socket failure}}
9573 .endd
9574 You can test for the existence of a Unix domain socket by wrapping this
9575 expansion in &`${if exists`&, but there is a race condition between that test
9576 and the actual opening of the socket, so it is safer to use the fifth argument
9577 if you want to be absolutely sure of avoiding an expansion error for a
9578 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9579
9580 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9581 locks out the use of this expansion item in filter files.
9582
9583
9584 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9585 .cindex "expansion" "reducing a list to a scalar"
9586 .cindex "list" "reducing to a scalar"
9587 .vindex "&$value$&"
9588 .vindex "&$item$&"
9589 This operation reduces a list to a single, scalar string. After expansion,
9590 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9591 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9592 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9593 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9594 them. The result of that expansion is assigned to &$value$& before the next
9595 iteration. When the end of the list is reached, the final value of &$value$& is
9596 added to the expansion output. The &*reduce*& expansion item can be used in a
9597 number of ways. For example, to add up a list of numbers:
9598 .code
9599 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9600 .endd
9601 The result of that expansion would be &`6`&. The maximum of a list of numbers
9602 can be found:
9603 .code
9604 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9605 .endd
9606 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9607 restored to what they were before. See also the &*filter*& and &*map*&
9608 expansion items.
9609
9610 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9611 This item inserts &"raw"& header lines. It is described with the &%header%&
9612 expansion item above.
9613
9614 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9615         {*&<&'string2'&>&*}}*&"
9616 .cindex "expansion" "running a command"
9617 .cindex "&%run%& expansion item"
9618 The command and its arguments are first expanded as one string. The string is
9619 split apart into individual arguments by spaces, and then the command is run
9620 in a separate process, but under the same uid and gid.  As in other command
9621 executions from Exim, a shell is not used by default. If the command requires
9622 a shell, you must explicitly code it.
9623
9624 Since the arguments are split by spaces, when there is a variable expansion
9625 which has an empty result, it will cause the situation that the argument will
9626 simply be omitted when the program is actually executed by Exim. If the
9627 script/program requires a specific number of arguments and the expanded
9628 variable could possibly result in this empty expansion, the variable must be
9629 quoted. This is more difficult if the expanded variable itself could result
9630 in a string containing quotes, because it would interfere with the quotes
9631 around the command arguments. A possible guard against this is to wrap the
9632 variable in the &%sg%& operator to change any quote marks to some other
9633 character.
9634
9635 The standard input for the command exists, but is empty. The standard output
9636 and standard error are set to the same file descriptor.
9637 .cindex "return code" "from &%run%& expansion"
9638 .vindex "&$value$&"
9639 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9640 and replaces the entire item; during this expansion, the standard output/error
9641 from the command is in the variable &$value$&. If the command fails,
9642 <&'string2'&>, if present, is expanded and used. Once again, during the
9643 expansion, the standard output/error from the command is in the variable
9644 &$value$&.
9645
9646 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9647 can be the word &"fail"& (not in braces) to force expansion failure if the
9648 command does not succeed. If both strings are omitted, the result is contents
9649 of the standard output/error on success, and nothing on failure.
9650
9651 .vindex "&$run_in_acl$&"
9652 The standard output/error of the command is put in the variable &$value$&.
9653 In this ACL example, the output of a command is logged for the admin to
9654 troubleshoot:
9655 .code
9656 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9657       log_message  = Output of id: $value
9658 .endd
9659 If the command requires shell idioms, such as the > redirect operator, the
9660 shell must be invoked directly, such as with:
9661 .code
9662 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9663 .endd
9664
9665 .vindex "&$runrc$&"
9666 The return code from the command is put in the variable &$runrc$&, and this
9667 remains set afterwards, so in a filter file you can do things like this:
9668 .code
9669 if "${run{x y z}{}}$runrc" is 1 then ...
9670   elif $runrc is 2 then ...
9671   ...
9672 endif
9673 .endd
9674 If execution of the command fails (for example, the command does not exist),
9675 the return code is 127 &-- the same code that shells use for non-existent
9676 commands.
9677
9678 &*Warning*&: In a router or transport, you cannot assume the order in which
9679 option values are expanded, except for those preconditions whose order of
9680 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9681 by the expansion of one option, and use it in another.
9682
9683 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9684 out the use of this expansion item in filter files.
9685
9686
9687 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9688 .cindex "expansion" "string substitution"
9689 .cindex "&%sg%& expansion item"
9690 This item works like Perl's substitution operator (s) with the global (/g)
9691 option; hence its name. However, unlike the Perl equivalent, Exim does not
9692 modify the subject string; instead it returns the modified string for insertion
9693 into the overall expansion. The item takes three arguments: the subject string,
9694 a regular expression, and a substitution string. For example:
9695 .code
9696 ${sg{abcdefabcdef}{abc}{xyz}}
9697 .endd
9698 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9699 if any $ or \ characters are required in the regular expression or in the
9700 substitution string, they have to be escaped. For example:
9701 .code
9702 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9703 .endd
9704 yields &"defabc"&, and
9705 .code
9706 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9707 .endd
9708 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9709 the regular expression from string expansion.
9710
9711
9712
9713 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9714 .cindex sorting a list
9715 .cindex list sorting
9716 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9717 default, but the separator can be changed in the usual way.
9718 The <&'comparator'&> argument is interpreted as the operator
9719 of a two-argument expansion condition.
9720 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9721 The comparison should return true when applied to two values
9722 if the first value should sort before the second value.
9723 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9724 the element being placed in &$item$&,
9725 to give values for comparison.
9726
9727 The item result is a sorted list,
9728 with the original list separator,
9729 of the list elements (in full) of the original.
9730
9731 Examples:
9732 .code
9733 ${sort{3:2:1:4}{<}{$item}}
9734 .endd
9735 sorts a list of numbers, and
9736 .code
9737 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9738 .endd
9739 will sort an MX lookup into priority order.
9740
9741
9742 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9743 .cindex "&%substr%& expansion item"
9744 .cindex "substring extraction"
9745 .cindex "expansion" "substring extraction"
9746 The three strings are expanded; the first two must yield numbers. Call them
9747 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9748 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9749 can use the simpler operator notation that avoids some of the braces:
9750 .code
9751 ${substr_<n>_<m>:<string>}
9752 .endd
9753 The second number is optional (in both notations).
9754 If it is absent in the simpler format, the preceding underscore must also be
9755 omitted.
9756
9757 The &%substr%& item can be used to extract more general substrings than
9758 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9759 length required. For example
9760 .code
9761 ${substr{3}{2}{$local_part}}
9762 .endd
9763 If the starting offset is greater than the string length the result is the
9764 null string; if the length plus starting offset is greater than the string
9765 length, the result is the right-hand part of the string, starting from the
9766 given offset. The first character in the string has offset zero.
9767
9768 The &%substr%& expansion item can take negative offset values to count
9769 from the right-hand end of its operand. The last character is offset -1, the
9770 second-last is offset -2, and so on. Thus, for example,
9771 .code
9772 ${substr{-5}{2}{1234567}}
9773 .endd
9774 yields &"34"&. If the absolute value of a negative offset is greater than the
9775 length of the string, the substring starts at the beginning of the string, and
9776 the length is reduced by the amount of overshoot. Thus, for example,
9777 .code
9778 ${substr{-5}{2}{12}}
9779 .endd
9780 yields an empty string, but
9781 .code
9782 ${substr{-3}{2}{12}}
9783 .endd
9784 yields &"1"&.
9785
9786 When the second number is omitted from &%substr%&, the remainder of the string
9787 is taken if the offset is positive. If it is negative, all characters in the
9788 string preceding the offset point are taken. For example, an offset of -1 and
9789 no length, as in these semantically identical examples:
9790 .code
9791 ${substr_-1:abcde}
9792 ${substr{-1}{abcde}}
9793 .endd
9794 yields all but the last character of the string, that is, &"abcd"&.
9795
9796
9797
9798 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9799         {*&<&'replacements'&>&*}}*&"
9800 .cindex "expansion" "character translation"
9801 .cindex "&%tr%& expansion item"
9802 This item does single-character translation on its subject string. The second
9803 argument is a list of characters to be translated in the subject string. Each
9804 matching character is replaced by the corresponding character from the
9805 replacement list. For example
9806 .code
9807 ${tr{abcdea}{ac}{13}}
9808 .endd
9809 yields &`1b3de1`&. If there are duplicates in the second character string, the
9810 last occurrence is used. If the third string is shorter than the second, its
9811 last character is replicated. However, if it is empty, no translation takes
9812 place.
9813 .endlist
9814
9815
9816
9817 .section "Expansion operators" "SECTexpop"
9818 .cindex "expansion" "operators"
9819 For expansion items that perform transformations on a single argument string,
9820 the &"operator"& notation is used because it is simpler and uses fewer braces.
9821 The substring is first expanded before the operation is applied to it. The
9822 following operations can be performed:
9823
9824 .vlist
9825 .vitem &*${address:*&<&'string'&>&*}*&
9826 .cindex "expansion" "RFC 2822 address handling"
9827 .cindex "&%address%& expansion item"
9828 The string is interpreted as an RFC 2822 address, as it might appear in a
9829 header line, and the effective address is extracted from it. If the string does
9830 not parse successfully, the result is empty.
9831
9832
9833 .vitem &*${addresses:*&<&'string'&>&*}*&
9834 .cindex "expansion" "RFC 2822 address handling"
9835 .cindex "&%addresses%& expansion item"
9836 The string (after expansion) is interpreted as a list of addresses in RFC
9837 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9838 operative address (&'local-part@domain'&) is extracted from each item, and the
9839 result of the expansion is a colon-separated list, with appropriate
9840 doubling of colons should any happen to be present in the email addresses.
9841 Syntactically invalid RFC2822 address items are omitted from the output.
9842
9843 It is possible to specify a character other than colon for the output
9844 separator by starting the string with > followed by the new separator
9845 character. For example:
9846 .code
9847 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9848 .endd
9849 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9850 expansion item, which extracts the working address from a single RFC2822
9851 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9852 processing lists.
9853
9854 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9855 a strict interpretation of header line formatting.  Exim parses the bare,
9856 unquoted portion of an email address and if it finds a comma, treats it as an
9857 email address seperator. For the example header line:
9858 .code
9859 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9860 .endd
9861 The first example below demonstrates that Q-encoded email addresses are parsed
9862 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9863 It does not see the comma because it's still encoded as "=2C".  The second
9864 example below is passed the contents of &`$header_from:`&, meaning it gets
9865 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9866 The third example shows that the presence of a comma is skipped when it is
9867 quoted.
9868 .code
9869 # exim -be '${addresses:From: \
9870 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9871 user@example.com
9872 # exim -be '${addresses:From: Last, First <user@example.com>}'
9873 Last:user@example.com
9874 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9875 user@example.com
9876 .endd
9877
9878 .vitem &*${base62:*&<&'digits'&>&*}*&
9879 .cindex "&%base62%& expansion item"
9880 .cindex "expansion" "conversion to base 62"
9881 The string must consist entirely of decimal digits. The number is converted to
9882 base 62 and output as a string of six characters, including leading zeros. In
9883 the few operating environments where Exim uses base 36 instead of base 62 for
9884 its message identifiers (because those systems do not have case-sensitive file
9885 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9886 be absolutely clear: this is &'not'& base64 encoding.
9887
9888 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9889 .cindex "&%base62d%& expansion item"
9890 .cindex "expansion" "conversion to base 62"
9891 The string must consist entirely of base-62 digits, or, in operating
9892 environments where Exim uses base 36 instead of base 62 for its message
9893 identifiers, base-36 digits. The number is converted to decimal and output as a
9894 string.
9895
9896
9897 .vitem &*${domain:*&<&'string'&>&*}*&
9898 .cindex "domain" "extraction"
9899 .cindex "expansion" "domain extraction"
9900 The string is interpreted as an RFC 2822 address and the domain is extracted
9901 from it. If the string does not parse successfully, the result is empty.
9902
9903
9904 .vitem &*${escape:*&<&'string'&>&*}*&
9905 .cindex "expansion" "escaping non-printing characters"
9906 .cindex "&%escape%& expansion item"
9907 If the string contains any non-printing characters, they are converted to
9908 escape sequences starting with a backslash. Whether characters with the most
9909 significant bit set (so-called &"8-bit characters"&) count as printing or not
9910 is controlled by the &%print_topbitchars%& option.
9911
9912
9913 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9914 .cindex "expansion" "expression evaluation"
9915 .cindex "expansion" "arithmetic expression"
9916 .cindex "&%eval%& expansion item"
9917 These items supports simple arithmetic and bitwise logical operations in
9918 expansion strings. The string (after expansion) must be a conventional
9919 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9920 logical operators, and parentheses. All operations are carried out using
9921 integer arithmetic. The operator priorities are as follows (the same as in the
9922 C programming language):
9923 .table2 70pt 300pt
9924 .irow &'highest:'& "not (~), negate (-)"
9925 .irow ""   "multiply (*), divide (/), remainder (%)"
9926 .irow ""   "plus (+), minus (-)"
9927 .irow ""   "shift-left (<<), shift-right (>>)"
9928 .irow ""   "and (&&)"
9929 .irow ""   "xor (^)"
9930 .irow &'lowest:'&  "or (|)"
9931 .endtable
9932 Binary operators with the same priority are evaluated from left to right. White
9933 space is permitted before or after operators.
9934
9935 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9936 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9937 decimal, even if they start with a leading zero; hexadecimal numbers are not
9938 permitted. This can be useful when processing numbers extracted from dates or
9939 times, which often do have leading zeros.
9940
9941 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9942 or 1024*1024*1024,
9943 respectively. Negative numbers are supported. The result of the computation is
9944 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9945
9946 .display
9947 &`${eval:1+1}            `&  yields 2
9948 &`${eval:1+2*3}          `&  yields 7
9949 &`${eval:(1+2)*3}        `&  yields 9
9950 &`${eval:2+42%5}         `&  yields 4
9951 &`${eval:0xc&amp;5}          `&  yields 4
9952 &`${eval:0xc|5}          `&  yields 13
9953 &`${eval:0xc^5}          `&  yields 9
9954 &`${eval:0xc>>1}         `&  yields 6
9955 &`${eval:0xc<<1}         `&  yields 24
9956 &`${eval:~255&amp;0x1234}    `&  yields 4608
9957 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9958 .endd
9959
9960 As a more realistic example, in an ACL you might have
9961 .code
9962 deny   message = Too many bad recipients
9963        condition =                    \
9964          ${if and {                   \
9965            {>{$rcpt_count}{10}}       \
9966            {                          \
9967            <                          \
9968              {$recipients_count}      \
9969              {${eval:$rcpt_count/2}}  \
9970            }                          \
9971          }{yes}{no}}
9972 .endd
9973 The condition is true if there have been more than 10 RCPT commands and
9974 fewer than half of them have resulted in a valid recipient.
9975
9976
9977 .vitem &*${expand:*&<&'string'&>&*}*&
9978 .cindex "expansion" "re-expansion of substring"
9979 The &%expand%& operator causes a string to be expanded for a second time. For
9980 example,
9981 .code
9982 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9983 .endd
9984 first looks up a string in a file while expanding the operand for &%expand%&,
9985 and then re-expands what it has found.
9986
9987
9988 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9989 .cindex "Unicode"
9990 .cindex "UTF-8" "conversion from"
9991 .cindex "expansion" "UTF-8 conversion"
9992 .cindex "&%from_utf8%& expansion item"
9993 The world is slowly moving towards Unicode, although there are no standards for
9994 email yet. However, other applications (including some databases) are starting
9995 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9996 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9997 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9998 the result is an undefined sequence of bytes.
9999
10000 Unicode code points with values less than 256 are compatible with ASCII and
10001 ISO-8859-1 (also known as Latin-1).
10002 For example, character 169 is the copyright symbol in both cases, though the
10003 way it is encoded is different. In UTF-8, more than one byte is needed for
10004 characters with code values greater than 127, whereas ISO-8859-1 is a
10005 single-byte encoding (but thereby limited to 256 characters). This makes
10006 translation from UTF-8 to ISO-8859-1 straightforward.
10007
10008
10009 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10010 .cindex "hash function" "textual"
10011 .cindex "expansion" "textual hash"
10012 The &%hash%& operator is a simpler interface to the hashing function that can
10013 be used when the two parameters are fixed numbers (as opposed to strings that
10014 change when expanded). The effect is the same as
10015 .code
10016 ${hash{<n>}{<m>}{<string>}}
10017 .endd
10018 See the description of the general &%hash%& item above for details. The
10019 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10020
10021
10022
10023 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10024 .cindex "base64 encoding" "conversion from hex"
10025 .cindex "expansion" "hex to base64"
10026 .cindex "&%hex2b64%& expansion item"
10027 This operator converts a hex string into one that is base64 encoded. This can
10028 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10029
10030
10031
10032 .vitem &*${hexquote:*&<&'string'&>&*}*&
10033 .cindex "quoting" "hex-encoded unprintable characters"
10034 .cindex "&%hexquote%& expansion item"
10035 This operator converts non-printable characters in a string into a hex
10036 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10037 as is, and other byte values are converted to &`\xNN`&, for example a
10038 byte value 127 is converted to &`\x7f`&.
10039
10040
10041 .vitem &*${lc:*&<&'string'&>&*}*&
10042 .cindex "case forcing in strings"
10043 .cindex "string" "case forcing"
10044 .cindex "lower casing"
10045 .cindex "expansion" "case forcing"
10046 .cindex "&%lc%& expansion item"
10047 This forces the letters in the string into lower-case, for example:
10048 .code
10049 ${lc:$local_part}
10050 .endd
10051
10052 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10053 .cindex "expansion" "string truncation"
10054 .cindex "&%length%& expansion item"
10055 The &%length%& operator is a simpler interface to the &%length%& function that
10056 can be used when the parameter is a fixed number (as opposed to a string that
10057 changes when expanded). The effect is the same as
10058 .code
10059 ${length{<number>}{<string>}}
10060 .endd
10061 See the description of the general &%length%& item above for details. Note that
10062 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10063 when &%length%& is used as an operator.
10064
10065
10066 .vitem &*${listcount:*&<&'string'&>&*}*&
10067 .cindex "expansion" "list item count"
10068 .cindex "list" "item count"
10069 .cindex "list" "count of items"
10070 .cindex "&%listcount%& expansion item"
10071 The string is interpreted as a list and the number of items is returned.
10072
10073
10074 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10075 .cindex "expansion" "named list"
10076 .cindex "&%listnamed%& expansion item"
10077 The name is interpreted as a named list and the content of the list is returned,
10078 expanding any referenced lists, re-quoting as needed for colon-separation.
10079 If the optional type is given it must be one of "a", "d", "h" or "l"
10080 and selects address-, domain-, host- or localpart- lists to search among respectively.
10081 Otherwise all types are searched in an undefined order and the first
10082 matching list is returned.
10083
10084
10085 .vitem &*${local_part:*&<&'string'&>&*}*&
10086 .cindex "expansion" "local part extraction"
10087 .cindex "&%local_part%& expansion item"
10088 The string is interpreted as an RFC 2822 address and the local part is
10089 extracted from it. If the string does not parse successfully, the result is
10090 empty.
10091
10092
10093 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10094 .cindex "masked IP address"
10095 .cindex "IP address" "masking"
10096 .cindex "CIDR notation"
10097 .cindex "expansion" "IP address masking"
10098 .cindex "&%mask%& expansion item"
10099 If the form of the string to be operated on is not an IP address followed by a
10100 slash and an integer (that is, a network address in CIDR notation), the
10101 expansion fails. Otherwise, this operator converts the IP address to binary,
10102 masks off the least significant bits according to the bit count, and converts
10103 the result back to text, with mask appended. For example,
10104 .code
10105 ${mask:10.111.131.206/28}
10106 .endd
10107 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10108 be mostly used for looking up masked addresses in files, the result for an IPv6
10109 address uses dots to separate components instead of colons, because colon
10110 terminates a key string in lsearch files. So, for example,
10111 .code
10112 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10113 .endd
10114 returns the string
10115 .code
10116 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10117 .endd
10118 Letters in IPv6 addresses are always output in lower case.
10119
10120
10121 .vitem &*${md5:*&<&'string'&>&*}*&
10122 .cindex "MD5 hash"
10123 .cindex "expansion" "MD5 hash"
10124 .cindex "certificate fingerprint"
10125 .cindex "&%md5%& expansion item"
10126 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10127 as a 32-digit hexadecimal number, in which any letters are in lower case.
10128
10129
10130 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10131 .cindex "expansion" "numeric hash"
10132 .cindex "hash function" "numeric"
10133 The &%nhash%& operator is a simpler interface to the numeric hashing function
10134 that can be used when the two parameters are fixed numbers (as opposed to
10135 strings that change when expanded). The effect is the same as
10136 .code
10137 ${nhash{<n>}{<m>}{<string>}}
10138 .endd
10139 See the description of the general &%nhash%& item above for details.
10140
10141
10142 .vitem &*${quote:*&<&'string'&>&*}*&
10143 .cindex "quoting" "in string expansions"
10144 .cindex "expansion" "quoting"
10145 .cindex "&%quote%& expansion item"
10146 The &%quote%& operator puts its argument into double quotes if it
10147 is an empty string or
10148 contains anything other than letters, digits, underscores, dots, and hyphens.
10149 Any occurrences of double quotes and backslashes are escaped with a backslash.
10150 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10151 respectively For example,
10152 .code
10153 ${quote:ab"*"cd}
10154 .endd
10155 becomes
10156 .code
10157 "ab\"*\"cd"
10158 .endd
10159 The place where this is useful is when the argument is a substitution from a
10160 variable or a message header.
10161
10162 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10163 .cindex "&%quote_local_part%& expansion item"
10164 This operator is like &%quote%&, except that it quotes the string only if
10165 required to do so by the rules of RFC 2822 for quoting local parts. For
10166 example, a plus sign would not cause quoting (but it would for &%quote%&).
10167 If you are creating a new email address from the contents of &$local_part$&
10168 (or any other unknown data), you should always use this operator.
10169
10170
10171 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10172 .cindex "quoting" "lookup-specific"
10173 This operator applies lookup-specific quoting rules to the string. Each
10174 query-style lookup type has its own quoting rules which are described with
10175 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10176 .code
10177 ${quote_ldap:two * two}
10178 .endd
10179 returns
10180 .code
10181 two%20%5C2A%20two
10182 .endd
10183 For single-key lookup types, no quoting is ever necessary and this operator
10184 yields an unchanged string.
10185
10186
10187 .vitem &*${randint:*&<&'n'&>&*}*&
10188 .cindex "random number"
10189 This operator returns a somewhat random number which is less than the
10190 supplied number and is at least 0.  The quality of this randomness depends
10191 on how Exim was built; the values are not suitable for keying material.
10192 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10193 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10194 for versions of GnuTLS with that function.
10195 Otherwise, the implementation may be arc4random(), random() seeded by
10196 srandomdev() or srandom(), or a custom implementation even weaker than
10197 random().
10198
10199
10200 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10201 .cindex "expansion" "IP address"
10202 This operator reverses an IP address; for IPv4 addresses, the result is in
10203 dotted-quad decimal form, while for IPv6 addreses the result is in
10204 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10205 for DNS.  For example,
10206 .code
10207 ${reverse_ip:192.0.2.4}
10208 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10209 .endd
10210 returns
10211 .code
10212 4.2.0.192
10213 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
10214 .endd
10215
10216
10217 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10218 .cindex "expansion" "RFC 2047"
10219 .cindex "RFC 2047" "expansion operator"
10220 .cindex "&%rfc2047%& expansion item"
10221 This operator encodes text according to the rules of RFC 2047. This is an
10222 encoding that is used in header lines to encode non-ASCII characters. It is
10223 assumed that the input string is in the encoding specified by the
10224 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10225 contains only characters in the range 33&--126, and no instances of the
10226 characters
10227 .code
10228 ? = ( ) < > @ , ; : \ " . [ ] _
10229 .endd
10230 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10231 string, using as many &"encoded words"& as necessary to encode all the
10232 characters.
10233
10234
10235 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10236 .cindex "expansion" "RFC 2047"
10237 .cindex "RFC 2047" "decoding"
10238 .cindex "&%rfc2047d%& expansion item"
10239 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10240 bytes are replaced by question marks. Characters are converted into the
10241 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10242 not recognized unless &%check_rfc2047_length%& is set false.
10243
10244 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10245 access a header line, RFC 2047 decoding is done automatically. You do not need
10246 to use this operator as well.
10247
10248
10249
10250 .vitem &*${rxquote:*&<&'string'&>&*}*&
10251 .cindex "quoting" "in regular expressions"
10252 .cindex "regular expressions" "quoting"
10253 .cindex "&%rxquote%& expansion item"
10254 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10255 characters in its argument. This is useful when substituting the values of
10256 variables or headers inside regular expressions.
10257
10258
10259 .vitem &*${sha1:*&<&'string'&>&*}*&
10260 .cindex "SHA-1 hash"
10261 .cindex "expansion" "SHA-1 hashing"
10262 .cindex "certificate fingerprint"
10263 .cindex "&%sha2%& expansion item"
10264 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10265 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10266
10267
10268 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10269 .cindex "SHA-256 hash"
10270 .cindex "certificate fingerprint"
10271 .cindex "expansion" "SHA-256 hashing"
10272 .cindex "&%sha256%& expansion item"
10273 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10274 certificate,
10275 and returns
10276 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10277 Only arguments which are a single variable of certificate type are supported.
10278
10279
10280 .vitem &*${stat:*&<&'string'&>&*}*&
10281 .cindex "expansion" "statting a file"
10282 .cindex "file" "extracting characteristics"
10283 .cindex "&%stat%& expansion item"
10284 The string, after expansion, must be a file path. A call to the &[stat()]&
10285 function is made for this path. If &[stat()]& fails, an error occurs and the
10286 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10287 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10288 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10289 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10290 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10291 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10292 can extract individual fields using the &%extract%& expansion item.
10293
10294 The use of the &%stat%& expansion in users' filter files can be locked out by
10295 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10296 systems for files larger than 2GB.
10297
10298 .vitem &*${str2b64:*&<&'string'&>&*}*&
10299 .cindex "expansion" "base64 encoding"
10300 .cindex "base64 encoding" "in string expansion"
10301 .cindex "&%str2b64%& expansion item"
10302 This operator converts a string into one that is base64 encoded.
10303
10304
10305
10306 .vitem &*${strlen:*&<&'string'&>&*}*&
10307 .cindex "expansion" "string length"
10308 .cindex "string" "length in expansion"
10309 .cindex "&%strlen%& expansion item"
10310 The item is replace by the length of the expanded string, expressed as a
10311 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10312
10313
10314 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10315 .cindex "&%substr%& expansion item"
10316 .cindex "substring extraction"
10317 .cindex "expansion" "substring expansion"
10318 The &%substr%& operator is a simpler interface to the &%substr%& function that
10319 can be used when the two parameters are fixed numbers (as opposed to strings
10320 that change when expanded). The effect is the same as
10321 .code
10322 ${substr{<start>}{<length>}{<string>}}
10323 .endd
10324 See the description of the general &%substr%& item above for details. The
10325 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10326
10327 .vitem &*${time_eval:*&<&'string'&>&*}*&
10328 .cindex "&%time_eval%& expansion item"
10329 .cindex "time interval" "decoding"
10330 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10331 seconds.
10332
10333 .vitem &*${time_interval:*&<&'string'&>&*}*&
10334 .cindex "&%time_interval%& expansion item"
10335 .cindex "time interval" "formatting"
10336 The argument (after sub-expansion) must be a sequence of decimal digits that
10337 represents an interval of time as a number of seconds. It is converted into a
10338 number of larger units and output in Exim's normal time format, for example,
10339 &`1w3d4h2m6s`&.
10340
10341 .vitem &*${uc:*&<&'string'&>&*}*&
10342 .cindex "case forcing in strings"
10343 .cindex "string" "case forcing"
10344 .cindex "upper casing"
10345 .cindex "expansion" "case forcing"
10346 .cindex "&%uc%& expansion item"
10347 This forces the letters in the string into upper-case.
10348
10349 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10350 .cindex "correction of invalid utf-8 sequences in strings"
10351 .cindex "utf-8" "utf-8 sequences"
10352 .cindex "incorrect utf-8"
10353 .cindex "expansion" "utf-8 forcing"
10354 .cindex "&%utf8clean%& expansion item"
10355 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10356 .endlist
10357
10358
10359
10360
10361
10362
10363 .section "Expansion conditions" "SECTexpcond"
10364 .scindex IIDexpcond "expansion" "conditions"
10365 The following conditions are available for testing by the &%${if%& construct
10366 while expanding strings:
10367
10368 .vlist
10369 .vitem &*!*&<&'condition'&>
10370 .cindex "expansion" "negating a condition"
10371 .cindex "negation" "in expansion condition"
10372 Preceding any condition with an exclamation mark negates the result of the
10373 condition.
10374
10375 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10376 .cindex "numeric comparison"
10377 .cindex "expansion" "numeric comparison"
10378 There are a number of symbolic operators for doing numeric comparisons. They
10379 are:
10380 .display
10381 &`=   `&   equal
10382 &`==  `&   equal
10383 &`>   `&   greater
10384 &`>=  `&   greater or equal
10385 &`<   `&   less
10386 &`<=  `&   less or equal
10387 .endd
10388 For example:
10389 .code
10390 ${if >{$message_size}{10M} ...
10391 .endd
10392 Note that the general negation operator provides for inequality testing. The
10393 two strings must take the form of optionally signed decimal integers,
10394 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10395 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10396 As a special case, the numerical value of an empty string is taken as
10397 zero.
10398
10399 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10400 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10401 10M, not if 10M is larger than &$message_size$&.
10402
10403
10404 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10405         {*&<&'arg2'&>&*}...}*&
10406 .cindex "expansion" "calling an acl"
10407 .cindex "&%acl%&" "expansion condition"
10408 The name and zero to nine argument strings are first expanded separately.  The expanded
10409 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10410 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10411 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10412 and may use the variables; if another acl expansion is used the values
10413 are restored after it returns.  If the ACL sets
10414 a value using a "message =" modifier the variable $value becomes
10415 the result of the expansion, otherwise it is empty.
10416 If the ACL returns accept the condition is true; if deny, false.
10417 If the ACL returns defer the result is a forced-fail.
10418
10419 .vitem &*bool&~{*&<&'string'&>&*}*&
10420 .cindex "expansion" "boolean parsing"
10421 .cindex "&%bool%& expansion condition"
10422 This condition turns a string holding a true or false representation into
10423 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10424 (case-insensitively); also integer numbers map to true if non-zero,
10425 false if zero.
10426 An empty string is treated as false.
10427 Leading and trailing whitespace is ignored;
10428 thus a string consisting only of whitespace is false.
10429 All other string values will result in expansion failure.
10430
10431 When combined with ACL variables, this expansion condition will let you
10432 make decisions in one place and act on those decisions in another place.
10433 For example:
10434 .code
10435 ${if bool{$acl_m_privileged_sender} ...
10436 .endd
10437
10438
10439 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10440 .cindex "expansion" "boolean parsing"
10441 .cindex "&%bool_lax%& expansion condition"
10442 Like &%bool%&, this condition turns a string into a boolean state.  But
10443 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10444 loose definition that the Router &%condition%& option uses.  The empty string
10445 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10446 true.  Leading and trailing whitespace is ignored.
10447
10448 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10449
10450 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10451 .cindex "expansion" "encrypted comparison"
10452 .cindex "encrypted strings, comparing"
10453 .cindex "&%crypteq%& expansion condition"
10454 This condition is included in the Exim binary if it is built to support any
10455 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10456 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10457 included in the binary.
10458
10459 The &%crypteq%& condition has two arguments. The first is encrypted and
10460 compared against the second, which is already encrypted. The second string may
10461 be in the LDAP form for storing encrypted strings, which starts with the
10462 encryption type in curly brackets, followed by the data. If the second string
10463 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10464 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10465 Typically this will be a field from a password file. An example of an encrypted
10466 string in LDAP form is:
10467 .code
10468 {md5}CY9rzUYh03PK3k6DJie09g==
10469 .endd
10470 If such a string appears directly in an expansion, the curly brackets have to
10471 be quoted, because they are part of the expansion syntax. For example:
10472 .code
10473 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10474 .endd
10475 The following encryption types (whose names are matched case-independently) are
10476 supported:
10477
10478 .ilist
10479 .cindex "MD5 hash"
10480 .cindex "base64 encoding" "in encrypted password"
10481 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10482 printable characters to compare with the remainder of the second string. If the
10483 length of the comparison string is 24, Exim assumes that it is base64 encoded
10484 (as in the above example). If the length is 32, Exim assumes that it is a
10485 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10486 comparison fails.
10487
10488 .next
10489 .cindex "SHA-1 hash"
10490 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10491 printable characters to compare with the remainder of the second string. If the
10492 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10493 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10494 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10495
10496 .next
10497 .cindex "&[crypt()]&"
10498 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10499 only the first eight characters of the password. However, in modern operating
10500 systems this is no longer true, and in many cases the entire password is used,
10501 whatever its length.
10502
10503 .next
10504 .cindex "&[crypt16()]&"
10505 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10506 use up to 16 characters of the password in some operating systems. Again, in
10507 modern operating systems, more characters may be used.
10508 .endlist
10509 Exim has its own version of &[crypt16()]&, which is just a double call to
10510 &[crypt()]&. For operating systems that have their own version, setting
10511 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10512 operating system version instead of its own. This option is set by default in
10513 the OS-dependent &_Makefile_& for those operating systems that are known to
10514 support &[crypt16()]&.
10515
10516 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10517 it was not using the same algorithm as some operating systems' versions. It
10518 turns out that as well as &[crypt16()]& there is a function called
10519 &[bigcrypt()]& in some operating systems. This may or may not use the same
10520 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10521
10522 However, since there is now a move away from the traditional &[crypt()]&
10523 functions towards using SHA1 and other algorithms, tidying up this area of
10524 Exim is seen as very low priority.
10525
10526 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10527 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10528 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10529 default is &`{crypt}`&. Whatever the default, you can always use either
10530 function by specifying it explicitly in curly brackets.
10531
10532 .vitem &*def:*&<&'variable&~name'&>
10533 .cindex "expansion" "checking for empty variable"
10534 .cindex "&%def%& expansion condition"
10535 The &%def%& condition must be followed by the name of one of the expansion
10536 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10537 variable does not contain the empty string. For example:
10538 .code
10539 ${if def:sender_ident {from $sender_ident}}
10540 .endd
10541 Note that the variable name is given without a leading &%$%& character. If the
10542 variable does not exist, the expansion fails.
10543
10544 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10545         &~&*def:h_*&<&'header&~name'&>&*:*&"
10546 .cindex "expansion" "checking header line existence"
10547 This condition is true if a message is being processed and the named header
10548 exists in the message. For example,
10549 .code
10550 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10551 .endd
10552 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10553 the header name must be terminated by a colon if white space does not follow.
10554
10555 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10556        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10557 .cindex "string" "comparison"
10558 .cindex "expansion" "string comparison"
10559 .cindex "&%eq%& expansion condition"
10560 .cindex "&%eqi%& expansion condition"
10561 The two substrings are first expanded. The condition is true if the two
10562 resulting strings are identical. For &%eq%& the comparison includes the case of
10563 letters, whereas for &%eqi%& the comparison is case-independent.
10564
10565 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10566 .cindex "expansion" "file existence test"
10567 .cindex "file" "existence test"
10568 .cindex "&%exists%&, expansion condition"
10569 The substring is first expanded and then interpreted as an absolute path. The
10570 condition is true if the named file (or directory) exists. The existence test
10571 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10572 users' filter files may be locked out by the system administrator.
10573
10574 .vitem &*first_delivery*&
10575 .cindex "delivery" "first"
10576 .cindex "first delivery"
10577 .cindex "expansion" "first delivery test"
10578 .cindex "&%first_delivery%& expansion condition"
10579 This condition, which has no data, is true during a message's first delivery
10580 attempt. It is false during any subsequent delivery attempts.
10581
10582
10583 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10584        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10585 .cindex "list" "iterative conditions"
10586 .cindex "expansion" "&*forall*& condition"
10587 .cindex "expansion" "&*forany*& condition"
10588 .vindex "&$item$&"
10589 These conditions iterate over a list. The first argument is expanded to form
10590 the list. By default, the list separator is a colon, but it can be changed by
10591 the normal method. The second argument is interpreted as a condition that is to
10592 be applied to each item in the list in turn. During the interpretation of the
10593 condition, the current list item is placed in a variable called &$item$&.
10594 .ilist
10595 For &*forany*&, interpretation stops if the condition is true for any item, and
10596 the result of the whole condition is true. If the condition is false for all
10597 items in the list, the overall condition is false.
10598 .next
10599 For &*forall*&, interpretation stops if the condition is false for any item,
10600 and the result of the whole condition is false. If the condition is true for
10601 all items in the list, the overall condition is true.
10602 .endlist
10603 Note that negation of &*forany*& means that the condition must be false for all
10604 items for the overall condition to succeed, and negation of &*forall*& means
10605 that the condition must be false for at least one item. In this example, the
10606 list separator is changed to a comma:
10607 .code
10608 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10609 .endd
10610 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10611 being processed, to enable these expansion items to be nested.
10612
10613 To scan a named list, expand it with the &*listnamed*& operator.
10614
10615
10616 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10617        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10618 .cindex "string" "comparison"
10619 .cindex "expansion" "string comparison"
10620 .cindex "&%ge%& expansion condition"
10621 .cindex "&%gei%& expansion condition"
10622 The two substrings are first expanded. The condition is true if the first
10623 string is lexically greater than or equal to the second string. For &%ge%& the
10624 comparison includes the case of letters, whereas for &%gei%& the comparison is
10625 case-independent.
10626
10627 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10628        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10629 .cindex "string" "comparison"
10630 .cindex "expansion" "string comparison"
10631 .cindex "&%gt%& expansion condition"
10632 .cindex "&%gti%& expansion condition"
10633 The two substrings are first expanded. The condition is true if the first
10634 string is lexically greater than the second string. For &%gt%& the comparison
10635 includes the case of letters, whereas for &%gti%& the comparison is
10636 case-independent.
10637
10638 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10639        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10640 .cindex "string" "comparison"
10641 .cindex "list" "iterative conditions"
10642 Both strings are expanded; the second string is treated as a list of simple
10643 strings; if the first string is a member of the second, then the condition
10644 is true.
10645
10646 These are simpler to use versions of the more powerful &*forany*& condition.
10647 Examples, and the &*forany*& equivalents:
10648 .code
10649 ${if inlist{needle}{foo:needle:bar}}
10650   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10651 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10652   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10653 .endd
10654
10655 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10656        &*isip4&~{*&<&'string'&>&*}*& &&&
10657        &*isip6&~{*&<&'string'&>&*}*&
10658 .cindex "IP address" "testing string format"
10659 .cindex "string" "testing for IP address"
10660 .cindex "&%isip%& expansion condition"
10661 .cindex "&%isip4%& expansion condition"
10662 .cindex "&%isip6%& expansion condition"
10663 The substring is first expanded, and then tested to see if it has the form of
10664 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10665 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10666
10667 For an IPv4 address, the test is for four dot-separated components, each of
10668 which consists of from one to three digits. For an IPv6 address, up to eight
10669 colon-separated components are permitted, each containing from one to four
10670 hexadecimal digits. There may be fewer than eight components if an empty
10671 component (adjacent colons) is present. Only one empty component is permitted.
10672
10673 &*Note*&: The checks are just on the form of the address; actual numerical
10674 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10675 check. The main use of these tests is to distinguish between IP addresses and
10676 host names, or between IPv4 and IPv6 addresses. For example, you could use
10677 .code
10678 ${if isip4{$sender_host_address}...
10679 .endd
10680 to test which IP version an incoming SMTP connection is using.
10681
10682 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10683 .cindex "LDAP" "use for authentication"
10684 .cindex "expansion" "LDAP authentication test"
10685 .cindex "&%ldapauth%& expansion condition"
10686 This condition supports user authentication using LDAP. See section
10687 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10688 queries. For this use, the query must contain a user name and password. The
10689 query itself is not used, and can be empty. The condition is true if the
10690 password is not empty, and the user name and password are accepted by the LDAP
10691 server. An empty password is rejected without calling LDAP because LDAP binds
10692 with an empty password are considered anonymous regardless of the username, and
10693 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10694 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10695 this can be used.
10696
10697
10698 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10699        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10700 .cindex "string" "comparison"
10701 .cindex "expansion" "string comparison"
10702 .cindex "&%le%& expansion condition"
10703 .cindex "&%lei%& expansion condition"
10704 The two substrings are first expanded. The condition is true if the first
10705 string is lexically less than or equal to the second string. For &%le%& the
10706 comparison includes the case of letters, whereas for &%lei%& the comparison is
10707 case-independent.
10708
10709 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10710        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10711 .cindex "string" "comparison"
10712 .cindex "expansion" "string comparison"
10713 .cindex "&%lt%& expansion condition"
10714 .cindex "&%lti%& expansion condition"
10715 The two substrings are first expanded. The condition is true if the first
10716 string is lexically less than the second string. For &%lt%& the comparison
10717 includes the case of letters, whereas for &%lti%& the comparison is
10718 case-independent.
10719
10720
10721 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10722 .cindex "expansion" "regular expression comparison"
10723 .cindex "regular expressions" "match in expanded string"
10724 .cindex "&%match%& expansion condition"
10725 The two substrings are first expanded. The second is then treated as a regular
10726 expression and applied to the first. Because of the pre-expansion, if the
10727 regular expression contains dollar, or backslash characters, they must be
10728 escaped. Care must also be taken if the regular expression contains braces
10729 (curly brackets). A closing brace must be escaped so that it is not taken as a
10730 premature termination of <&'string2'&>. The easiest approach is to use the
10731 &`\N`& feature to disable expansion of the regular expression.
10732 For example,
10733 .code
10734 ${if match {$local_part}{\N^\d{3}\N} ...
10735 .endd
10736 If the whole expansion string is in double quotes, further escaping of
10737 backslashes is also required.
10738
10739 The condition is true if the regular expression match succeeds.
10740 The regular expression is not required to begin with a circumflex
10741 metacharacter, but if there is no circumflex, the expression is not anchored,
10742 and it may match anywhere in the subject, not just at the start. If you want
10743 the pattern to match at the end of the subject, you must include the &`$`&
10744 metacharacter at an appropriate point.
10745
10746 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10747 At the start of an &%if%& expansion the values of the numeric variable
10748 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10749 succeeds causes them to be reset to the substrings of that condition and they
10750 will have these values during the expansion of the success string. At the end
10751 of the &%if%& expansion, the previous values are restored. After testing a
10752 combination of conditions using &%or%&, the subsequent values of the numeric
10753 variables are those of the condition that succeeded.
10754
10755 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10756 .cindex "&%match_address%& expansion condition"
10757 See &*match_local_part*&.
10758
10759 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10760 .cindex "&%match_domain%& expansion condition"
10761 See &*match_local_part*&.
10762
10763 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10764 .cindex "&%match_ip%& expansion condition"
10765 This condition matches an IP address to a list of IP address patterns. It must
10766 be followed by two argument strings. The first (after expansion) must be an IP
10767 address or an empty string. The second (not expanded) is a restricted host
10768 list that can match only an IP address, not a host name. For example:
10769 .code
10770 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10771 .endd
10772 The specific types of host list item that are permitted in the list are:
10773
10774 .ilist
10775 An IP address, optionally with a CIDR mask.
10776 .next
10777 A single asterisk, which matches any IP address.
10778 .next
10779 An empty item, which matches only if the IP address is empty. This could be
10780 useful for testing for a locally submitted message or one from specific hosts
10781 in a single test such as
10782 . ==== As this is a nested list, any displays it contains must be indented
10783 . ==== as otherwise they are too far to the left. This comment applies to
10784 . ==== the use of xmlto plus fop. There's no problem when formatting with
10785 . ==== sdop, with or without the extra indent.
10786 .code
10787   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10788 .endd
10789 where the first item in the list is the empty string.
10790 .next
10791 The item @[] matches any of the local host's interface addresses.
10792 .next
10793 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10794 even if &`net-`& is not specified. There is never any attempt to turn the IP
10795 address into a host name. The most common type of linear search for
10796 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10797 masks. For example:
10798 .code
10799   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10800 .endd
10801 It is of course possible to use other kinds of lookup, and in such a case, you
10802 do need to specify the &`net-`& prefix if you want to specify a specific
10803 address mask, for example:
10804 .code
10805   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10806 .endd
10807 However, unless you are combining a &%match_ip%& condition with others, it is
10808 just as easy to use the fact that a lookup is itself a condition, and write:
10809 .code
10810   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10811 .endd
10812 .endlist ilist
10813
10814 Note that <&'string2'&> is not itself subject to string expansion, unless
10815 Exim was built with the EXPAND_LISTMATCH_RHS option.
10816
10817 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10818
10819 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10820 .cindex "domain list" "in expansion condition"
10821 .cindex "address list" "in expansion condition"
10822 .cindex "local part" "list, in expansion condition"
10823 .cindex "&%match_local_part%& expansion condition"
10824 This condition, together with &%match_address%& and &%match_domain%&, make it
10825 possible to test domain, address, and local part lists within expansions. Each
10826 condition requires two arguments: an item and a list to match. A trivial
10827 example is:
10828 .code
10829 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10830 .endd
10831 In each case, the second argument may contain any of the allowable items for a
10832 list of the appropriate type. Also, because the second argument (after
10833 expansion) is a standard form of list, it is possible to refer to a named list.
10834 Thus, you can use conditions like this:
10835 .code
10836 ${if match_domain{$domain}{+local_domains}{...
10837 .endd
10838 .cindex "&`+caseful`&"
10839 For address lists, the matching starts off caselessly, but the &`+caseful`&
10840 item can be used, as in all address lists, to cause subsequent items to
10841 have their local parts matched casefully. Domains are always matched
10842 caselessly.
10843
10844 Note that <&'string2'&> is not itself subject to string expansion, unless
10845 Exim was built with the EXPAND_LISTMATCH_RHS option.
10846
10847 &*Note*&: Host lists are &'not'& supported in this way. This is because
10848 hosts have two identities: a name and an IP address, and it is not clear
10849 how to specify cleanly how such a test would work. However, IP addresses can be
10850 matched using &%match_ip%&.
10851
10852 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10853 .cindex "PAM authentication"
10854 .cindex "AUTH" "with PAM"
10855 .cindex "Solaris" "PAM support"
10856 .cindex "expansion" "PAM authentication test"
10857 .cindex "&%pam%& expansion condition"
10858 &'Pluggable Authentication Modules'&
10859 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10860 available in the latest releases of Solaris and in some GNU/Linux
10861 distributions. The Exim support, which is intended for use in conjunction with
10862 the SMTP AUTH command, is available only if Exim is compiled with
10863 .code
10864 SUPPORT_PAM=yes
10865 .endd
10866 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10867 in some releases of GNU/Linux &%-ldl%& is also needed.
10868
10869 The argument string is first expanded, and the result must be a
10870 colon-separated list of strings. Leading and trailing white space is ignored.
10871 The PAM module is initialized with the service name &"exim"& and the user name
10872 taken from the first item in the colon-separated data string (<&'string1'&>).
10873 The remaining items in the data string are passed over in response to requests
10874 from the authentication function. In the simple case there will only be one
10875 request, for a password, so the data consists of just two strings.
10876
10877 There can be problems if any of the strings are permitted to contain colon
10878 characters. In the usual way, these have to be doubled to avoid being taken as
10879 separators. If the data is being inserted from a variable, the &%sg%& expansion
10880 item can be used to double any existing colons. For example, the configuration
10881 of a LOGIN authenticator might contain this setting:
10882 .code
10883 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10884 .endd
10885 For a PLAIN authenticator you could use:
10886 .code
10887 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10888 .endd
10889 In some operating systems, PAM authentication can be done only from a process
10890 running as root. Since Exim is running as the Exim user when receiving
10891 messages, this means that PAM cannot be used directly in those systems.
10892 A patched version of the &'pam_unix'& module that comes with the
10893 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10894 The patched module allows one special uid/gid combination, in addition to root,
10895 to authenticate. If you build the patched module to allow the Exim user and
10896 group, PAM can then be used from an Exim authenticator.
10897
10898
10899 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10900 .cindex "&'pwcheck'& daemon"
10901 .cindex "Cyrus"
10902 .cindex "expansion" "&'pwcheck'& authentication test"
10903 .cindex "&%pwcheck%& expansion condition"
10904 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10905 This is one way of making it possible for passwords to be checked by a process
10906 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10907 deprecated. Its replacement is &'saslauthd'& (see below).
10908
10909 The pwcheck support is not included in Exim by default. You need to specify
10910 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10911 building Exim. For example:
10912 .code
10913 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10914 .endd
10915 You do not need to install the full Cyrus software suite in order to use
10916 the pwcheck daemon. You can compile and install just the daemon alone
10917 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10918 access to the &_/var/pwcheck_& directory.
10919
10920 The &%pwcheck%& condition takes one argument, which must be the user name and
10921 password, separated by a colon. For example, in a LOGIN authenticator
10922 configuration, you might have this:
10923 .code
10924 server_condition = ${if pwcheck{$auth1:$auth2}}
10925 .endd
10926 Again, for a PLAIN authenticator configuration, this would be:
10927 .code
10928 server_condition = ${if pwcheck{$auth2:$auth3}}
10929 .endd
10930 .vitem &*queue_running*&
10931 .cindex "queue runner" "detecting when delivering from"
10932 .cindex "expansion" "queue runner test"
10933 .cindex "&%queue_running%& expansion condition"
10934 This condition, which has no data, is true during delivery attempts that are
10935 initiated by queue runner processes, and false otherwise.
10936
10937
10938 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10939 .cindex "Radius"
10940 .cindex "expansion" "Radius authentication"
10941 .cindex "&%radius%& expansion condition"
10942 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10943 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10944 the Radius client configuration file in order to build Exim with Radius
10945 support.
10946
10947 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10948 library, using the original API. If you are using release 0.4.0 or later of
10949 this library, you need to set
10950 .code
10951 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10952 .endd
10953 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10954 &%libradius%& library that comes with FreeBSD. To do this, set
10955 .code
10956 RADIUS_LIB_TYPE=RADLIB
10957 .endd
10958 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10959 You may also have to supply a suitable setting in EXTRALIBS so that the
10960 Radius library can be found when Exim is linked.
10961
10962 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10963 Radius client library, which calls the Radius server. The condition is true if
10964 the authentication is successful. For example:
10965 .code
10966 server_condition = ${if radius{<arguments>}}
10967 .endd
10968
10969
10970 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10971         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10972 .cindex "&'saslauthd'& daemon"
10973 .cindex "Cyrus"
10974 .cindex "expansion" "&'saslauthd'& authentication test"
10975 .cindex "&%saslauthd%& expansion condition"
10976 This condition supports user authentication using the Cyrus &'saslauthd'&
10977 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10978 Using this daemon is one way of making it possible for passwords to be checked
10979 by a process that is not running as root.
10980
10981 The saslauthd support is not included in Exim by default. You need to specify
10982 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10983 building Exim. For example:
10984 .code
10985 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10986 .endd
10987 You do not need to install the full Cyrus software suite in order to use
10988 the saslauthd daemon. You can compile and install just the daemon alone
10989 from the Cyrus SASL library.
10990
10991 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10992 two are mandatory. For example:
10993 .code
10994 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10995 .endd
10996 The service and the realm are optional (which is why the arguments are enclosed
10997 in their own set of braces). For details of the meaning of the service and
10998 realm, and how to run the daemon, consult the Cyrus documentation.
10999 .endlist vlist
11000
11001
11002
11003 .section "Combining expansion conditions" "SECID84"
11004 .cindex "expansion" "combining conditions"
11005 Several conditions can be tested at once by combining them using the &%and%&
11006 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11007 conditions on their own, and precede their lists of sub-conditions. Each
11008 sub-condition must be enclosed in braces within the overall braces that contain
11009 the list. No repetition of &%if%& is used.
11010
11011
11012 .vlist
11013 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11014 .cindex "&""or""& expansion condition"
11015 .cindex "expansion" "&""or""& of conditions"
11016 The sub-conditions are evaluated from left to right. The condition is true if
11017 any one of the sub-conditions is true.
11018 For example,
11019 .code
11020 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11021 .endd
11022 When a true sub-condition is found, the following ones are parsed but not
11023 evaluated. If there are several &"match"& sub-conditions the values of the
11024 numeric variables afterwards are taken from the first one that succeeds.
11025
11026 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11027 .cindex "&""and""& expansion condition"
11028 .cindex "expansion" "&""and""& of conditions"
11029 The sub-conditions are evaluated from left to right. The condition is true if
11030 all of the sub-conditions are true. If there are several &"match"&
11031 sub-conditions, the values of the numeric variables afterwards are taken from
11032 the last one. When a false sub-condition is found, the following ones are
11033 parsed but not evaluated.
11034 .endlist
11035 .ecindex IIDexpcond
11036
11037
11038
11039
11040 .section "Expansion variables" "SECTexpvar"
11041 .cindex "expansion" "variables, list of"
11042 This section contains an alphabetical list of all the expansion variables. Some
11043 of them are available only when Exim is compiled with specific options such as
11044 support for TLS or the content scanning extension.
11045
11046 .vlist
11047 .vitem "&$0$&, &$1$&, etc"
11048 .cindex "numerical variables (&$1$& &$2$& etc)"
11049 When a &%match%& expansion condition succeeds, these variables contain the
11050 captured substrings identified by the regular expression during subsequent
11051 processing of the success string of the containing &%if%& expansion item.
11052 However, they do not retain their values afterwards; in fact, their previous
11053 values are restored at the end of processing an &%if%& item. The numerical
11054 variables may also be set externally by some other matching process which
11055 precedes the expansion of the string. For example, the commands available in
11056 Exim filter files include an &%if%& command with its own regular expression
11057 matching condition.
11058
11059 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11060 Within an acl condition, expansion condition or expansion item
11061 any arguments are copied to these variables,
11062 any unused variables being made empty.
11063
11064 .vitem "&$acl_c...$&"
11065 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11066 can be given any name that starts with &$acl_c$& and is at least six characters
11067 long, but the sixth character must be either a digit or an underscore. For
11068 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11069 variables persist throughout the lifetime of an SMTP connection. They can be
11070 used to pass information between ACLs and between different invocations of the
11071 same ACL. When a message is received, the values of these variables are saved
11072 with the message, and can be accessed by filters, routers, and transports
11073 during subsequent delivery.
11074
11075 .vitem "&$acl_m...$&"
11076 These variables are like the &$acl_c...$& variables, except that their values
11077 are reset after a message has been received. Thus, if several messages are
11078 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11079 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11080 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11081 message is received, the values of these variables are saved with the message,
11082 and can be accessed by filters, routers, and transports during subsequent
11083 delivery.
11084
11085 .vitem &$acl_narg$&
11086 Within an acl condition, expansion condition or expansion item
11087 this variable has the number of arguments.
11088
11089 .vitem &$acl_verify_message$&
11090 .vindex "&$acl_verify_message$&"
11091 After an address verification has failed, this variable contains the failure
11092 message. It retains its value for use in subsequent modifiers. The message can
11093 be preserved by coding like this:
11094 .code
11095 warn !verify = sender
11096      set acl_m0 = $acl_verify_message
11097 .endd
11098 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11099 &%log_message%& modifiers, to include information about the verification
11100 failure.
11101
11102 .vitem &$address_data$&
11103 .vindex "&$address_data$&"
11104 This variable is set by means of the &%address_data%& option in routers. The
11105 value then remains with the address while it is processed by subsequent routers
11106 and eventually a transport. If the transport is handling multiple addresses,
11107 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11108 for more details. &*Note*&: The contents of &$address_data$& are visible in
11109 user filter files.
11110
11111 If &$address_data$& is set when the routers are called from an ACL to verify
11112 a recipient address, the final value is still in the variable for subsequent
11113 conditions and modifiers of the ACL statement. If routing the address caused it
11114 to be redirected to just one address, the child address is also routed as part
11115 of the verification, and in this case the final value of &$address_data$& is
11116 from the child's routing.
11117
11118 If &$address_data$& is set when the routers are called from an ACL to verify a
11119 sender address, the final value is also preserved, but this time in
11120 &$sender_address_data$&, to distinguish it from data from a recipient
11121 address.
11122
11123 In both cases (recipient and sender verification), the value does not persist
11124 after the end of the current ACL statement. If you want to preserve
11125 these values for longer, you can save them in ACL variables.
11126
11127 .vitem &$address_file$&
11128 .vindex "&$address_file$&"
11129 When, as a result of aliasing, forwarding, or filtering, a message is directed
11130 to a specific file, this variable holds the name of the file when the transport
11131 is running. At other times, the variable is empty. For example, using the
11132 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11133 .code
11134 /home/r2d2/savemail
11135 .endd
11136 then when the &(address_file)& transport is running, &$address_file$&
11137 contains the text string &`/home/r2d2/savemail`&.
11138 .cindex "Sieve filter" "value of &$address_file$&"
11139 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11140 then up to the transport configuration to generate an appropriate absolute path
11141 to the relevant file.
11142
11143 .vitem &$address_pipe$&
11144 .vindex "&$address_pipe$&"
11145 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11146 this variable holds the pipe command when the transport is running.
11147
11148 .vitem "&$auth1$& &-- &$auth3$&"
11149 .vindex "&$auth1$&, &$auth2$&, etc"
11150 These variables are used in SMTP authenticators (see chapters
11151 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11152
11153 .vitem &$authenticated_id$&
11154 .cindex "authentication" "id"
11155 .vindex "&$authenticated_id$&"
11156 When a server successfully authenticates a client it may be configured to
11157 preserve some of the authentication information in the variable
11158 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11159 user/password authenticator configuration might preserve the user name for use
11160 in the routers. Note that this is not the same information that is saved in
11161 &$sender_host_authenticated$&.
11162 When a message is submitted locally (that is, not over a TCP connection)
11163 the value of &$authenticated_id$& is normally the login name of the calling
11164 process. However, a trusted user can override this by means of the &%-oMai%&
11165 command line option.
11166
11167 .vitem &$authenticated_fail_id$&
11168 .cindex "authentication" "fail" "id"
11169 .vindex "&$authenticated_fail_id$&"
11170 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11171 will contain the failed authentication id. If more than one authentication
11172 id is attempted, it will contain only the last one. The variable is
11173 available for processing in the ACL's, generally the quit or notquit ACL.
11174 A message to a local recipient could still be accepted without requiring
11175 authentication, which means this variable could also be visible in all of
11176 the ACL's as well.
11177
11178
11179 .vitem &$authenticated_sender$&
11180 .cindex "sender" "authenticated"
11181 .cindex "authentication" "sender"
11182 .cindex "AUTH" "on MAIL command"
11183 .vindex "&$authenticated_sender$&"
11184 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11185 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11186 described in section &<<SECTauthparamail>>&. Unless the data is the string
11187 &"<>"&, it is set as the authenticated sender of the message, and the value is
11188 available during delivery in the &$authenticated_sender$& variable. If the
11189 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11190
11191 .vindex "&$qualify_domain$&"
11192 When a message is submitted locally (that is, not over a TCP connection), the
11193 value of &$authenticated_sender$& is an address constructed from the login
11194 name of the calling process and &$qualify_domain$&, except that a trusted user
11195 can override this by means of the &%-oMas%& command line option.
11196
11197
11198 .vitem &$authentication_failed$&
11199 .cindex "authentication" "failure"
11200 .vindex "&$authentication_failed$&"
11201 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11202 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11203 possible to distinguish between &"did not try to authenticate"&
11204 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11205 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11206 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11207 negative response to an AUTH command, including (for example) an attempt to use
11208 an undefined mechanism.
11209
11210 .vitem &$av_failed$&
11211 .cindex "content scanning" "AV scanner failure"
11212 This variable is available when Exim is compiled with the content-scanning
11213 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11214 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11215 the ACL malware condition.
11216
11217 .vitem &$body_linecount$&
11218 .cindex "message body" "line count"
11219 .cindex "body of message" "line count"
11220 .vindex "&$body_linecount$&"
11221 When a message is being received or delivered, this variable contains the
11222 number of lines in the message's body. See also &$message_linecount$&.
11223
11224 .vitem &$body_zerocount$&
11225 .cindex "message body" "binary zero count"
11226 .cindex "body of message" "binary zero count"
11227 .cindex "binary zero" "in message body"
11228 .vindex "&$body_zerocount$&"
11229 When a message is being received or delivered, this variable contains the
11230 number of binary zero bytes (ASCII NULs) in the message's body.
11231
11232 .vitem &$bounce_recipient$&
11233 .vindex "&$bounce_recipient$&"
11234 This is set to the recipient address of a bounce message while Exim is creating
11235 it. It is useful if a customized bounce message text file is in use (see
11236 chapter &<<CHAPemsgcust>>&).
11237
11238 .vitem &$bounce_return_size_limit$&
11239 .vindex "&$bounce_return_size_limit$&"
11240 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11241 up to a multiple of 1000. It is useful when a customized error message text
11242 file is in use (see chapter &<<CHAPemsgcust>>&).
11243
11244 .vitem &$caller_gid$&
11245 .cindex "gid (group id)" "caller"
11246 .vindex "&$caller_gid$&"
11247 The real group id under which the process that called Exim was running. This is
11248 not the same as the group id of the originator of a message (see
11249 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11250 incarnation normally contains the Exim gid.
11251
11252 .vitem &$caller_uid$&
11253 .cindex "uid (user id)" "caller"
11254 .vindex "&$caller_uid$&"
11255 The real user id under which the process that called Exim was running. This is
11256 not the same as the user id of the originator of a message (see
11257 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11258 incarnation normally contains the Exim uid.
11259
11260 .vitem &$compile_date$&
11261 .vindex "&$compile_date$&"
11262 The date on which the Exim binary was compiled.
11263
11264 .vitem &$compile_number$&
11265 .vindex "&$compile_number$&"
11266 The building process for Exim keeps a count of the number
11267 of times it has been compiled. This serves to distinguish different
11268 compilations of the same version of the program.
11269
11270 .new
11271 .vitem &$config_dir$&
11272 .vindex "&$config_dir$&"
11273 The directory name of the main configuration file. That is, the content of
11274 &$config_file$& with the last component stripped. The value does not
11275 contain the trailing slash. If &$config_file$& does not contain a slash,
11276 &$config_dir$& is ".".
11277
11278 .vitem &$config_file$&
11279 .vindex "&$config_file$&"
11280 The name of the main configuration file Exim is using.
11281 .wen
11282
11283 .vitem &$demime_errorlevel$&
11284 .vindex "&$demime_errorlevel$&"
11285 This variable is available when Exim is compiled with
11286 the content-scanning extension and the obsolete &%demime%& condition. For
11287 details, see section &<<SECTdemimecond>>&.
11288
11289 .vitem &$demime_reason$&
11290 .vindex "&$demime_reason$&"
11291 This variable is available when Exim is compiled with the
11292 content-scanning extension and the obsolete &%demime%& condition. For details,
11293 see section &<<SECTdemimecond>>&.
11294
11295 .vitem &$dnslist_domain$& &&&
11296        &$dnslist_matched$& &&&
11297        &$dnslist_text$& &&&
11298        &$dnslist_value$&
11299 .vindex "&$dnslist_domain$&"
11300 .vindex "&$dnslist_matched$&"
11301 .vindex "&$dnslist_text$&"
11302 .vindex "&$dnslist_value$&"
11303 .cindex "black list (DNS)"
11304 When a DNS (black) list lookup succeeds, these variables are set to contain
11305 the following data from the lookup: the list's domain name, the key that was
11306 looked up, the contents of any associated TXT record, and the value from the
11307 main A record. See section &<<SECID204>>& for more details.
11308
11309 .vitem &$domain$&
11310 .vindex "&$domain$&"
11311 When an address is being routed, or delivered on its own, this variable
11312 contains the domain. Uppercase letters in the domain are converted into lower
11313 case for &$domain$&.
11314
11315 Global address rewriting happens when a message is received, so the value of
11316 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11317 is set during user filtering, but not during system filtering, because a
11318 message may have many recipients and the system filter is called just once.
11319
11320 When more than one address is being delivered at once (for example, several
11321 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11322 have the same domain. Transports can be restricted to handling only one domain
11323 at a time if the value of &$domain$& is required at transport time &-- this is
11324 the default for local transports. For further details of the environment in
11325 which local transports are run, see chapter &<<CHAPenvironment>>&.
11326
11327 .oindex "&%delay_warning_condition%&"
11328 At the end of a delivery, if all deferred addresses have the same domain, it is
11329 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11330
11331 The &$domain$& variable is also used in some other circumstances:
11332
11333 .ilist
11334 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11335 the recipient address. The domain of the &'sender'& address is in
11336 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11337 normally set during the running of the MAIL ACL. However, if the sender address
11338 is verified with a callout during the MAIL ACL, the sender domain is placed in
11339 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11340 the &(smtp)& transport.
11341
11342 .next
11343 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11344 &$domain$& contains the domain portion of the address that is being rewritten;
11345 it can be used in the expansion of the replacement address, for example, to
11346 rewrite domains by file lookup.
11347
11348 .next
11349 With one important exception, whenever a domain list is being scanned,
11350 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11351 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11352 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11353 that, in a RCPT ACL, the sender domain list can be dependent on the
11354 recipient domain (which is what is in &$domain$& at this time).
11355
11356 .next
11357 .cindex "ETRN" "value of &$domain$&"
11358 .oindex "&%smtp_etrn_command%&"
11359 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11360 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11361 .endlist
11362
11363
11364 .vitem &$domain_data$&
11365 .vindex "&$domain_data$&"
11366 When the &%domains%& option on a router matches a domain by
11367 means of a lookup, the data read by the lookup is available during the running
11368 of the router as &$domain_data$&. In addition, if the driver routes the
11369 address to a transport, the value is available in that transport. If the
11370 transport is handling multiple addresses, the value from the first address is
11371 used.
11372
11373 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11374 domain by means of a lookup. The data read by the lookup is available during
11375 the rest of the ACL statement. In all other situations, this variable expands
11376 to nothing.
11377
11378 .vitem &$exim_gid$&
11379 .vindex "&$exim_gid$&"
11380 This variable contains the numerical value of the Exim group id.
11381
11382 .vitem &$exim_path$&
11383 .vindex "&$exim_path$&"
11384 This variable contains the path to the Exim binary.
11385
11386 .vitem &$exim_uid$&
11387 .vindex "&$exim_uid$&"
11388 This variable contains the numerical value of the Exim user id.
11389
11390 .new
11391 .vitem &$exim_version$&
11392 .vindex "&$exim_uid$&"
11393 This variable contains the version string of the Exim build.
11394 The first character is a major version number, currently 4.
11395 Then after a dot, the next group of digits is a minor version number.
11396 There may be other characters following the minor version.
11397 .wen
11398
11399 .vitem &$found_extension$&
11400 .vindex "&$found_extension$&"
11401 This variable is available when Exim is compiled with the
11402 content-scanning extension and the obsolete &%demime%& condition. For details,
11403 see section &<<SECTdemimecond>>&.
11404
11405 .vitem &$header_$&<&'name'&>
11406 This is not strictly an expansion variable. It is expansion syntax for
11407 inserting the message header line with the given name. Note that the name must
11408 be terminated by colon or white space, because it may contain a wide variety of
11409 characters. Note also that braces must &'not'& be used.
11410
11411 .vitem &$headers_added$&
11412 .vindex "&$headers_added$&"
11413 Within an ACL this variable contains the headers added so far by
11414 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11415 The headers are a newline-separated list.
11416
11417 .vitem &$home$&
11418 .vindex "&$home$&"
11419 When the &%check_local_user%& option is set for a router, the user's home
11420 directory is placed in &$home$& when the check succeeds. In particular, this
11421 means it is set during the running of users' filter files. A router may also
11422 explicitly set a home directory for use by a transport; this can be overridden
11423 by a setting on the transport itself.
11424
11425 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11426 of the environment variable HOME.
11427
11428 .vitem &$host$&
11429 .vindex "&$host$&"
11430 If a router assigns an address to a transport (any transport), and passes a
11431 list of hosts with the address, the value of &$host$& when the transport starts
11432 to run is the name of the first host on the list. Note that this applies both
11433 to local and remote transports.
11434
11435 .cindex "transport" "filter"
11436 .cindex "filter" "transport filter"
11437 For the &(smtp)& transport, if there is more than one host, the value of
11438 &$host$& changes as the transport works its way through the list. In
11439 particular, when the &(smtp)& transport is expanding its options for encryption
11440 using TLS, or for specifying a transport filter (see chapter
11441 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11442 is connected.
11443
11444 When used in the client part of an authenticator configuration (see chapter
11445 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11446 client is connected.
11447
11448
11449 .vitem &$host_address$&
11450 .vindex "&$host_address$&"
11451 This variable is set to the remote host's IP address whenever &$host$& is set
11452 for a remote connection. It is also set to the IP address that is being checked
11453 when the &%ignore_target_hosts%& option is being processed.
11454
11455 .vitem &$host_data$&
11456 .vindex "&$host_data$&"
11457 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11458 result of the lookup is made available in the &$host_data$& variable. This
11459 allows you, for example, to do things like this:
11460 .code
11461 deny  hosts = net-lsearch;/some/file
11462 message = $host_data
11463 .endd
11464 .vitem &$host_lookup_deferred$&
11465 .cindex "host name" "lookup, failure of"
11466 .vindex "&$host_lookup_deferred$&"
11467 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11468 message comes from a remote host and there is an attempt to look up the host's
11469 name from its IP address, and the attempt is not successful, one of these
11470 variables is set to &"1"&.
11471
11472 .ilist
11473 If the lookup receives a definite negative response (for example, a DNS lookup
11474 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11475
11476 .next
11477 If there is any kind of problem during the lookup, such that Exim cannot
11478 tell whether or not the host name is defined (for example, a timeout for a DNS
11479 lookup), &$host_lookup_deferred$& is set to &"1"&.
11480 .endlist ilist
11481
11482 Looking up a host's name from its IP address consists of more than just a
11483 single reverse lookup. Exim checks that a forward lookup of at least one of the
11484 names it receives from a reverse lookup yields the original IP address. If this
11485 is not the case, Exim does not accept the looked up name(s), and
11486 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11487 IP address (for example, the existence of a PTR record in the DNS) is not
11488 sufficient on its own for the success of a host name lookup. If the reverse
11489 lookup succeeds, but there is a lookup problem such as a timeout when checking
11490 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11491 &"1"&. See also &$sender_host_name$&.
11492
11493 .vitem &$host_lookup_failed$&
11494 .vindex "&$host_lookup_failed$&"
11495 See &$host_lookup_deferred$&.
11496
11497 .vitem &$host_port$&
11498 .vindex "&$host_port$&"
11499 This variable is set to the remote host's TCP port whenever &$host$& is set
11500 for an outbound connection.
11501
11502
11503 .vitem &$inode$&
11504 .vindex "&$inode$&"
11505 The only time this variable is set is while expanding the &%directory_file%&
11506 option in the &(appendfile)& transport. The variable contains the inode number
11507 of the temporary file which is about to be renamed. It can be used to construct
11508 a unique name for the file.
11509
11510 .vitem &$interface_address$&
11511 .vindex "&$interface_address$&"
11512 This is an obsolete name for &$received_ip_address$&.
11513
11514 .vitem &$interface_port$&
11515 .vindex "&$interface_port$&"
11516 This is an obsolete name for &$received_port$&.
11517
11518 .vitem &$item$&
11519 .vindex "&$item$&"
11520 This variable is used during the expansion of &*forall*& and &*forany*&
11521 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11522 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11523 empty.
11524
11525 .vitem &$ldap_dn$&
11526 .vindex "&$ldap_dn$&"
11527 This variable, which is available only when Exim is compiled with LDAP support,
11528 contains the DN from the last entry in the most recently successful LDAP
11529 lookup.
11530
11531 .vitem &$load_average$&
11532 .vindex "&$load_average$&"
11533 This variable contains the system load average, multiplied by 1000 so that it
11534 is an integer. For example, if the load average is 0.21, the value of the
11535 variable is 210. The value is recomputed every time the variable is referenced.
11536
11537 .vitem &$local_part$&
11538 .vindex "&$local_part$&"
11539 When an address is being routed, or delivered on its own, this
11540 variable contains the local part. When a number of addresses are being
11541 delivered together (for example, multiple RCPT commands in an SMTP
11542 session), &$local_part$& is not set.
11543
11544 Global address rewriting happens when a message is received, so the value of
11545 &$local_part$& during routing and delivery is the value after rewriting.
11546 &$local_part$& is set during user filtering, but not during system filtering,
11547 because a message may have many recipients and the system filter is called just
11548 once.
11549
11550 .vindex "&$local_part_prefix$&"
11551 .vindex "&$local_part_suffix$&"
11552 If a local part prefix or suffix has been recognized, it is not included in the
11553 value of &$local_part$& during routing and subsequent delivery. The values of
11554 any prefix or suffix are in &$local_part_prefix$& and
11555 &$local_part_suffix$&, respectively.
11556
11557 When a message is being delivered to a file, pipe, or autoreply transport as a
11558 result of aliasing or forwarding, &$local_part$& is set to the local part of
11559 the parent address, not to the file name or command (see &$address_file$& and
11560 &$address_pipe$&).
11561
11562 When an ACL is running for a RCPT command, &$local_part$& contains the
11563 local part of the recipient address.
11564
11565 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11566 &$local_part$& contains the local part of the address that is being rewritten;
11567 it can be used in the expansion of the replacement address, for example.
11568
11569 In all cases, all quoting is removed from the local part. For example, for both
11570 the addresses
11571 .code
11572 "abc:xyz"@test.example
11573 abc\:xyz@test.example
11574 .endd
11575 the value of &$local_part$& is
11576 .code
11577 abc:xyz
11578 .endd
11579 If you use &$local_part$& to create another address, you should always wrap it
11580 inside a quoting operator. For example, in a &(redirect)& router you could
11581 have:
11582 .code
11583 data = ${quote_local_part:$local_part}@new.domain.example
11584 .endd
11585 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11586 to process local parts in a case-dependent manner in a router, you can set the
11587 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11588
11589 .vitem &$local_part_data$&
11590 .vindex "&$local_part_data$&"
11591 When the &%local_parts%& option on a router matches a local part by means of a
11592 lookup, the data read by the lookup is available during the running of the
11593 router as &$local_part_data$&. In addition, if the driver routes the address
11594 to a transport, the value is available in that transport. If the transport is
11595 handling multiple addresses, the value from the first address is used.
11596
11597 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11598 matches a local part by means of a lookup. The data read by the lookup is
11599 available during the rest of the ACL statement. In all other situations, this
11600 variable expands to nothing.
11601
11602 .vitem &$local_part_prefix$&
11603 .vindex "&$local_part_prefix$&"
11604 When an address is being routed or delivered, and a
11605 specific prefix for the local part was recognized, it is available in this
11606 variable, having been removed from &$local_part$&.
11607
11608 .vitem &$local_part_suffix$&
11609 .vindex "&$local_part_suffix$&"
11610 When an address is being routed or delivered, and a
11611 specific suffix for the local part was recognized, it is available in this
11612 variable, having been removed from &$local_part$&.
11613
11614 .vitem &$local_scan_data$&
11615 .vindex "&$local_scan_data$&"
11616 This variable contains the text returned by the &[local_scan()]& function when
11617 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11618
11619 .vitem &$local_user_gid$&
11620 .vindex "&$local_user_gid$&"
11621 See &$local_user_uid$&.
11622
11623 .vitem &$local_user_uid$&
11624 .vindex "&$local_user_uid$&"
11625 This variable and &$local_user_gid$& are set to the uid and gid after the
11626 &%check_local_user%& router precondition succeeds. This means that their values
11627 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11628 and &%condition%&), for the &%address_data%& expansion, and for any
11629 router-specific expansions. At all other times, the values in these variables
11630 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11631
11632 .vitem &$localhost_number$&
11633 .vindex "&$localhost_number$&"
11634 This contains the expanded value of the
11635 &%localhost_number%& option. The expansion happens after the main options have
11636 been read.
11637
11638 .vitem &$log_inodes$&
11639 .vindex "&$log_inodes$&"
11640 The number of free inodes in the disk partition where Exim's
11641 log files are being written. The value is recalculated whenever the variable is
11642 referenced. If the relevant file system does not have the concept of inodes,
11643 the value of is -1. See also the &%check_log_inodes%& option.
11644
11645 .vitem &$log_space$&
11646 .vindex "&$log_space$&"
11647 The amount of free space (as a number of kilobytes) in the disk
11648 partition where Exim's log files are being written. The value is recalculated
11649 whenever the variable is referenced. If the operating system does not have the
11650 ability to find the amount of free space (only true for experimental systems),
11651 the space value is -1. See also the &%check_log_space%& option.
11652
11653
11654 .vitem &$lookup_dnssec_authenticated$&
11655 .vindex "&$lookup_dnssec_authenticated$&"
11656 This variable is set after a DNS lookup done by
11657 a dnsdb lookup expansion, dnslookup router or smtp transport.
11658 It will be empty if &(DNSSEC)& was not requested,
11659 &"no"& if the result was not labelled as authenticated data
11660 and &"yes"& if it was.
11661
11662 .vitem &$mailstore_basename$&
11663 .vindex "&$mailstore_basename$&"
11664 This variable is set only when doing deliveries in &"mailstore"& format in the
11665 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11666 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11667 contains the basename of the files that are being written, that is, the name
11668 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11669 variable is empty.
11670
11671 .vitem &$malware_name$&
11672 .vindex "&$malware_name$&"
11673 This variable is available when Exim is compiled with the
11674 content-scanning extension. It is set to the name of the virus that was found
11675 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11676
11677 .vitem &$max_received_linelength$&
11678 .vindex "&$max_received_linelength$&"
11679 .cindex "maximum" "line length"
11680 .cindex "line length" "maximum"
11681 This variable contains the number of bytes in the longest line that was
11682 received as part of the message, not counting the line termination
11683 character(s).
11684
11685 .vitem &$message_age$&
11686 .cindex "message" "age of"
11687 .vindex "&$message_age$&"
11688 This variable is set at the start of a delivery attempt to contain the number
11689 of seconds since the message was received. It does not change during a single
11690 delivery attempt.
11691
11692 .vitem &$message_body$&
11693 .cindex "body of message" "expansion variable"
11694 .cindex "message body" "in expansion"
11695 .cindex "binary zero" "in message body"
11696 .vindex "&$message_body$&"
11697 .oindex "&%message_body_visible%&"
11698 This variable contains the initial portion of a message's body while it is
11699 being delivered, and is intended mainly for use in filter files. The maximum
11700 number of characters of the body that are put into the variable is set by the
11701 &%message_body_visible%& configuration option; the default is 500.
11702
11703 .oindex "&%message_body_newlines%&"
11704 By default, newlines are converted into spaces in &$message_body$&, to make it
11705 easier to search for phrases that might be split over a line break. However,
11706 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11707 zeros are always converted into spaces.
11708
11709 .vitem &$message_body_end$&
11710 .cindex "body of message" "expansion variable"
11711 .cindex "message body" "in expansion"
11712 .vindex "&$message_body_end$&"
11713 This variable contains the final portion of a message's
11714 body while it is being delivered. The format and maximum size are as for
11715 &$message_body$&.
11716
11717 .vitem &$message_body_size$&
11718 .cindex "body of message" "size"
11719 .cindex "message body" "size"
11720 .vindex "&$message_body_size$&"
11721 When a message is being delivered, this variable contains the size of the body
11722 in bytes. The count starts from the character after the blank line that
11723 separates the body from the header. Newlines are included in the count. See
11724 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11725
11726 .vitem &$message_exim_id$&
11727 .vindex "&$message_exim_id$&"
11728 When a message is being received or delivered, this variable contains the
11729 unique message id that is generated and used by Exim to identify the message.
11730 An id is not created for a message until after its header has been successfully
11731 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11732 line; it is the local id that Exim assigns to the message, for example:
11733 &`1BXTIK-0001yO-VA`&.
11734
11735 .vitem &$message_headers$&
11736 .vindex &$message_headers$&
11737 This variable contains a concatenation of all the header lines when a message
11738 is being processed, except for lines added by routers or transports. The header
11739 lines are separated by newline characters. Their contents are decoded in the
11740 same way as a header line that is inserted by &%bheader%&.
11741
11742 .vitem &$message_headers_raw$&
11743 .vindex &$message_headers_raw$&
11744 This variable is like &$message_headers$& except that no processing of the
11745 contents of header lines is done.
11746
11747 .vitem &$message_id$&
11748 This is an old name for &$message_exim_id$&. It is now deprecated.
11749
11750 .vitem &$message_linecount$&
11751 .vindex "&$message_linecount$&"
11752 This variable contains the total number of lines in the header and body of the
11753 message. Compare &$body_linecount$&, which is the count for the body only.
11754 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11755 number of lines received. Before delivery happens (that is, before filters,
11756 routers, and transports run) the count is increased to include the
11757 &'Received:'& header line that Exim standardly adds, and also any other header
11758 lines that are added by ACLs. The blank line that separates the message header
11759 from the body is not counted.
11760
11761 As with the special case of &$message_size$&, during the expansion of the
11762 appendfile transport's maildir_tag option in maildir format, the value of
11763 &$message_linecount$& is the precise size of the number of newlines in the
11764 file that has been written (minus one for the blank line between the
11765 header and the body).
11766
11767 Here is an example of the use of this variable in a DATA ACL:
11768 .code
11769 deny message   = Too many lines in message header
11770      condition = \
11771       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11772 .endd
11773 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11774 message has not yet been received.
11775
11776 .vitem &$message_size$&
11777 .cindex "size" "of message"
11778 .cindex "message" "size"
11779 .vindex "&$message_size$&"
11780 When a message is being processed, this variable contains its size in bytes. In
11781 most cases, the size includes those headers that were received with the
11782 message, but not those (such as &'Envelope-to:'&) that are added to individual
11783 deliveries as they are written. However, there is one special case: during the
11784 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11785 doing a delivery in maildir format, the value of &$message_size$& is the
11786 precise size of the file that has been written. See also
11787 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11788
11789 .cindex "RCPT" "value of &$message_size$&"
11790 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11791 contains the size supplied on the MAIL command, or -1 if no size was given. The
11792 value may not, of course, be truthful.
11793
11794 .vitem &$mime_$&&'xxx'&
11795 A number of variables whose names start with &$mime$& are
11796 available when Exim is compiled with the content-scanning extension. For
11797 details, see section &<<SECTscanmimepart>>&.
11798
11799 .vitem "&$n0$& &-- &$n9$&"
11800 These variables are counters that can be incremented by means
11801 of the &%add%& command in filter files.
11802
11803 .vitem &$original_domain$&
11804 .vindex "&$domain$&"
11805 .vindex "&$original_domain$&"
11806 When a top-level address is being processed for delivery, this contains the
11807 same value as &$domain$&. However, if a &"child"& address (for example,
11808 generated by an alias, forward, or filter file) is being processed, this
11809 variable contains the domain of the original address (lower cased). This
11810 differs from &$parent_domain$& only when there is more than one level of
11811 aliasing or forwarding. When more than one address is being delivered in a
11812 single transport run, &$original_domain$& is not set.
11813
11814 If a new address is created by means of a &%deliver%& command in a system
11815 filter, it is set up with an artificial &"parent"& address. This has the local
11816 part &'system-filter'& and the default qualify domain.
11817
11818 .vitem &$original_local_part$&
11819 .vindex "&$local_part$&"
11820 .vindex "&$original_local_part$&"
11821 When a top-level address is being processed for delivery, this contains the
11822 same value as &$local_part$&, unless a prefix or suffix was removed from the
11823 local part, because &$original_local_part$& always contains the full local
11824 part. When a &"child"& address (for example, generated by an alias, forward, or
11825 filter file) is being processed, this variable contains the full local part of
11826 the original address.
11827
11828 If the router that did the redirection processed the local part
11829 case-insensitively, the value in &$original_local_part$& is in lower case.
11830 This variable differs from &$parent_local_part$& only when there is more than
11831 one level of aliasing or forwarding. When more than one address is being
11832 delivered in a single transport run, &$original_local_part$& is not set.
11833
11834 If a new address is created by means of a &%deliver%& command in a system
11835 filter, it is set up with an artificial &"parent"& address. This has the local
11836 part &'system-filter'& and the default qualify domain.
11837
11838 .vitem &$originator_gid$&
11839 .cindex "gid (group id)" "of originating user"
11840 .cindex "sender" "gid"
11841 .vindex "&$caller_gid$&"
11842 .vindex "&$originator_gid$&"
11843 This variable contains the value of &$caller_gid$& that was set when the
11844 message was received. For messages received via the command line, this is the
11845 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11846 normally the gid of the Exim user.
11847
11848 .vitem &$originator_uid$&
11849 .cindex "uid (user id)" "of originating user"
11850 .cindex "sender" "uid"
11851 .vindex "&$caller_uid$&"
11852 .vindex "&$originaltor_uid$&"
11853 The value of &$caller_uid$& that was set when the message was received. For
11854 messages received via the command line, this is the uid of the sending user.
11855 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11856 user.
11857
11858 .vitem &$parent_domain$&
11859 .vindex "&$parent_domain$&"
11860 This variable is similar to &$original_domain$& (see
11861 above), except that it refers to the immediately preceding parent address.
11862
11863 .vitem &$parent_local_part$&
11864 .vindex "&$parent_local_part$&"
11865 This variable is similar to &$original_local_part$&
11866 (see above), except that it refers to the immediately preceding parent address.
11867
11868 .vitem &$pid$&
11869 .cindex "pid (process id)" "of current process"
11870 .vindex "&$pid$&"
11871 This variable contains the current process id.
11872
11873 .vitem &$pipe_addresses$&
11874 .cindex "filter" "transport filter"
11875 .cindex "transport" "filter"
11876 .vindex "&$pipe_addresses$&"
11877 This is not an expansion variable, but is mentioned here because the string
11878 &`$pipe_addresses`& is handled specially in the command specification for the
11879 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11880 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11881 It cannot be used in general expansion strings, and provokes an &"unknown
11882 variable"& error if encountered.
11883
11884 .vitem &$primary_hostname$&
11885 .vindex "&$primary_hostname$&"
11886 This variable contains the value set by &%primary_hostname%& in the
11887 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11888 a single-component name, Exim calls &[gethostbyname()]& (or
11889 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11890 qualified host name. See also &$smtp_active_hostname$&.
11891
11892
11893 .vitem &$prvscheck_address$&
11894 This variable is used in conjunction with the &%prvscheck%& expansion item,
11895 which is described in sections &<<SECTexpansionitems>>& and
11896 &<<SECTverifyPRVS>>&.
11897
11898 .vitem &$prvscheck_keynum$&
11899 This variable is used in conjunction with the &%prvscheck%& expansion item,
11900 which is described in sections &<<SECTexpansionitems>>& and
11901 &<<SECTverifyPRVS>>&.
11902
11903 .vitem &$prvscheck_result$&
11904 This variable is used in conjunction with the &%prvscheck%& expansion item,
11905 which is described in sections &<<SECTexpansionitems>>& and
11906 &<<SECTverifyPRVS>>&.
11907
11908 .vitem &$qualify_domain$&
11909 .vindex "&$qualify_domain$&"
11910 The value set for the &%qualify_domain%& option in the configuration file.
11911
11912 .vitem &$qualify_recipient$&
11913 .vindex "&$qualify_recipient$&"
11914 The value set for the &%qualify_recipient%& option in the configuration file,
11915 or if not set, the value of &$qualify_domain$&.
11916
11917 .vitem &$rcpt_count$&
11918 .vindex "&$rcpt_count$&"
11919 When a message is being received by SMTP, this variable contains the number of
11920 RCPT commands received for the current message. If this variable is used in a
11921 RCPT ACL, its value includes the current command.
11922
11923 .vitem &$rcpt_defer_count$&
11924 .vindex "&$rcpt_defer_count$&"
11925 .cindex "4&'xx'& responses" "count of"
11926 When a message is being received by SMTP, this variable contains the number of
11927 RCPT commands in the current message that have previously been rejected with a
11928 temporary (4&'xx'&) response.
11929
11930 .vitem &$rcpt_fail_count$&
11931 .vindex "&$rcpt_fail_count$&"
11932 When a message is being received by SMTP, this variable contains the number of
11933 RCPT commands in the current message that have previously been rejected with a
11934 permanent (5&'xx'&) response.
11935
11936 .vitem &$received_count$&
11937 .vindex "&$received_count$&"
11938 This variable contains the number of &'Received:'& header lines in the message,
11939 including the one added by Exim (so its value is always greater than zero). It
11940 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11941 delivering.
11942
11943 .vitem &$received_for$&
11944 .vindex "&$received_for$&"
11945 If there is only a single recipient address in an incoming message, this
11946 variable contains that address when the &'Received:'& header line is being
11947 built. The value is copied after recipient rewriting has happened, but before
11948 the &[local_scan()]& function is run.
11949
11950 .vitem &$received_ip_address$&
11951 .vindex "&$received_ip_address$&"
11952 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11953 variable is set to the address of the local IP interface, and &$received_port$&
11954 is set to the local port number. (The remote IP address and port are in
11955 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11956 the port value is -1 unless it has been set using the &%-oMi%& command line
11957 option.
11958
11959 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11960 could be used, for example, to make the file name for a TLS certificate depend
11961 on which interface and/or port is being used for the incoming connection. The
11962 values of &$received_ip_address$& and &$received_port$& are saved with any
11963 messages that are received, thus making these variables available at delivery
11964 time.
11965 For outbound connections see &$sending_ip_address$&.
11966
11967 .vitem &$received_port$&
11968 .vindex "&$received_port$&"
11969 See &$received_ip_address$&.
11970
11971 .vitem &$received_protocol$&
11972 .vindex "&$received_protocol$&"
11973 When a message is being processed, this variable contains the name of the
11974 protocol by which it was received. Most of the names used by Exim are defined
11975 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11976 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11977 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11978 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11979 connection and the client was successfully authenticated.
11980
11981 Exim uses the protocol name &"smtps"& for the case when encryption is
11982 automatically set up on connection without the use of STARTTLS (see
11983 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11984 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11985 where the client initially uses EHLO, sets up an encrypted connection using
11986 STARTTLS, and then uses HELO afterwards.
11987
11988 The &%-oMr%& option provides a way of specifying a custom protocol name for
11989 messages that are injected locally by trusted callers. This is commonly used to
11990 identify messages that are being re-injected after some kind of scanning.
11991
11992 .vitem &$received_time$&
11993 .vindex "&$received_time$&"
11994 This variable contains the date and time when the current message was received,
11995 as a number of seconds since the start of the Unix epoch.
11996
11997 .vitem &$recipient_data$&
11998 .vindex "&$recipient_data$&"
11999 This variable is set after an indexing lookup success in an ACL &%recipients%&
12000 condition. It contains the data from the lookup, and the value remains set
12001 until the next &%recipients%& test. Thus, you can do things like this:
12002 .display
12003 &`require recipients  = cdb*@;/some/file`&
12004 &`deny    `&&'some further test involving'& &`$recipient_data`&
12005 .endd
12006 &*Warning*&: This variable is set only when a lookup is used as an indexing
12007 method in the address list, using the semicolon syntax as in the example above.
12008 The variable is not set for a lookup that is used as part of the string
12009 expansion that all such lists undergo before being interpreted.
12010
12011 .vitem &$recipient_verify_failure$&
12012 .vindex "&$recipient_verify_failure$&"
12013 In an ACL, when a recipient verification fails, this variable contains
12014 information about the failure. It is set to one of the following words:
12015
12016 .ilist
12017 &"qualify"&: The address was unqualified (no domain), and the message
12018 was neither local nor came from an exempted host.
12019
12020 .next
12021 &"route"&: Routing failed.
12022
12023 .next
12024 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12025 or before the MAIL command (that is, on initial connection, HELO, or
12026 MAIL).
12027
12028 .next
12029 &"recipient"&: The RCPT command in a callout was rejected.
12030 .next
12031
12032 &"postmaster"&: The postmaster check in a callout was rejected.
12033 .endlist
12034
12035 The main use of this variable is expected to be to distinguish between
12036 rejections of MAIL and rejections of RCPT.
12037
12038 .vitem &$recipients$&
12039 .vindex "&$recipients$&"
12040 This variable contains a list of envelope recipients for a message. A comma and
12041 a space separate the addresses in the replacement text. However, the variable
12042 is not generally available, to prevent exposure of Bcc recipients in
12043 unprivileged users' filter files. You can use &$recipients$& only in these
12044 cases:
12045
12046 .olist
12047 In a system filter file.
12048 .next
12049 In the ACLs associated with the DATA command and with non-SMTP messages, that
12050 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12051 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12052 &%acl_not_smtp_mime%&.
12053 .next
12054 From within a &[local_scan()]& function.
12055 .endlist
12056
12057
12058 .vitem &$recipients_count$&
12059 .vindex "&$recipients_count$&"
12060 When a message is being processed, this variable contains the number of
12061 envelope recipients that came with the message. Duplicates are not excluded
12062 from the count. While a message is being received over SMTP, the number
12063 increases for each accepted recipient. It can be referenced in an ACL.
12064
12065
12066 .vitem &$regex_match_string$&
12067 .vindex "&$regex_match_string$&"
12068 This variable is set to contain the matching regular expression after a
12069 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12070
12071
12072 .vitem &$reply_address$&
12073 .vindex "&$reply_address$&"
12074 When a message is being processed, this variable contains the contents of the
12075 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12076 contents of the &'From:'& header line. Apart from the removal of leading
12077 white space, the value is not processed in any way. In particular, no RFC 2047
12078 decoding or character code translation takes place.
12079
12080 .vitem &$return_path$&
12081 .vindex "&$return_path$&"
12082 When a message is being delivered, this variable contains the return path &--
12083 the sender field that will be sent as part of the envelope. It is not enclosed
12084 in <> characters. At the start of routing an address, &$return_path$& has the
12085 same value as &$sender_address$&, but if, for example, an incoming message to a
12086 mailing list has been expanded by a router which specifies a different address
12087 for bounce messages, &$return_path$& subsequently contains the new bounce
12088 address, whereas &$sender_address$& always contains the original sender address
12089 that was received with the message. In other words, &$sender_address$& contains
12090 the incoming envelope sender, and &$return_path$& contains the outgoing
12091 envelope sender.
12092
12093 .vitem &$return_size_limit$&
12094 .vindex "&$return_size_limit$&"
12095 This is an obsolete name for &$bounce_return_size_limit$&.
12096
12097 .vitem &$router_name$&
12098 .cindex "router" "name"
12099 .cindex "name" "of router"
12100 .vindex "&$router_name$&"
12101 During the running of a router this variable contains its name.
12102
12103 .vitem &$runrc$&
12104 .cindex "return code" "from &%run%& expansion"
12105 .vindex "&$runrc$&"
12106 This variable contains the return code from a command that is run by the
12107 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12108 assume the order in which option values are expanded, except for those
12109 preconditions whose order of testing is documented. Therefore, you cannot
12110 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12111 another.
12112
12113 .vitem &$self_hostname$&
12114 .oindex "&%self%&" "value of host name"
12115 .vindex "&$self_hostname$&"
12116 When an address is routed to a supposedly remote host that turns out to be the
12117 local host, what happens is controlled by the &%self%& generic router option.
12118 One of its values causes the address to be passed to another router. When this
12119 happens, &$self_hostname$& is set to the name of the local host that the
12120 original router encountered. In other circumstances its contents are null.
12121
12122 .vitem &$sender_address$&
12123 .vindex "&$sender_address$&"
12124 When a message is being processed, this variable contains the sender's address
12125 that was received in the message's envelope. The case of letters in the address
12126 is retained, in both the local part and the domain. For bounce messages, the
12127 value of this variable is the empty string. See also &$return_path$&.
12128
12129 .vitem &$sender_address_data$&
12130 .vindex "&$address_data$&"
12131 .vindex "&$sender_address_data$&"
12132 If &$address_data$& is set when the routers are called from an ACL to verify a
12133 sender address, the final value is preserved in &$sender_address_data$&, to
12134 distinguish it from data from a recipient address. The value does not persist
12135 after the end of the current ACL statement. If you want to preserve it for
12136 longer, you can save it in an ACL variable.
12137
12138 .vitem &$sender_address_domain$&
12139 .vindex "&$sender_address_domain$&"
12140 The domain portion of &$sender_address$&.
12141
12142 .vitem &$sender_address_local_part$&
12143 .vindex "&$sender_address_local_part$&"
12144 The local part portion of &$sender_address$&.
12145
12146 .vitem &$sender_data$&
12147 .vindex "&$sender_data$&"
12148 This variable is set after a lookup success in an ACL &%senders%& condition or
12149 in a router &%senders%& option. It contains the data from the lookup, and the
12150 value remains set until the next &%senders%& test. Thus, you can do things like
12151 this:
12152 .display
12153 &`require senders      = cdb*@;/some/file`&
12154 &`deny    `&&'some further test involving'& &`$sender_data`&
12155 .endd
12156 &*Warning*&: This variable is set only when a lookup is used as an indexing
12157 method in the address list, using the semicolon syntax as in the example above.
12158 The variable is not set for a lookup that is used as part of the string
12159 expansion that all such lists undergo before being interpreted.
12160
12161 .vitem &$sender_fullhost$&
12162 .vindex "&$sender_fullhost$&"
12163 When a message is received from a remote host, this variable contains the host
12164 name and IP address in a single string. It ends with the IP address in square
12165 brackets, followed by a colon and a port number if the logging of ports is
12166 enabled. The format of the rest of the string depends on whether the host
12167 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12168 looking up its IP address. (Looking up the IP address can be forced by the
12169 &%host_lookup%& option, independent of verification.) A plain host name at the
12170 start of the string is a verified host name; if this is not present,
12171 verification either failed or was not requested. A host name in parentheses is
12172 the argument of a HELO or EHLO command. This is omitted if it is identical to
12173 the verified host name or to the host's IP address in square brackets.
12174
12175 .vitem &$sender_helo_name$&
12176 .vindex "&$sender_helo_name$&"
12177 When a message is received from a remote host that has issued a HELO or EHLO
12178 command, the argument of that command is placed in this variable. It is also
12179 set if HELO or EHLO is used when a message is received using SMTP locally via
12180 the &%-bs%& or &%-bS%& options.
12181
12182 .vitem &$sender_host_address$&
12183 .vindex "&$sender_host_address$&"
12184 When a message is received from a remote host using SMTP,
12185 this variable contains that
12186 host's IP address. For locally non-SMTP submitted messages, it is empty.
12187
12188 .vitem &$sender_host_authenticated$&
12189 .vindex "&$sender_host_authenticated$&"
12190 This variable contains the name (not the public name) of the authenticator
12191 driver that successfully authenticated the client from which the message was
12192 received. It is empty if there was no successful authentication. See also
12193 &$authenticated_id$&.
12194
12195 .vitem &$sender_host_dnssec$&
12196 .vindex "&$sender_host_dnssec$&"
12197 If an attempt to populate &$sender_host_name$& has been made
12198 (by reference, &%hosts_lookup%& or
12199 otherwise) then this boolean will have been set true if, and only if, the
12200 resolver library states that the reverse DNS was authenticated data.  At all
12201 other times, this variable is false.
12202
12203 It is likely that you will need to coerce DNSSEC support on in the resolver
12204 library, by setting:
12205 .code
12206 dns_dnssec_ok = 1
12207 .endd
12208
12209 Exim does not perform DNSSEC validation itself, instead leaving that to a
12210 validating resolver (eg, unbound, or bind with suitable configuration).
12211
12212 Exim does not (currently) check to see if the forward DNS was also secured
12213 with DNSSEC, only the reverse DNS.
12214
12215 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12216 mechanism in the list, then this variable will be false.
12217
12218
12219 .vitem &$sender_host_name$&
12220 .vindex "&$sender_host_name$&"
12221 When a message is received from a remote host, this variable contains the
12222 host's name as obtained by looking up its IP address. For messages received by
12223 other means, this variable is empty.
12224
12225 .vindex "&$host_lookup_failed$&"
12226 If the host name has not previously been looked up, a reference to
12227 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12228 A looked up name is accepted only if it leads back to the original IP address
12229 via a forward lookup. If either the reverse or the forward lookup fails to find
12230 any data, or if the forward lookup does not yield the original IP address,
12231 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12232
12233 .vindex "&$host_lookup_deferred$&"
12234 However, if either of the lookups cannot be completed (for example, there is a
12235 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12236 &$host_lookup_failed$& remains set to &"0"&.
12237
12238 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12239 host name again if there is a subsequent reference to &$sender_host_name$&
12240 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12241 is set to &"1"&.
12242
12243 Exim does not automatically look up every calling host's name. If you want
12244 maximum efficiency, you should arrange your configuration so that it avoids
12245 these lookups altogether. The lookup happens only if one or more of the
12246 following are true:
12247
12248 .ilist
12249 A string containing &$sender_host_name$& is expanded.
12250 .next
12251 The calling host matches the list in &%host_lookup%&. In the default
12252 configuration, this option is set to *, so it must be changed if lookups are
12253 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12254 .next
12255 Exim needs the host name in order to test an item in a host list. The items
12256 that require this are described in sections &<<SECThoslispatnam>>& and
12257 &<<SECThoslispatnamsk>>&.
12258 .next
12259 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12260 In this case, the host name is required to compare with the name quoted in any
12261 EHLO or HELO commands that the client issues.
12262 .next
12263 The remote host issues a EHLO or HELO command that quotes one of the
12264 domains in &%helo_lookup_domains%&. The default value of this option is
12265 . ==== As this is a nested list, any displays it contains must be indented
12266 . ==== as otherwise they are too far to the left.
12267 .code
12268   helo_lookup_domains = @ : @[]
12269 .endd
12270 which causes a lookup if a remote host (incorrectly) gives the server's name or
12271 IP address in an EHLO or HELO command.
12272 .endlist
12273
12274
12275 .vitem &$sender_host_port$&
12276 .vindex "&$sender_host_port$&"
12277 When a message is received from a remote host, this variable contains the port
12278 number that was used on the remote host.
12279
12280 .vitem &$sender_ident$&
12281 .vindex "&$sender_ident$&"
12282 When a message is received from a remote host, this variable contains the
12283 identification received in response to an RFC 1413 request. When a message has
12284 been received locally, this variable contains the login name of the user that
12285 called Exim.
12286
12287 .vitem &$sender_rate_$&&'xxx'&
12288 A number of variables whose names begin &$sender_rate_$& are set as part of the
12289 &%ratelimit%& ACL condition. Details are given in section
12290 &<<SECTratelimiting>>&.
12291
12292 .vitem &$sender_rcvhost$&
12293 .cindex "DNS" "reverse lookup"
12294 .cindex "reverse DNS lookup"
12295 .vindex "&$sender_rcvhost$&"
12296 This is provided specifically for use in &'Received:'& headers. It starts with
12297 either the verified host name (as obtained from a reverse DNS lookup) or, if
12298 there is no verified host name, the IP address in square brackets. After that
12299 there may be text in parentheses. When the first item is a verified host name,
12300 the first thing in the parentheses is the IP address in square brackets,
12301 followed by a colon and a port number if port logging is enabled. When the
12302 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12303 the parentheses.
12304
12305 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12306 was used and its argument was not identical to the real host name or IP
12307 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12308 all three items are present in the parentheses, a newline and tab are inserted
12309 into the string, to improve the formatting of the &'Received:'& header.
12310
12311 .vitem &$sender_verify_failure$&
12312 .vindex "&$sender_verify_failure$&"
12313 In an ACL, when a sender verification fails, this variable contains information
12314 about the failure. The details are the same as for
12315 &$recipient_verify_failure$&.
12316
12317 .vitem &$sending_ip_address$&
12318 .vindex "&$sending_ip_address$&"
12319 This variable is set whenever an outgoing SMTP connection to another host has
12320 been set up. It contains the IP address of the local interface that is being
12321 used. This is useful if a host that has more than one IP address wants to take
12322 on different personalities depending on which one is being used. For incoming
12323 connections, see &$received_ip_address$&.
12324
12325 .vitem &$sending_port$&
12326 .vindex "&$sending_port$&"
12327 This variable is set whenever an outgoing SMTP connection to another host has
12328 been set up. It contains the local port that is being used. For incoming
12329 connections, see &$received_port$&.
12330
12331 .vitem &$smtp_active_hostname$&
12332 .vindex "&$smtp_active_hostname$&"
12333 During an incoming SMTP session, this variable contains the value of the active
12334 host name, as specified by the &%smtp_active_hostname%& option. The value of
12335 &$smtp_active_hostname$& is saved with any message that is received, so its
12336 value can be consulted during routing and delivery.
12337
12338 .vitem &$smtp_command$&
12339 .vindex "&$smtp_command$&"
12340 During the processing of an incoming SMTP command, this variable contains the
12341 entire command. This makes it possible to distinguish between HELO and EHLO in
12342 the HELO ACL, and also to distinguish between commands such as these:
12343 .code
12344 MAIL FROM:<>
12345 MAIL FROM: <>
12346 .endd
12347 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12348 command, the address in &$smtp_command$& is the original address before any
12349 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12350 the address after SMTP-time rewriting.
12351
12352 .vitem &$smtp_command_argument$&
12353 .cindex "SMTP" "command, argument for"
12354 .vindex "&$smtp_command_argument$&"
12355 While an ACL is running to check an SMTP command, this variable contains the
12356 argument, that is, the text that follows the command name, with leading white
12357 space removed. Following the introduction of &$smtp_command$&, this variable is
12358 somewhat redundant, but is retained for backwards compatibility.
12359
12360 .vitem &$smtp_count_at_connection_start$&
12361 .vindex "&$smtp_count_at_connection_start$&"
12362 This variable is set greater than zero only in processes spawned by the Exim
12363 daemon for handling incoming SMTP connections. The name is deliberately long,
12364 in order to emphasize what the contents are. When the daemon accepts a new
12365 connection, it increments this variable. A copy of the variable is passed to
12366 the child process that handles the connection, but its value is fixed, and
12367 never changes. It is only an approximation of how many incoming connections
12368 there actually are, because many other connections may come and go while a
12369 single connection is being processed. When a child process terminates, the
12370 daemon decrements its copy of the variable.
12371
12372 .vitem "&$sn0$& &-- &$sn9$&"
12373 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12374 that were current at the end of the system filter file. This allows a system
12375 filter file to set values that can be tested in users' filter files. For
12376 example, a system filter could set a value indicating how likely it is that a
12377 message is junk mail.
12378
12379 .vitem &$spam_$&&'xxx'&
12380 A number of variables whose names start with &$spam$& are available when Exim
12381 is compiled with the content-scanning extension. For details, see section
12382 &<<SECTscanspamass>>&.
12383
12384
12385 .vitem &$spool_directory$&
12386 .vindex "&$spool_directory$&"
12387 The name of Exim's spool directory.
12388
12389 .vitem &$spool_inodes$&
12390 .vindex "&$spool_inodes$&"
12391 The number of free inodes in the disk partition where Exim's spool files are
12392 being written. The value is recalculated whenever the variable is referenced.
12393 If the relevant file system does not have the concept of inodes, the value of
12394 is -1. See also the &%check_spool_inodes%& option.
12395
12396 .vitem &$spool_space$&
12397 .vindex "&$spool_space$&"
12398 The amount of free space (as a number of kilobytes) in the disk partition where
12399 Exim's spool files are being written. The value is recalculated whenever the
12400 variable is referenced. If the operating system does not have the ability to
12401 find the amount of free space (only true for experimental systems), the space
12402 value is -1. For example, to check in an ACL that there is at least 50
12403 megabytes free on the spool, you could write:
12404 .code
12405 condition = ${if > {$spool_space}{50000}}
12406 .endd
12407 See also the &%check_spool_space%& option.
12408
12409
12410 .vitem &$thisaddress$&
12411 .vindex "&$thisaddress$&"
12412 This variable is set only during the processing of the &%foranyaddress%&
12413 command in a filter file. Its use is explained in the description of that
12414 command, which can be found in the separate document entitled &'Exim's
12415 interfaces to mail filtering'&.
12416
12417 .vitem &$tls_in_bits$&
12418 .vindex "&$tls_in_bits$&"
12419 Contains an approximation of the TLS cipher's bit-strength
12420 on the inbound connection; the meaning of
12421 this depends upon the TLS implementation used.
12422 If TLS has not been negotiated, the value will be 0.
12423 The value of this is automatically fed into the Cyrus SASL authenticator
12424 when acting as a server, to specify the "external SSF" (a SASL term).
12425
12426 The deprecated &$tls_bits$& variable refers to the inbound side
12427 except when used in the context of an outbound SMTP delivery, when it refers to
12428 the outbound.
12429
12430 .vitem &$tls_out_bits$&
12431 .vindex "&$tls_out_bits$&"
12432 Contains an approximation of the TLS cipher's bit-strength
12433 on an outbound SMTP connection; the meaning of
12434 this depends upon the TLS implementation used.
12435 If TLS has not been negotiated, the value will be 0.
12436
12437 .vitem &$tls_in_ourcert$&
12438 .vindex "&$tls_in_ourcert$&"
12439 This variable refers to the certificate presented to the peer of an
12440 inbound connection when the message was received.
12441 It is only useful as the argument of a
12442 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12443 or a &%def%& condition.
12444
12445 .vitem &$tls_in_peercert$&
12446 .vindex "&$tls_in_peercert$&"
12447 This variable refers to the certificate presented by the peer of an
12448 inbound connection when the message was received.
12449 It is only useful as the argument of a
12450 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12451 or a &%def%& condition.
12452 If certificate verification fails it may refer to a failing chain element
12453 which is not the leaf.
12454
12455 .vitem &$tls_out_ourcert$&
12456 .vindex "&$tls_out_ourcert$&"
12457 This variable refers to the certificate presented to the peer of an
12458 outbound connection.  It is only useful as the argument of a
12459 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12460 or a &%def%& condition.
12461
12462 .vitem &$tls_out_peercert$&
12463 .vindex "&$tls_out_peercert$&"
12464 This variable refers to the certificate presented by the peer of an
12465 outbound connection.  It is only useful as the argument of a
12466 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12467 or a &%def%& condition.
12468 If certificate verification fails it may refer to a failing chain element
12469 which is not the leaf.
12470
12471 .vitem &$tls_in_certificate_verified$&
12472 .vindex "&$tls_in_certificate_verified$&"
12473 This variable is set to &"1"& if a TLS certificate was verified when the
12474 message was received, and &"0"& otherwise.
12475
12476 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12477 except when used in the context of an outbound SMTP delivery, when it refers to
12478 the outbound.
12479
12480 .vitem &$tls_out_certificate_verified$&
12481 .vindex "&$tls_out_certificate_verified$&"
12482 This variable is set to &"1"& if a TLS certificate was verified when an
12483 outbound SMTP connection was made,
12484 and &"0"& otherwise.
12485
12486 .vitem &$tls_in_cipher$&
12487 .vindex "&$tls_in_cipher$&"
12488 .vindex "&$tls_cipher$&"
12489 When a message is received from a remote host over an encrypted SMTP
12490 connection, this variable is set to the cipher suite that was negotiated, for
12491 example DES-CBC3-SHA. In other circumstances, in particular, for message
12492 received over unencrypted connections, the variable is empty. Testing
12493 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12494 non-encrypted connections during ACL processing.
12495
12496 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12497 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12498 becomes the same as &$tls_out_cipher$&.
12499
12500 .vitem &$tls_out_cipher$&
12501 .vindex "&$tls_out_cipher$&"
12502 This variable is
12503 cleared before any outgoing SMTP connection is made,
12504 and then set to the outgoing cipher suite if one is negotiated. See chapter
12505 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12506 details of the &(smtp)& transport.
12507
12508 .vitem &$tls_in_ocsp$&
12509 .vindex "&$tls_in_ocsp$&"
12510 When a message is received from a remote client connection
12511 the result of any OCSP request from the client is encoded in this variable:
12512 .code
12513 0 OCSP proof was not requested (default value)
12514 1 No response to request
12515 2 Response not verified
12516 3 Verification failed
12517 4 Verification succeeded
12518 .endd
12519
12520 .vitem &$tls_out_ocsp$&
12521 .vindex "&$tls_out_ocsp$&"
12522 When a message is sent to a remote host connection
12523 the result of any OCSP request made is encoded in this variable.
12524 See &$tls_in_ocsp$& for values.
12525
12526 .vitem &$tls_in_peerdn$&
12527 .vindex "&$tls_in_peerdn$&"
12528 .vindex "&$tls_peerdn$&"
12529 When a message is received from a remote host over an encrypted SMTP
12530 connection, and Exim is configured to request a certificate from the client,
12531 the value of the Distinguished Name of the certificate is made available in the
12532 &$tls_in_peerdn$& during subsequent processing.
12533 If certificate verification fails it may refer to a failing chain element
12534 which is not the leaf.
12535
12536 The deprecated &$tls_peerdn$& variable refers to the inbound side
12537 except when used in the context of an outbound SMTP delivery, when it refers to
12538 the outbound.
12539
12540 .vitem &$tls_out_peerdn$&
12541 .vindex "&$tls_out_peerdn$&"
12542 When a message is being delivered to a remote host over an encrypted SMTP
12543 connection, and Exim is configured to request a certificate from the server,
12544 the value of the Distinguished Name of the certificate is made available in the
12545 &$tls_out_peerdn$& during subsequent processing.
12546 If certificate verification fails it may refer to a failing chain element
12547 which is not the leaf.
12548
12549 .vitem &$tls_in_sni$&
12550 .vindex "&$tls_in_sni$&"
12551 .vindex "&$tls_sni$&"
12552 .cindex "TLS" "Server Name Indication"
12553 When a TLS session is being established, if the client sends the Server
12554 Name Indication extension, the value will be placed in this variable.
12555 If the variable appears in &%tls_certificate%& then this option and
12556 some others, described in &<<SECTtlssni>>&,
12557 will be re-expanded early in the TLS session, to permit
12558 a different certificate to be presented (and optionally a different key to be
12559 used) to the client, based upon the value of the SNI extension.
12560
12561 The deprecated &$tls_sni$& variable refers to the inbound side
12562 except when used in the context of an outbound SMTP delivery, when it refers to
12563 the outbound.
12564
12565 .vitem &$tls_out_sni$&
12566 .vindex "&$tls_out_sni$&"
12567 .cindex "TLS" "Server Name Indication"
12568 During outbound
12569 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12570 the transport.
12571
12572 .vitem &$tod_bsdinbox$&
12573 .vindex "&$tod_bsdinbox$&"
12574 The time of day and the date, in the format required for BSD-style mailbox
12575 files, for example: Thu Oct 17 17:14:09 1995.
12576
12577 .vitem &$tod_epoch$&
12578 .vindex "&$tod_epoch$&"
12579 The time and date as a number of seconds since the start of the Unix epoch.
12580
12581 .vitem &$tod_epoch_l$&
12582 .vindex "&$tod_epoch_l$&"
12583 The time and date as a number of microseconds since the start of the Unix epoch.
12584
12585 .vitem &$tod_full$&
12586 .vindex "&$tod_full$&"
12587 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12588 +0100. The timezone is always given as a numerical offset from UTC, with
12589 positive values used for timezones that are ahead (east) of UTC, and negative
12590 values for those that are behind (west).
12591
12592 .vitem &$tod_log$&
12593 .vindex "&$tod_log$&"
12594 The time and date in the format used for writing Exim's log files, for example:
12595 1995-10-12 15:32:29, but without a timezone.
12596
12597 .vitem &$tod_logfile$&
12598 .vindex "&$tod_logfile$&"
12599 This variable contains the date in the format yyyymmdd. This is the format that
12600 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12601 flag.
12602
12603 .vitem &$tod_zone$&
12604 .vindex "&$tod_zone$&"
12605 This variable contains the numerical value of the local timezone, for example:
12606 -0500.
12607
12608 .vitem &$tod_zulu$&
12609 .vindex "&$tod_zulu$&"
12610 This variable contains the UTC date and time in &"Zulu"& format, as specified
12611 by ISO 8601, for example: 20030221154023Z.
12612
12613 .vitem &$transport_name$&
12614 .cindex "transport" "name"
12615 .cindex "name" "of transport"
12616 .vindex "&$transport_name$&"
12617 During the running of a transport, this variable contains its name.
12618
12619 .vitem &$value$&
12620 .vindex "&$value$&"
12621 This variable contains the result of an expansion lookup, extraction operation,
12622 or external command, as described above. It is also used during a
12623 &*reduce*& expansion.
12624
12625 .vitem &$verify_mode$&
12626 .vindex "&$verify_mode$&"
12627 While a router or transport is being run in verify mode
12628 or for cutthrough delivery,
12629 contains "S" for sender-verification or "R" for recipient-verification.
12630 Otherwise, empty.
12631
12632 .vitem &$version_number$&
12633 .vindex "&$version_number$&"
12634 The version number of Exim.
12635
12636 .vitem &$warn_message_delay$&
12637 .vindex "&$warn_message_delay$&"
12638 This variable is set only during the creation of a message warning about a
12639 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12640
12641 .vitem &$warn_message_recipients$&
12642 .vindex "&$warn_message_recipients$&"
12643 This variable is set only during the creation of a message warning about a
12644 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12645 .endlist
12646 .ecindex IIDstrexp
12647
12648
12649
12650 . ////////////////////////////////////////////////////////////////////////////
12651 . ////////////////////////////////////////////////////////////////////////////
12652
12653 .chapter "Embedded Perl" "CHAPperl"
12654 .scindex IIDperl "Perl" "calling from Exim"
12655 Exim can be built to include an embedded Perl interpreter. When this is done,
12656 Perl subroutines can be called as part of the string expansion process. To make
12657 use of the Perl support, you need version 5.004 or later of Perl installed on
12658 your system. To include the embedded interpreter in the Exim binary, include
12659 the line
12660 .code
12661 EXIM_PERL = perl.o
12662 .endd
12663 in your &_Local/Makefile_& and then build Exim in the normal way.
12664
12665
12666 .section "Setting up so Perl can be used" "SECID85"
12667 .oindex "&%perl_startup%&"
12668 Access to Perl subroutines is via a global configuration option called
12669 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12670 no &%perl_startup%& option in the Exim configuration file then no Perl
12671 interpreter is started and there is almost no overhead for Exim (since none of
12672 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12673 option then the associated value is taken to be Perl code which is executed in
12674 a newly created Perl interpreter.
12675
12676 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12677 need backslashes before any characters to escape special meanings. The option
12678 should usually be something like
12679 .code
12680 perl_startup = do '/etc/exim.pl'
12681 .endd
12682 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12683 use from Exim. Exim can be configured either to start up a Perl interpreter as
12684 soon as it is entered, or to wait until the first time it is needed. Starting
12685 the interpreter at the beginning ensures that it is done while Exim still has
12686 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12687 fact used in a particular run. Also, note that this does not mean that Exim is
12688 necessarily running as root when Perl is called at a later time. By default,
12689 the interpreter is started only when it is needed, but this can be changed in
12690 two ways:
12691
12692 .ilist
12693 .oindex "&%perl_at_start%&"
12694 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12695 a startup when Exim is entered.
12696 .next
12697 The command line option &%-ps%& also requests a startup when Exim is entered,
12698 overriding the setting of &%perl_at_start%&.
12699 .endlist
12700
12701 There is also a command line option &%-pd%& (for delay) which suppresses the
12702 initial startup, even if &%perl_at_start%& is set.
12703
12704
12705 .section "Calling Perl subroutines" "SECID86"
12706 When the configuration file includes a &%perl_startup%& option you can make use
12707 of the string expansion item to call the Perl subroutines that are defined
12708 by the &%perl_startup%& code. The operator is used in any of the following
12709 forms:
12710 .code
12711 ${perl{foo}}
12712 ${perl{foo}{argument}}
12713 ${perl{foo}{argument1}{argument2} ... }
12714 .endd
12715 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12716 arguments may be passed. Passing more than this results in an expansion failure
12717 with an error message of the form
12718 .code
12719 Too many arguments passed to Perl subroutine "foo" (max is 8)
12720 .endd
12721 The return value of the Perl subroutine is evaluated in a scalar context before
12722 it is passed back to Exim to be inserted into the expanded string. If the
12723 return value is &'undef'&, the expansion is forced to fail in the same way as
12724 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12725 by obeying Perl's &%die%& function, the expansion fails with the error message
12726 that was passed to &%die%&.
12727
12728
12729 .section "Calling Exim functions from Perl" "SECID87"
12730 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12731 is available to call back into Exim's string expansion function. For example,
12732 the Perl code
12733 .code
12734 my $lp = Exim::expand_string('$local_part');
12735 .endd
12736 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12737 Note those are single quotes and not double quotes to protect against
12738 &$local_part$& being interpolated as a Perl variable.
12739
12740 If the string expansion is forced to fail by a &"fail"& item, the result of
12741 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12742 expansion string, the Perl call from the original expansion string fails with
12743 an appropriate error message, in the same way as if &%die%& were used.
12744
12745 .cindex "debugging" "from embedded Perl"
12746 .cindex "log" "writing from embedded Perl"
12747 Two other Exim functions are available for use from within Perl code.
12748 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12749 debugging is enabled. If you want a newline at the end, you must supply it.
12750 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12751 timestamp. In this case, you should not supply a terminating newline.
12752
12753
12754 .section "Use of standard output and error by Perl" "SECID88"
12755 .cindex "Perl" "standard output and error"
12756 You should not write to the standard error or output streams from within your
12757 Perl code, as it is not defined how these are set up. In versions of Exim
12758 before 4.50, it is possible for the standard output or error to refer to the
12759 SMTP connection during message reception via the daemon. Writing to this stream
12760 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12761 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12762 avoided, but the output is lost.
12763
12764 .cindex "Perl" "use of &%warn%&"
12765 The Perl &%warn%& statement writes to the standard error stream by default.
12766 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12767 you have no control. When Exim starts up the Perl interpreter, it arranges for
12768 output from the &%warn%& statement to be written to the Exim main log. You can
12769 change this by including appropriate Perl magic somewhere in your Perl code.
12770 For example, to discard &%warn%& output completely, you need this:
12771 .code
12772 $SIG{__WARN__} = sub { };
12773 .endd
12774 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12775 example, the code for the subroutine is empty, so it does nothing, but you can
12776 include any Perl code that you like. The text of the &%warn%& message is passed
12777 as the first subroutine argument.
12778 .ecindex IIDperl
12779
12780
12781 . ////////////////////////////////////////////////////////////////////////////
12782 . ////////////////////////////////////////////////////////////////////////////
12783
12784 .chapter "Starting the daemon and the use of network interfaces" &&&
12785          "CHAPinterfaces" &&&
12786          "Starting the daemon"
12787 .cindex "daemon" "starting"
12788 .cindex "interface" "listening"
12789 .cindex "network interface"
12790 .cindex "interface" "network"
12791 .cindex "IP address" "for listening"
12792 .cindex "daemon" "listening IP addresses"
12793 .cindex "TCP/IP" "setting listening interfaces"
12794 .cindex "TCP/IP" "setting listening ports"
12795 A host that is connected to a TCP/IP network may have one or more physical
12796 hardware network interfaces. Each of these interfaces may be configured as one
12797 or more &"logical"& interfaces, which are the entities that a program actually
12798 works with. Each of these logical interfaces is associated with an IP address.
12799 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12800 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12801 knowledge about the host's interfaces for use in three different circumstances:
12802
12803 .olist
12804 When a listening daemon is started, Exim needs to know which interfaces
12805 and ports to listen on.
12806 .next
12807 When Exim is routing an address, it needs to know which IP addresses
12808 are associated with local interfaces. This is required for the correct
12809 processing of MX lists by removing the local host and others with the
12810 same or higher priority values. Also, Exim needs to detect cases
12811 when an address is routed to an IP address that in fact belongs to the
12812 local host. Unless the &%self%& router option or the &%allow_localhost%&
12813 option of the smtp transport is set (as appropriate), this is treated
12814 as an error situation.
12815 .next
12816 When Exim connects to a remote host, it may need to know which interface to use
12817 for the outgoing connection.
12818 .endlist
12819
12820
12821 Exim's default behaviour is likely to be appropriate in the vast majority
12822 of cases. If your host has only one interface, and you want all its IP
12823 addresses to be treated in the same way, and you are using only the
12824 standard SMTP port, you should not need to take any special action. The
12825 rest of this chapter does not apply to you.
12826
12827 In a more complicated situation you may want to listen only on certain
12828 interfaces, or on different ports, and for this reason there are a number of
12829 options that can be used to influence Exim's behaviour. The rest of this
12830 chapter describes how they operate.
12831
12832 When a message is received over TCP/IP, the interface and port that were
12833 actually used are set in &$received_ip_address$& and &$received_port$&.
12834
12835
12836
12837 .section "Starting a listening daemon" "SECID89"
12838 When a listening daemon is started (by means of the &%-bd%& command line
12839 option), the interfaces and ports on which it listens are controlled by the
12840 following options:
12841
12842 .ilist
12843 &%daemon_smtp_ports%& contains a list of default ports
12844 or service names.
12845 (For backward compatibility, this option can also be specified in the singular.)
12846 .next
12847 &%local_interfaces%& contains list of interface IP addresses on which to
12848 listen. Each item may optionally also specify a port.
12849 .endlist
12850
12851 The default list separator in both cases is a colon, but this can be changed as
12852 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12853 it is usually best to change the separator to avoid having to double all the
12854 colons. For example:
12855 .code
12856 local_interfaces = <; 127.0.0.1 ; \
12857                       192.168.23.65 ; \
12858                       ::1 ; \
12859                       3ffe:ffff:836f::fe86:a061
12860 .endd
12861 There are two different formats for specifying a port along with an IP address
12862 in &%local_interfaces%&:
12863
12864 .olist
12865 The port is added onto the address with a dot separator. For example, to listen
12866 on port 1234 on two different IP addresses:
12867 .code
12868 local_interfaces = <; 192.168.23.65.1234 ; \
12869                       3ffe:ffff:836f::fe86:a061.1234
12870 .endd
12871 .next
12872 The IP address is enclosed in square brackets, and the port is added
12873 with a colon separator, for example:
12874 .code
12875 local_interfaces = <; [192.168.23.65]:1234 ; \
12876                       [3ffe:ffff:836f::fe86:a061]:1234
12877 .endd
12878 .endlist
12879
12880 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12881 default setting contains just one port:
12882 .code
12883 daemon_smtp_ports = smtp
12884 .endd
12885 If more than one port is listed, each interface that does not have its own port
12886 specified listens on all of them. Ports that are listed in
12887 &%daemon_smtp_ports%& can be identified either by name (defined in
12888 &_/etc/services_&) or by number. However, when ports are given with individual
12889 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12890
12891
12892
12893 .section "Special IP listening addresses" "SECID90"
12894 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12895 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12896 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12897 instead of setting up separate listening sockets for each interface. The
12898 default value of &%local_interfaces%& is
12899 .code
12900 local_interfaces = 0.0.0.0
12901 .endd
12902 when Exim is built without IPv6 support; otherwise it is:
12903 .code
12904 local_interfaces = <; ::0 ; 0.0.0.0
12905 .endd
12906 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12907
12908
12909
12910 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12911 The &%-oX%& command line option can be used to override the values of
12912 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12913 instance. Another way of doing this would be to use macros and the &%-D%&
12914 option. However, &%-oX%& can be used by any admin user, whereas modification of
12915 the runtime configuration by &%-D%& is allowed only when the caller is root or
12916 exim.
12917
12918 The value of &%-oX%& is a list of items. The default colon separator can be
12919 changed in the usual way if required. If there are any items that do not
12920 contain dots or colons (that is, are not IP addresses), the value of
12921 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12922 items that do contain dots or colons, the value of &%local_interfaces%& is
12923 replaced by those items. Thus, for example,
12924 .code
12925 -oX 1225
12926 .endd
12927 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12928 whereas
12929 .code
12930 -oX 192.168.34.5.1125
12931 .endd
12932 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12933 (However, since &%local_interfaces%& now contains no items without ports, the
12934 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12935
12936
12937
12938 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12939 .cindex "ssmtp protocol"
12940 .cindex "smtps protocol"
12941 .cindex "SMTP" "ssmtp protocol"
12942 .cindex "SMTP" "smtps protocol"
12943 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12944 before the STARTTLS command was standardized for SMTP. Some legacy clients
12945 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12946 list of port numbers or service names,
12947 connections to those ports must use SSMTP. The most
12948 common use of this option is expected to be
12949 .code
12950 tls_on_connect_ports = 465
12951 .endd
12952 because 465 is the usual port number used by the legacy clients. There is also
12953 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12954 this way when a daemon is started.
12955
12956 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12957 daemon to listen on those ports. You must still specify them in
12958 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12959 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12960 connections via the daemon.)
12961
12962
12963
12964
12965 .section "IPv6 address scopes" "SECID92"
12966 .cindex "IPv6" "address scopes"
12967 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12968 can, in principle, have the same link-local IPv6 address on different
12969 interfaces. Thus, additional information is needed, over and above the IP
12970 address, to distinguish individual interfaces. A convention of using a
12971 percent sign followed by something (often the interface name) has been
12972 adopted in some cases, leading to addresses like this:
12973 .code
12974 fe80::202:b3ff:fe03:45c1%eth0
12975 .endd
12976 To accommodate this usage, a percent sign followed by an arbitrary string is
12977 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12978 to convert a textual IPv6 address for actual use. This function recognizes the
12979 percent convention in operating systems that support it, and it processes the
12980 address appropriately. Unfortunately, some older libraries have problems with
12981 &[getaddrinfo()]&. If
12982 .code
12983 IPV6_USE_INET_PTON=yes
12984 .endd
12985 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12986 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12987 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12988 function.) Of course, this means that the additional functionality of
12989 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12990
12991 .section "Disabling IPv6" "SECID93"
12992 .cindex "IPv6" "disabling"
12993 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12994 run on a host whose kernel does not support IPv6. The binary will fall back to
12995 using IPv4, but it may waste resources looking up AAAA records, and trying to
12996 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12997 .oindex "&%disable_ipv6%&"
12998 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12999 activities take place. AAAA records are never looked up, and any IPv6 addresses
13000 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13001 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13002 to handle IPv6 literal addresses.
13003
13004 On the other hand, when IPv6 is in use, there may be times when you want to
13005 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13006 option to globally suppress the lookup of AAAA records for specified domains,
13007 and you can use the &%ignore_target_hosts%& generic router option to ignore
13008 IPv6 addresses in an individual router.
13009
13010
13011
13012 .section "Examples of starting a listening daemon" "SECID94"
13013 The default case in an IPv6 environment is
13014 .code
13015 daemon_smtp_ports = smtp
13016 local_interfaces = <; ::0 ; 0.0.0.0
13017 .endd
13018 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13019 Either one or two sockets may be used, depending on the characteristics of
13020 the TCP/IP stack. (This is complicated and messy; for more information,
13021 read the comments in the &_daemon.c_& source file.)
13022
13023 To specify listening on ports 25 and 26 on all interfaces:
13024 .code
13025 daemon_smtp_ports = 25 : 26
13026 .endd
13027 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13028 .code
13029 local_interfaces = <; ::0.25     ; ::0.26 \
13030                       0.0.0.0.25 ; 0.0.0.0.26
13031 .endd
13032 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13033 IPv4 loopback address only:
13034 .code
13035 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13036 .endd
13037 To specify listening on the default port on specific interfaces only:
13038 .code
13039 local_interfaces = 10.0.0.67 : 192.168.34.67
13040 .endd
13041 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13042
13043
13044
13045 .section "Recognizing the local host" "SECTreclocipadd"
13046 The &%local_interfaces%& option is also used when Exim needs to determine
13047 whether or not an IP address refers to the local host. That is, the IP
13048 addresses of all the interfaces on which a daemon is listening are always
13049 treated as local.
13050
13051 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13052 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13053 available interfaces from the operating system, and extracts the relevant
13054 (that is, IPv4 or IPv6) addresses to use for checking.
13055
13056 Some systems set up large numbers of virtual interfaces in order to provide
13057 many virtual web servers. In this situation, you may want to listen for
13058 email on only a few of the available interfaces, but nevertheless treat all
13059 interfaces as local when routing. You can do this by setting
13060 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13061 &"all"& wildcard values. These addresses are recognized as local, but are not
13062 used for listening. Consider this example:
13063 .code
13064 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13065                       192.168.53.235 ; \
13066                       3ffe:2101:12:1:a00:20ff:fe86:a061
13067
13068 extra_local_interfaces = <; ::0 ; 0.0.0.0
13069 .endd
13070 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13071 address, but all available interface addresses are treated as local when
13072 Exim is routing.
13073
13074 In some environments the local host name may be in an MX list, but with an IP
13075 address that is not assigned to any local interface. In other cases it may be
13076 desirable to treat other host names as if they referred to the local host. Both
13077 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13078 This contains host names rather than IP addresses. When a host is referenced
13079 during routing, either via an MX record or directly, it is treated as the local
13080 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13081 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13082
13083
13084
13085 .section "Delivering to a remote host" "SECID95"
13086 Delivery to a remote host is handled by the smtp transport. By default, it
13087 allows the system's TCP/IP functions to choose which interface to use (if
13088 there is more than one) when connecting to a remote host. However, the
13089 &%interface%& option can be set to specify which interface is used. See the
13090 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13091 details.
13092
13093
13094
13095
13096 . ////////////////////////////////////////////////////////////////////////////
13097 . ////////////////////////////////////////////////////////////////////////////
13098
13099 .chapter "Main configuration" "CHAPmainconfig"
13100 .scindex IIDconfima "configuration file" "main section"
13101 .scindex IIDmaiconf "main configuration"
13102 The first part of the run time configuration file contains three types of item:
13103
13104 .ilist
13105 Macro definitions: These lines start with an upper case letter. See section
13106 &<<SECTmacrodefs>>& for details of macro processing.
13107 .next
13108 Named list definitions: These lines start with one of the words &"domainlist"&,
13109 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13110 section &<<SECTnamedlists>>&.
13111 .next
13112 Main configuration settings: Each setting occupies one line of the file
13113 (with possible continuations). If any setting is preceded by the word
13114 &"hide"&, the &%-bP%& command line option displays its value to admin users
13115 only. See section &<<SECTcos>>& for a description of the syntax of these option
13116 settings.
13117 .endlist
13118
13119 This chapter specifies all the main configuration options, along with their
13120 types and default values. For ease of finding a particular option, they appear
13121 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13122 are now so many options, they are first listed briefly in functional groups, as
13123 an aid to finding the name of the option you are looking for. Some options are
13124 listed in more than one group.
13125
13126 .section "Miscellaneous" "SECID96"
13127 .table2
13128 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13129 .row &%disable_ipv6%&                "do no IPv6 processing"
13130 .row &%keep_malformed%&              "for broken files &-- should not happen"
13131 .row &%localhost_number%&            "for unique message ids in clusters"
13132 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13133 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13134 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13135 .row &%print_topbitchars%&           "top-bit characters are printing"
13136 .row &%timezone%&                    "force time zone"
13137 .endtable
13138
13139
13140 .section "Exim parameters" "SECID97"
13141 .table2
13142 .row &%exim_group%&                  "override compiled-in value"
13143 .row &%exim_path%&                   "override compiled-in value"
13144 .row &%exim_user%&                   "override compiled-in value"
13145 .row &%primary_hostname%&            "default from &[uname()]&"
13146 .row &%split_spool_directory%&       "use multiple directories"
13147 .row &%spool_directory%&             "override compiled-in value"
13148 .endtable
13149
13150
13151
13152 .section "Privilege controls" "SECID98"
13153 .table2
13154 .row &%admin_groups%&                "groups that are Exim admin users"
13155 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13156 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13157 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13158 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13159 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13160 .row &%never_users%&                 "do not run deliveries as these"
13161 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13162 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13163 .row &%trusted_groups%&              "groups that are trusted"
13164 .row &%trusted_users%&               "users that are trusted"
13165 .endtable
13166
13167
13168
13169 .section "Logging" "SECID99"
13170 .table2
13171 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13172 .row &%log_file_path%&               "override compiled-in value"
13173 .row &%log_selector%&                "set/unset optional logging"
13174 .row &%log_timezone%&                "add timezone to log lines"
13175 .row &%message_logs%&                "create per-message logs"
13176 .row &%preserve_message_logs%&       "after message completion"
13177 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13178 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13179 .row &%syslog_facility%&             "set syslog &""facility""& field"
13180 .row &%syslog_processname%&          "set syslog &""ident""& field"
13181 .row &%syslog_timestamp%&            "timestamp syslog lines"
13182 .row &%write_rejectlog%&             "control use of message log"
13183 .endtable
13184
13185
13186
13187 .section "Frozen messages" "SECID100"
13188 .table2
13189 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13190 .row &%freeze_tell%&                 "send message when freezing"
13191 .row &%move_frozen_messages%&        "to another directory"
13192 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13193 .endtable
13194
13195
13196
13197 .section "Data lookups" "SECID101"
13198 .table2
13199 .row &%ibase_servers%&               "InterBase servers"
13200 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13201 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13202 .row &%ldap_cert_file%&              "client cert file for LDAP"
13203 .row &%ldap_cert_key%&               "client key file for LDAP"
13204 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13205 .row &%ldap_default_servers%&        "used if no server in query"
13206 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13207 .row &%ldap_start_tls%&              "require TLS within LDAP"
13208 .row &%ldap_version%&                "set protocol version"
13209 .row &%lookup_open_max%&             "lookup files held open"
13210 .row &%mysql_servers%&               "default MySQL servers"
13211 .row &%oracle_servers%&              "Oracle servers"
13212 .row &%pgsql_servers%&               "default PostgreSQL servers"
13213 .row &%sqlite_lock_timeout%&         "as it says"
13214 .endtable
13215
13216
13217
13218 .section "Message ids" "SECID102"
13219 .table2
13220 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13221 .row &%message_id_header_text%&      "ditto"
13222 .endtable
13223
13224
13225
13226 .section "Embedded Perl Startup" "SECID103"
13227 .table2
13228 .row &%perl_at_start%&               "always start the interpreter"
13229 .row &%perl_startup%&                "code to obey when starting Perl"
13230 .endtable
13231
13232
13233
13234 .section "Daemon" "SECID104"
13235 .table2
13236 .row &%daemon_smtp_ports%&           "default ports"
13237 .row &%daemon_startup_retries%&      "number of times to retry"
13238 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13239 .row &%extra_local_interfaces%&      "not necessarily listened on"
13240 .row &%local_interfaces%&            "on which to listen, with optional ports"
13241 .row &%pid_file_path%&               "override compiled-in value"
13242 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13243 .endtable
13244
13245
13246
13247 .section "Resource control" "SECID105"
13248 .table2
13249 .row &%check_log_inodes%&            "before accepting a message"
13250 .row &%check_log_space%&             "before accepting a message"
13251 .row &%check_spool_inodes%&          "before accepting a message"
13252 .row &%check_spool_space%&           "before accepting a message"
13253 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13254 .row &%queue_only_load%&             "queue incoming if load high"
13255 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13256 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13257 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13258 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13259 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13260 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13261 .row &%smtp_accept_max_per_connection%& "messages per connection"
13262 .row &%smtp_accept_max_per_host%&    "connections from one host"
13263 .row &%smtp_accept_queue%&           "queue mail if more connections"
13264 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13265                                            connection"
13266 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13267 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13268 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13269 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13270 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13271 .endtable
13272
13273
13274
13275 .section "Policy controls" "SECID106"
13276 .table2
13277 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13278 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13279 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13280 .row &%acl_smtp_auth%&               "ACL for AUTH"
13281 .row &%acl_smtp_connect%&            "ACL for connection"
13282 .row &%acl_smtp_data%&               "ACL for DATA"
13283 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13284 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13285 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13286 .row &%acl_smtp_expn%&               "ACL for EXPN"
13287 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13288 .row &%acl_smtp_mail%&               "ACL for MAIL"
13289 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13290 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13291 .row &%acl_smtp_predata%&            "ACL for start of data"
13292 .row &%acl_smtp_quit%&               "ACL for QUIT"
13293 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13294 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13295 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13296 .row &%av_scanner%&                  "specify virus scanner"
13297 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13298                                       words""&"
13299 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13300 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13301 .row &%header_maxsize%&              "total size of message header"
13302 .row &%header_line_maxsize%&         "individual header line limit"
13303 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13304 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13305 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13306 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13307 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13308 .row &%host_lookup%&                 "host name looked up for these hosts"
13309 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13310 .row &%host_reject_connection%&      "reject connection from these hosts"
13311 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13312 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13313 .row &%message_size_limit%&          "for all messages"
13314 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13315 .row &%spamd_address%&               "set interface to SpamAssassin"
13316 .row &%strict_acl_vars%&             "object to unset ACL variables"
13317 .endtable
13318
13319
13320
13321 .section "Callout cache" "SECID107"
13322 .table2
13323 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13324                                          item"
13325 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13326                                          item"
13327 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13328 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13329 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13330 .endtable
13331
13332
13333
13334 .section "TLS" "SECID108"
13335 .table2
13336 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13337 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13338 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13339 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13340 .row &%tls_certificate%&             "location of server certificate"
13341 .row &%tls_crl%&                     "certificate revocation list"
13342 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13343 .row &%tls_dhparam%&                 "DH parameters for server"
13344 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13345 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13346 .row &%tls_privatekey%&              "location of server private key"
13347 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13348 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13349 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13350 .row &%tls_verify_certificates%&     "expected client certificates"
13351 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13352 .endtable
13353
13354
13355
13356 .section "Local user handling" "SECID109"
13357 .table2
13358 .row &%finduser_retries%&            "useful in NIS environments"
13359 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13360 .row &%gecos_pattern%&               "ditto"
13361 .row &%max_username_length%&         "for systems that truncate"
13362 .row &%unknown_login%&               "used when no login name found"
13363 .row &%unknown_username%&            "ditto"
13364 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13365 .row &%uucp_from_sender%&            "ditto"
13366 .endtable
13367
13368
13369
13370 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13371 .table2
13372 .row &%header_maxsize%&              "total size of message header"
13373 .row &%header_line_maxsize%&         "individual header line limit"
13374 .row &%message_size_limit%&          "applies to all messages"
13375 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13376 .row &%received_header_text%&        "expanded to make &'Received:'&"
13377 .row &%received_headers_max%&        "for mail loop detection"
13378 .row &%recipients_max%&              "limit per message"
13379 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13380 .endtable
13381
13382
13383
13384
13385 .section "Non-SMTP incoming messages" "SECID111"
13386 .table2
13387 .row &%receive_timeout%&             "for non-SMTP messages"
13388 .endtable
13389
13390
13391
13392
13393
13394 .section "Incoming SMTP messages" "SECID112"
13395 See also the &'Policy controls'& section above.
13396
13397 .table2
13398 .row &%host_lookup%&                 "host name looked up for these hosts"
13399 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13400 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13401 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13402 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13403 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13404 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13405 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13406 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13407 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13408 .row &%smtp_accept_max_per_connection%& "messages per connection"
13409 .row &%smtp_accept_max_per_host%&    "connections from one host"
13410 .row &%smtp_accept_queue%&           "queue mail if more connections"
13411 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13412                                            connection"
13413 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13414 .row &%smtp_active_hostname%&        "host name to use in messages"
13415 .row &%smtp_banner%&                 "text for welcome banner"
13416 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13417 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13418 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13419 .row &%smtp_etrn_command%&           "what to run for ETRN"
13420 .row &%smtp_etrn_serialize%&         "only one at once"
13421 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13422 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13423 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13424 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13425 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13426 .row &%smtp_receive_timeout%&        "per command or data line"
13427 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13428 .row &%smtp_return_error_details%&   "give detail on rejections"
13429 .endtable
13430
13431
13432
13433 .section "SMTP extensions" "SECID113"
13434 .table2
13435 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13436 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13437 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13438 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13439 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13440 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13441 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13442 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13443 .endtable
13444
13445
13446
13447 .section "Processing messages" "SECID114"
13448 .table2
13449 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13450 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13451 .row &%allow_utf8_domains%&          "in addresses"
13452 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13453                                       words""&"
13454 .row &%delivery_date_remove%&        "from incoming messages"
13455 .row &%envelope_to_remove%&          "from incoming messages"
13456 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13457 .row &%headers_charset%&             "default for translations"
13458 .row &%qualify_domain%&              "default for senders"
13459 .row &%qualify_recipient%&           "default for recipients"
13460 .row &%return_path_remove%&          "from incoming messages"
13461 .row &%strip_excess_angle_brackets%& "in addresses"
13462 .row &%strip_trailing_dot%&          "at end of addresses"
13463 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13464 .endtable
13465
13466
13467
13468 .section "System filter" "SECID115"
13469 .table2
13470 .row &%system_filter%&               "locate system filter"
13471 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13472                                             directory"
13473 .row &%system_filter_file_transport%& "transport for delivery to a file"
13474 .row &%system_filter_group%&         "group for filter running"
13475 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13476 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13477 .row &%system_filter_user%&          "user for filter running"
13478 .endtable
13479
13480
13481
13482 .section "Routing and delivery" "SECID116"
13483 .table2
13484 .row &%disable_ipv6%&                "do no IPv6 processing"
13485 .row &%dns_again_means_nonexist%&    "for broken domains"
13486 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13487 .row &%dns_dnssec_ok%&               "parameter for resolver"
13488 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13489 .row &%dns_retrans%&                 "parameter for resolver"
13490 .row &%dns_retry%&                   "parameter for resolver"
13491 .row &%dns_use_edns0%&               "parameter for resolver"
13492 .row &%hold_domains%&                "hold delivery for these domains"
13493 .row &%local_interfaces%&            "for routing checks"
13494 .row &%queue_domains%&               "no immediate delivery for these"
13495 .row &%queue_only%&                  "no immediate delivery at all"
13496 .row &%queue_only_file%&             "no immediate delivery if file exists"
13497 .row &%queue_only_load%&             "no immediate delivery if load is high"
13498 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13499 .row &%queue_only_override%&         "allow command line to override"
13500 .row &%queue_run_in_order%&          "order of arrival"
13501 .row &%queue_run_max%&               "of simultaneous queue runners"
13502 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13503 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13504 .row &%remote_sort_domains%&         "order of remote deliveries"
13505 .row &%retry_data_expire%&           "timeout for retry data"
13506 .row &%retry_interval_max%&          "safety net for retry rules"
13507 .endtable
13508
13509
13510
13511 .section "Bounce and warning messages" "SECID117"
13512 .table2
13513 .row &%bounce_message_file%&         "content of bounce"
13514 .row &%bounce_message_text%&         "content of bounce"
13515 .row &%bounce_return_body%&          "include body if returning message"
13516 .row &%bounce_return_message%&       "include original message in bounce"
13517 .row &%bounce_return_size_limit%&    "limit on returned message"
13518 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13519 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13520 .row &%errors_copy%&                 "copy bounce messages"
13521 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13522 .row &%delay_warning%&               "time schedule"
13523 .row &%delay_warning_condition%&     "condition for warning messages"
13524 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13525 .row &%smtp_return_error_details%&   "give detail on rejections"
13526 .row &%warn_message_file%&           "content of warning message"
13527 .endtable
13528
13529
13530
13531 .section "Alphabetical list of main options" "SECTalomo"
13532 Those options that undergo string expansion before use are marked with
13533 &dagger;.
13534
13535 .option accept_8bitmime main boolean true
13536 .cindex "8BITMIME"
13537 .cindex "8-bit characters"
13538 .cindex "log" "selectors"
13539 .cindex "log" "8BITMIME"
13540 This option causes Exim to send 8BITMIME in its response to an SMTP
13541 EHLO command, and to accept the BODY= parameter on MAIL commands.
13542 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13543 takes no steps to do anything special with messages received by this route.
13544
13545 Historically Exim kept this option off by default, but the maintainers
13546 feel that in today's Internet, this causes more problems than it solves.
13547 It now defaults to true.
13548 A more detailed analysis of the issues is provided by Dan Bernstein:
13549 .display
13550 &url(http://cr.yp.to/smtp/8bitmime.html)
13551 .endd
13552
13553 To log received 8BITMIME status use
13554 .code
13555 log_selector = +8bitmime
13556 .endd
13557
13558 .option acl_not_smtp main string&!! unset
13559 .cindex "&ACL;" "for non-SMTP messages"
13560 .cindex "non-SMTP messages" "ACLs for"
13561 This option defines the ACL that is run when a non-SMTP message has been
13562 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13563 further details.
13564
13565 .option acl_not_smtp_mime main string&!! unset
13566 This option defines the ACL that is run for individual MIME parts of non-SMTP
13567 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13568 SMTP messages.
13569
13570 .option acl_not_smtp_start main string&!! unset
13571 .cindex "&ACL;" "at start of non-SMTP message"
13572 .cindex "non-SMTP messages" "ACLs for"
13573 This option defines the ACL that is run before Exim starts reading a
13574 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13575
13576 .option acl_smtp_auth main string&!! unset
13577 .cindex "&ACL;" "setting up for SMTP commands"
13578 .cindex "AUTH" "ACL for"
13579 This option defines the ACL that is run when an SMTP AUTH command is
13580 received. See chapter &<<CHAPACL>>& for further details.
13581
13582 .option acl_smtp_connect main string&!! unset
13583 .cindex "&ACL;" "on SMTP connection"
13584 This option defines the ACL that is run when an SMTP connection is received.
13585 See chapter &<<CHAPACL>>& for further details.
13586
13587 .option acl_smtp_data main string&!! unset
13588 .cindex "DATA" "ACL for"
13589 This option defines the ACL that is run after an SMTP DATA command has been
13590 processed and the message itself has been received, but before the final
13591 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13592
13593 .new
13594 .option acl_smtp_data_prdr main string&!! accept
13595 .cindex "PRDR" "ACL for"
13596 .cindex "DATA" "PRDR ACL for"
13597 .cindex "&ACL;" "PRDR-related"
13598 .cindex "&ACL;" "per-user data processing"
13599 .wen
13600 This option defines the ACL that,
13601 if the PRDR feature has been negotiated,
13602 is run for each recipient after an SMTP DATA command has been
13603 processed and the message itself has been received, but before the
13604 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13605
13606 .option acl_smtp_etrn main string&!! unset
13607 .cindex "ETRN" "ACL for"
13608 This option defines the ACL that is run when an SMTP ETRN command is
13609 received. See chapter &<<CHAPACL>>& for further details.
13610
13611 .option acl_smtp_expn main string&!! unset
13612 .cindex "EXPN" "ACL for"
13613 This option defines the ACL that is run when an SMTP EXPN command is
13614 received. See chapter &<<CHAPACL>>& for further details.
13615
13616 .option acl_smtp_helo main string&!! unset
13617 .cindex "EHLO" "ACL for"
13618 .cindex "HELO" "ACL for"
13619 This option defines the ACL that is run when an SMTP EHLO or HELO
13620 command is received. See chapter &<<CHAPACL>>& for further details.
13621
13622
13623 .option acl_smtp_mail main string&!! unset
13624 .cindex "MAIL" "ACL for"
13625 This option defines the ACL that is run when an SMTP MAIL command is
13626 received. See chapter &<<CHAPACL>>& for further details.
13627
13628 .option acl_smtp_mailauth main string&!! unset
13629 .cindex "AUTH" "on MAIL command"
13630 This option defines the ACL that is run when there is an AUTH parameter on
13631 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13632 &<<CHAPSMTPAUTH>>& for details of authentication.
13633
13634 .option acl_smtp_mime main string&!! unset
13635 .cindex "MIME content scanning" "ACL for"
13636 This option is available when Exim is built with the content-scanning
13637 extension. It defines the ACL that is run for each MIME part in a message. See
13638 section &<<SECTscanmimepart>>& for details.
13639
13640 .option acl_smtp_predata main string&!! unset
13641 This option defines the ACL that is run when an SMTP DATA command is
13642 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13643 further details.
13644
13645 .option acl_smtp_quit main string&!! unset
13646 .cindex "QUIT, ACL for"
13647 This option defines the ACL that is run when an SMTP QUIT command is
13648 received. See chapter &<<CHAPACL>>& for further details.
13649
13650 .option acl_smtp_rcpt main string&!! unset
13651 .cindex "RCPT" "ACL for"
13652 This option defines the ACL that is run when an SMTP RCPT command is
13653 received. See chapter &<<CHAPACL>>& for further details.
13654
13655 .option acl_smtp_starttls main string&!! unset
13656 .cindex "STARTTLS, ACL for"
13657 This option defines the ACL that is run when an SMTP STARTTLS command is
13658 received. See chapter &<<CHAPACL>>& for further details.
13659
13660 .option acl_smtp_vrfy main string&!! unset
13661 .cindex "VRFY" "ACL for"
13662 This option defines the ACL that is run when an SMTP VRFY command is
13663 received. See chapter &<<CHAPACL>>& for further details.
13664
13665 .option admin_groups main "string list&!!" unset
13666 .cindex "admin user"
13667 This option is expanded just once, at the start of Exim's processing. If the
13668 current group or any of the supplementary groups of an Exim caller is in this
13669 colon-separated list, the caller has admin privileges. If all your system
13670 programmers are in a specific group, for example, you can give them all Exim
13671 admin privileges by putting that group in &%admin_groups%&. However, this does
13672 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13673 To permit this, you have to add individuals to the Exim group.
13674
13675 .option allow_domain_literals main boolean false
13676 .cindex "domain literal"
13677 If this option is set, the RFC 2822 domain literal format is permitted in
13678 email addresses. The option is not set by default, because the domain literal
13679 format is not normally required these days, and few people know about it. It
13680 has, however, been exploited by mail abusers.
13681
13682 Unfortunately, it seems that some DNS black list maintainers are using this
13683 format to report black listing to postmasters. If you want to accept messages
13684 addressed to your hosts by IP address, you need to set
13685 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13686 domains (defined in the named domain list &%local_domains%& in the default
13687 configuration). This &"magic string"& matches the domain literal form of all
13688 the local host's IP addresses.
13689
13690
13691 .option allow_mx_to_ip main boolean false
13692 .cindex "MX record" "pointing to IP address"
13693 It appears that more and more DNS zone administrators are breaking the rules
13694 and putting domain names that look like IP addresses on the right hand side of
13695 MX records. Exim follows the rules and rejects this, giving an error message
13696 that explains the mis-configuration. However, some other MTAs support this
13697 practice, so to avoid &"Why can't Exim do this?"& complaints,
13698 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13699 recommended, except when you have no other choice.
13700
13701 .option allow_utf8_domains main boolean false
13702 .cindex "domain" "UTF-8 characters in"
13703 .cindex "UTF-8" "in domain name"
13704 Lots of discussion is going on about internationalized domain names. One
13705 camp is strongly in favour of just using UTF-8 characters, and it seems
13706 that at least two other MTAs permit this. This option allows Exim users to
13707 experiment if they wish.
13708
13709 If it is set true, Exim's domain parsing function allows valid
13710 UTF-8 multicharacters to appear in domain name components, in addition to
13711 letters, digits, and hyphens. However, just setting this option is not
13712 enough; if you want to look up these domain names in the DNS, you must also
13713 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13714 suitable setting is:
13715 .code
13716 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13717   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13718 .endd
13719 Alternatively, you can just disable this feature by setting
13720 .code
13721 dns_check_names_pattern =
13722 .endd
13723 That is, set the option to an empty string so that no check is done.
13724
13725
13726 .option auth_advertise_hosts main "host list&!!" *
13727 .cindex "authentication" "advertising"
13728 .cindex "AUTH" "advertising"
13729 If any server authentication mechanisms are configured, Exim advertises them in
13730 response to an EHLO command only if the calling host matches this list.
13731 Otherwise, Exim does not advertise AUTH.
13732 Exim does not accept AUTH commands from clients to which it has not
13733 advertised the availability of AUTH. The advertising of individual
13734 authentication mechanisms can be controlled by the use of the
13735 &%server_advertise_condition%& generic authenticator option on the individual
13736 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13737
13738 Certain mail clients (for example, Netscape) require the user to provide a name
13739 and password for authentication if AUTH is advertised, even though it may
13740 not be needed (the host may accept messages from hosts on its local LAN without
13741 authentication, for example). The &%auth_advertise_hosts%& option can be used
13742 to make these clients more friendly by excluding them from the set of hosts to
13743 which Exim advertises AUTH.
13744
13745 .cindex "AUTH" "advertising when encrypted"
13746 If you want to advertise the availability of AUTH only when the connection
13747 is encrypted using TLS, you can make use of the fact that the value of this
13748 option is expanded, with a setting like this:
13749 .code
13750 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13751 .endd
13752 .vindex "&$tls_in_cipher$&"
13753 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13754 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13755 expansion is *, which matches all hosts.
13756
13757
13758 .option auto_thaw main time 0s
13759 .cindex "thawing messages"
13760 .cindex "unfreezing messages"
13761 If this option is set to a time greater than zero, a queue runner will try a
13762 new delivery attempt on any frozen message, other than a bounce message, if
13763 this much time has passed since it was frozen. This may result in the message
13764 being re-frozen if nothing has changed since the last attempt. It is a way of
13765 saying &"keep on trying, even though there are big problems"&.
13766
13767 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13768 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13769 thought to be very useful any more, and its use should probably be avoided.
13770
13771
13772 .option av_scanner main string "see below"
13773 This option is available if Exim is built with the content-scanning extension.
13774 It specifies which anti-virus scanner to use. The default value is:
13775 .code
13776 sophie:/var/run/sophie
13777 .endd
13778 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13779 before use. See section &<<SECTscanvirus>>& for further details.
13780
13781
13782 .option bi_command main string unset
13783 .oindex "&%-bi%&"
13784 This option supplies the name of a command that is run when Exim is called with
13785 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13786 just the command name, it is not a complete command line. If an argument is
13787 required, it must come from the &%-oA%& command line option.
13788
13789
13790 .option bounce_message_file main string unset
13791 .cindex "bounce message" "customizing"
13792 .cindex "customizing" "bounce message"
13793 This option defines a template file containing paragraphs of text to be used
13794 for constructing bounce messages.  Details of the file's contents are given in
13795 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13796
13797
13798 .option bounce_message_text main string unset
13799 When this option is set, its contents are included in the default bounce
13800 message immediately after &"This message was created automatically by mail
13801 delivery software."& It is not used if &%bounce_message_file%& is set.
13802
13803 .option bounce_return_body main boolean true
13804 .cindex "bounce message" "including body"
13805 This option controls whether the body of an incoming message is included in a
13806 bounce message when &%bounce_return_message%& is true. The default setting
13807 causes the entire message, both header and body, to be returned (subject to the
13808 value of &%bounce_return_size_limit%&). If this option is false, only the
13809 message header is included. In the case of a non-SMTP message containing an
13810 error that is detected during reception, only those header lines preceding the
13811 point at which the error was detected are returned.
13812 .cindex "bounce message" "including original"
13813
13814 .option bounce_return_message main boolean true
13815 If this option is set false, none of the original message is included in
13816 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13817 &%bounce_return_body%&.
13818
13819
13820 .option bounce_return_size_limit main integer 100K
13821 .cindex "size" "of bounce, limit"
13822 .cindex "bounce message" "size limit"
13823 .cindex "limit" "bounce message size"
13824 This option sets a limit in bytes on the size of messages that are returned to
13825 senders as part of bounce messages when &%bounce_return_message%& is true. The
13826 limit should be less than the value of the global &%message_size_limit%& and of
13827 any &%message_size_limit%& settings on transports, to allow for the bounce text
13828 that Exim generates. If this option is set to zero there is no limit.
13829
13830 When the body of any message that is to be included in a bounce message is
13831 greater than the limit, it is truncated, and a comment pointing this out is
13832 added at the top. The actual cutoff may be greater than the value given, owing
13833 to the use of buffering for transferring the message in chunks (typically 8K in
13834 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13835 messages.
13836
13837 .option bounce_sender_authentication main string unset
13838 .cindex "bounce message" "sender authentication"
13839 .cindex "authentication" "bounce message"
13840 .cindex "AUTH" "on bounce message"
13841 This option provides an authenticated sender address that is sent with any
13842 bounce messages generated by Exim that are sent over an authenticated SMTP
13843 connection. A typical setting might be:
13844 .code
13845 bounce_sender_authentication = mailer-daemon@my.domain.example
13846 .endd
13847 which would cause bounce messages to be sent using the SMTP command:
13848 .code
13849 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13850 .endd
13851 The value of &%bounce_sender_authentication%& must always be a complete email
13852 address.
13853
13854 .option callout_domain_negative_expire main time 3h
13855 .cindex "caching" "callout timeouts"
13856 .cindex "callout" "caching timeouts"
13857 This option specifies the expiry time for negative callout cache data for a
13858 domain. See section &<<SECTcallver>>& for details of callout verification, and
13859 section &<<SECTcallvercache>>& for details of the caching.
13860
13861
13862 .option callout_domain_positive_expire main time 7d
13863 This option specifies the expiry time for positive callout cache data for a
13864 domain. See section &<<SECTcallver>>& for details of callout verification, and
13865 section &<<SECTcallvercache>>& for details of the caching.
13866
13867
13868 .option callout_negative_expire main time 2h
13869 This option specifies the expiry time for negative callout cache data for an
13870 address. See section &<<SECTcallver>>& for details of callout verification, and
13871 section &<<SECTcallvercache>>& for details of the caching.
13872
13873
13874 .option callout_positive_expire main time 24h
13875 This option specifies the expiry time for positive callout cache data for an
13876 address. See section &<<SECTcallver>>& for details of callout verification, and
13877 section &<<SECTcallvercache>>& for details of the caching.
13878
13879
13880 .option callout_random_local_part main string&!! "see below"
13881 This option defines the &"random"& local part that can be used as part of
13882 callout verification. The default value is
13883 .code
13884 $primary_hostname-$tod_epoch-testing
13885 .endd
13886 See section &<<CALLaddparcall>>& for details of how this value is used.
13887
13888
13889 .option check_log_inodes main integer 0
13890 See &%check_spool_space%& below.
13891
13892
13893 .option check_log_space main integer 0
13894 See &%check_spool_space%& below.
13895
13896 .oindex "&%check_rfc2047_length%&"
13897 .cindex "RFC 2047" "disabling length check"
13898 .option check_rfc2047_length main boolean true
13899 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13900 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13901 word; strings to be encoded that exceed this length are supposed to use
13902 multiple encoded words. By default, Exim does not recognize encoded words that
13903 exceed the maximum length. However, it seems that some software, in violation
13904 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13905 set false, Exim recognizes encoded words of any length.
13906
13907
13908 .option check_spool_inodes main integer 0
13909 See &%check_spool_space%& below.
13910
13911
13912 .option check_spool_space main integer 0
13913 .cindex "checking disk space"
13914 .cindex "disk space, checking"
13915 .cindex "spool directory" "checking space"
13916 The four &%check_...%& options allow for checking of disk resources before a
13917 message is accepted.
13918
13919 .vindex "&$log_inodes$&"
13920 .vindex "&$log_space$&"
13921 .vindex "&$spool_inodes$&"
13922 .vindex "&$spool_space$&"
13923 When any of these options are set, they apply to all incoming messages. If you
13924 want to apply different checks to different kinds of message, you can do so by
13925 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13926 &$spool_space$& in an ACL with appropriate additional conditions.
13927
13928
13929 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13930 either value is greater than zero, for example:
13931 .code
13932 check_spool_space = 10M
13933 check_spool_inodes = 100
13934 .endd
13935 The spool partition is the one that contains the directory defined by
13936 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13937 transit.
13938
13939 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13940 files are written if either is greater than zero. These should be set only if
13941 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13942
13943 If there is less space or fewer inodes than requested, Exim refuses to accept
13944 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13945 error response to the MAIL command. If ESMTP is in use and there was a
13946 SIZE parameter on the MAIL command, its value is added to the
13947 &%check_spool_space%& value, and the check is performed even if
13948 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13949
13950 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13951 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13952
13953 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13954 failure a message is written to stderr and Exim exits with a non-zero code, as
13955 it obviously cannot send an error message of any kind.
13956
13957 .option daemon_smtp_ports main string &`smtp`&
13958 .cindex "port" "for daemon"
13959 .cindex "TCP/IP" "setting listening ports"
13960 This option specifies one or more default SMTP ports on which the Exim daemon
13961 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13962 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13963
13964 .option daemon_startup_retries main integer 9
13965 .cindex "daemon startup, retrying"
13966 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13967 the daemon at startup when it cannot immediately bind a listening socket
13968 (typically because the socket is already in use): &%daemon_startup_retries%&
13969 defines the number of retries after the first failure, and
13970 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13971
13972 .option daemon_startup_sleep main time 30s
13973 See &%daemon_startup_retries%&.
13974
13975 .option delay_warning main "time list" 24h
13976 .cindex "warning of delay"
13977 .cindex "delay warning, specifying"
13978 When a message is delayed, Exim sends a warning message to the sender at
13979 intervals specified by this option. The data is a colon-separated list of times
13980 after which to send warning messages. If the value of the option is an empty
13981 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13982 message has been on the queue for longer than the last time, the last interval
13983 between the times is used to compute subsequent warning times. For example,
13984 with
13985 .code
13986 delay_warning = 4h:8h:24h
13987 .endd
13988 the first message is sent after 4 hours, the second after 8 hours, and
13989 the third one after 24 hours. After that, messages are sent every 16 hours,
13990 because that is the interval between the last two times on the list. If you set
13991 just one time, it specifies the repeat interval. For example, with:
13992 .code
13993 delay_warning = 6h
13994 .endd
13995 messages are repeated every six hours. To stop warnings after a given time, set
13996 a very large time at the end of the list. For example:
13997 .code
13998 delay_warning = 2h:12h:99d
13999 .endd
14000 Note that the option is only evaluated at the time a delivery attempt fails,
14001 which depends on retry and queue-runner configuration.
14002 Typically retries will be configured more frequently than warning messages.
14003
14004 .option delay_warning_condition main string&!! "see below"
14005 .vindex "&$domain$&"
14006 The string is expanded at the time a warning message might be sent. If all the
14007 deferred addresses have the same domain, it is set in &$domain$& during the
14008 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14009 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14010 &"false"& (the comparison being done caselessly) then the warning message is
14011 not sent. The default is:
14012 .code
14013 delay_warning_condition = ${if or {\
14014   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14015   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14016   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14017   } {no}{yes}}
14018 .endd
14019 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14020 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14021 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14022 &"auto-replied"& in an &'Auto-Submitted:'& header.
14023
14024 .option deliver_drop_privilege main boolean false
14025 .cindex "unprivileged delivery"
14026 .cindex "delivery" "unprivileged"
14027 If this option is set true, Exim drops its root privilege at the start of a
14028 delivery process, and runs as the Exim user throughout. This severely restricts
14029 the kinds of local delivery that are possible, but is viable in certain types
14030 of configuration. There is a discussion about the use of root privilege in
14031 chapter &<<CHAPsecurity>>&.
14032
14033 .option deliver_queue_load_max main fixed-point unset
14034 .cindex "load average"
14035 .cindex "queue runner" "abandoning"
14036 When this option is set, a queue run is abandoned if the system load average
14037 becomes greater than the value of the option. The option has no effect on
14038 ancient operating systems on which Exim cannot determine the load average.
14039 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14040
14041
14042 .option delivery_date_remove main boolean true
14043 .cindex "&'Delivery-date:'& header line"
14044 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14045 message when it is delivered, in exactly the same way as &'Return-path:'& is
14046 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14047 should not be present in incoming messages, and this option causes them to be
14048 removed at the time the message is received, to avoid any problems that might
14049 occur when a delivered message is subsequently sent on to some other recipient.
14050
14051 .option disable_fsync main boolean false
14052 .cindex "&[fsync()]&, disabling"
14053 This option is available only if Exim was built with the compile-time option
14054 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14055 a runtime configuration generates an &"unknown option"& error. You should not
14056 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14057 really, really, really understand what you are doing. &'No pre-compiled
14058 distributions of Exim should ever make this option available.'&
14059
14060 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14061 updated files' data to be written to disc before continuing. Unexpected events
14062 such as crashes and power outages may cause data to be lost or scrambled.
14063 Here be Dragons. &*Beware.*&
14064
14065
14066 .option disable_ipv6 main boolean false
14067 .cindex "IPv6" "disabling"
14068 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14069 activities take place. AAAA records are never looked up, and any IPv6 addresses
14070 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14071 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14072 to handle IPv6 literal addresses.
14073
14074
14075 .option dns_again_means_nonexist main "domain list&!!" unset
14076 .cindex "DNS" "&""try again""& response; overriding"
14077 DNS lookups give a &"try again"& response for the DNS errors
14078 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14079 keep trying to deliver a message, or to give repeated temporary errors to
14080 incoming mail. Sometimes the effect is caused by a badly set up name server and
14081 may persist for a long time. If a domain which exhibits this problem matches
14082 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14083 This option should be used with care. You can make it apply to reverse lookups
14084 by a setting such as this:
14085 .code
14086 dns_again_means_nonexist = *.in-addr.arpa
14087 .endd
14088 This option applies to all DNS lookups that Exim does. It also applies when the
14089 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14090 since these are most likely to be caused by DNS lookup problems. The
14091 &(dnslookup)& router has some options of its own for controlling what happens
14092 when lookups for MX or SRV records give temporary errors. These more specific
14093 options are applied after this global option.
14094
14095 .option dns_check_names_pattern main string "see below"
14096 .cindex "DNS" "pre-check of name syntax"
14097 When this option is set to a non-empty string, it causes Exim to check domain
14098 names for characters that are not allowed in host names before handing them to
14099 the DNS resolver, because some resolvers give temporary errors for names that
14100 contain unusual characters. If a domain name contains any unwanted characters,
14101 a &"not found"& result is forced, and the resolver is not called. The check is
14102 done by matching the domain name against a regular expression, which is the
14103 value of this option. The default pattern is
14104 .code
14105 dns_check_names_pattern = \
14106   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14107 .endd
14108 which permits only letters, digits, slashes, and hyphens in components, but
14109 they must start and end with a letter or digit. Slashes are not, in fact,
14110 permitted in host names, but they are found in certain NS records (which can be
14111 accessed in Exim by using a &%dnsdb%& lookup). If you set
14112 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14113 empty string.
14114
14115 .option dns_csa_search_limit main integer 5
14116 This option controls the depth of parental searching for CSA SRV records in the
14117 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14118
14119 .option dns_csa_use_reverse main boolean true
14120 This option controls whether or not an IP address, given as a CSA domain, is
14121 reversed and looked up in the reverse DNS, as described in more detail in
14122 section &<<SECTverifyCSA>>&.
14123
14124
14125 .option dns_dnssec_ok main integer -1
14126 .cindex "DNS" "resolver options"
14127 .cindex "DNS" "DNSSEC"
14128 If this option is set to a non-negative number then Exim will initialise the
14129 DNS resolver library to either use or not use DNSSEC, overriding the system
14130 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14131
14132 If the resolver library does not support DNSSEC then this option has no effect.
14133
14134
14135 .option dns_ipv4_lookup main "domain list&!!" unset
14136 .cindex "IPv6" "DNS lookup for AAAA records"
14137 .cindex "DNS" "IPv6 lookup for AAAA records"
14138 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14139 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14140 (A records) when trying to find IP addresses for hosts, unless the host's
14141 domain matches this list.
14142
14143 This is a fudge to help with name servers that give big delays or otherwise do
14144 not work for the AAAA record type. In due course, when the world's name
14145 servers have all been upgraded, there should be no need for this option.
14146
14147
14148 .option dns_retrans main time 0s
14149 .cindex "DNS" "resolver options"
14150 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14151 retransmission and retry parameters for DNS lookups. Values of zero (the
14152 defaults) leave the system default settings unchanged. The first value is the
14153 time between retries, and the second is the number of retries. It isn't
14154 totally clear exactly how these settings affect the total time a DNS lookup may
14155 take. I haven't found any documentation about timeouts on DNS lookups; these
14156 parameter values are available in the external resolver interface structure,
14157 but nowhere does it seem to describe how they are used or what you might want
14158 to set in them.
14159
14160
14161 .option dns_retry main integer 0
14162 See &%dns_retrans%& above.
14163
14164
14165 .option dns_use_edns0 main integer -1
14166 .cindex "DNS" "resolver options"
14167 .cindex "DNS" "EDNS0"
14168 If this option is set to a non-negative number then Exim will initialise the
14169 DNS resolver library to either use or not use EDNS0 extensions, overriding
14170 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14171 on.
14172
14173 If the resolver library does not support EDNS0 then this option has no effect.
14174
14175
14176 .option drop_cr main boolean false
14177 This is an obsolete option that is now a no-op. It used to affect the way Exim
14178 handled CR and LF characters in incoming messages. What happens now is
14179 described in section &<<SECTlineendings>>&.
14180
14181 .new
14182 .option dsn_advertise_hosts main "host list&!!" unset
14183 .cindex "bounce messages" "success"
14184 .cindex "DSN" "success"
14185 .cindex "Delivery Status Notification" "success"
14186 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14187 and accepted from, these hosts.
14188 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14189 and RET and ORCPT options on MAIL FROM commands.
14190 A NOTIFY=SUCCESS option requests success-DSN messages.
14191 A NOTIFY= option with no argument requests that no delay or failure DSNs
14192 are sent.
14193 .wen
14194
14195 .option dsn_from main "string&!!" "see below"
14196 .cindex "&'From:'& header line" "in bounces"
14197 .cindex "bounce messages" "&'From:'& line, specifying"
14198 This option can be used to vary the contents of &'From:'& header lines in
14199 bounces and other automatically generated messages (&"Delivery Status
14200 Notifications"& &-- hence the name of the option). The default setting is:
14201 .code
14202 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14203 .endd
14204 The value is expanded every time it is needed. If the expansion fails, a
14205 panic is logged, and the default value is used.
14206
14207 .option envelope_to_remove main boolean true
14208 .cindex "&'Envelope-to:'& header line"
14209 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14210 message when it is delivered, in exactly the same way as &'Return-path:'& is
14211 handled. &'Envelope-to:'& records the original recipient address from the
14212 messages's envelope that caused the delivery to happen. Such headers should not
14213 be present in incoming messages, and this option causes them to be removed at
14214 the time the message is received, to avoid any problems that might occur when a
14215 delivered message is subsequently sent on to some other recipient.
14216
14217
14218 .option errors_copy main "string list&!!" unset
14219 .cindex "bounce message" "copy to other address"
14220 .cindex "copy of bounce message"
14221 Setting this option causes Exim to send bcc copies of bounce messages that it
14222 generates to other addresses. &*Note*&: This does not apply to bounce messages
14223 coming from elsewhere. The value of the option is a colon-separated list of
14224 items. Each item consists of a pattern, terminated by white space, followed by
14225 a comma-separated list of email addresses. If a pattern contains spaces, it
14226 must be enclosed in double quotes.
14227
14228 Each pattern is processed in the same way as a single item in an address list
14229 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14230 the bounce message, the message is copied to the addresses on the list. The
14231 items are scanned in order, and once a matching one is found, no further items
14232 are examined. For example:
14233 .code
14234 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14235               rqps@mydomain   hostmaster@mydomain.example,\
14236                               postmaster@mydomain.example
14237 .endd
14238 .vindex "&$domain$&"
14239 .vindex "&$local_part$&"
14240 The address list is expanded before use. The expansion variables &$local_part$&
14241 and &$domain$& are set from the original recipient of the error message, and if
14242 there was any wildcard matching in the pattern, the expansion
14243 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14244 variables &$0$&, &$1$&, etc. are set in the normal way.
14245
14246
14247 .option errors_reply_to main string unset
14248 .cindex "bounce message" "&'Reply-to:'& in"
14249 By default, Exim's bounce and delivery warning messages contain the header line
14250 .display
14251 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14252 .endd
14253 .oindex &%quota_warn_message%&
14254 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14255 A warning message that is generated by the &%quota_warn_message%& option in an
14256 &(appendfile)& transport may contain its own &'From:'& header line that
14257 overrides the default.
14258
14259 Experience shows that people reply to bounce messages. If the
14260 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14261 and warning messages. For example:
14262 .code
14263 errors_reply_to = postmaster@my.domain.example
14264 .endd
14265 The value of the option is not expanded. It must specify a valid RFC 2822
14266 address. However, if a warning message that is generated by the
14267 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14268 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14269 not used.
14270
14271
14272 .option exim_group main string "compile-time configured"
14273 .cindex "gid (group id)" "Exim's own"
14274 .cindex "Exim group"
14275 This option changes the gid under which Exim runs when it gives up root
14276 privilege. The default value is compiled into the binary. The value of this
14277 option is used only when &%exim_user%& is also set. Unless it consists entirely
14278 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14279 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14280 security issues.
14281
14282
14283 .option exim_path main string "see below"
14284 .cindex "Exim binary, path name"
14285 This option specifies the path name of the Exim binary, which is used when Exim
14286 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14287 the directory configured at compile time by the BIN_DIRECTORY setting. It
14288 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14289 other place.
14290 &*Warning*&: Do not use a macro to define the value of this option, because
14291 you will break those Exim utilities that scan the configuration file to find
14292 where the binary is. (They then use the &%-bP%& option to extract option
14293 settings such as the value of &%spool_directory%&.)
14294
14295
14296 .option exim_user main string "compile-time configured"
14297 .cindex "uid (user id)" "Exim's own"
14298 .cindex "Exim user"
14299 This option changes the uid under which Exim runs when it gives up root
14300 privilege. The default value is compiled into the binary. Ownership of the run
14301 time configuration file and the use of the &%-C%& and &%-D%& command line
14302 options is checked against the values in the binary, not what is set here.
14303
14304 Unless it consists entirely of digits, the string is looked up using
14305 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14306 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14307 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14308
14309
14310 .option extra_local_interfaces main "string list" unset
14311 This option defines network interfaces that are to be considered local when
14312 routing, but which are not used for listening by the daemon. See section
14313 &<<SECTreclocipadd>>& for details.
14314
14315
14316 . Allow this long option name to split; give it unsplit as a fifth argument
14317 . for the automatic .oindex that is generated by .option.
14318
14319 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14320          extract_addresses_remove_arguments
14321 .oindex "&%-t%&"
14322 .cindex "command line" "addresses with &%-t%&"
14323 .cindex "Sendmail compatibility" "&%-t%& option"
14324 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14325 are present on the command line when the &%-t%& option is used to build an
14326 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14327 line addresses are removed from the recipients list. This is also how Smail
14328 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14329 command line addresses are added to those obtained from the header lines. When
14330 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14331 argument headers. If it is set false, Exim adds rather than removes argument
14332 addresses.
14333
14334
14335 .option finduser_retries main integer 0
14336 .cindex "NIS, retrying user lookups"
14337 On systems running NIS or other schemes in which user and group information is
14338 distributed from a remote system, there can be times when &[getpwnam()]& and
14339 related functions fail, even when given valid data, because things time out.
14340 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14341 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14342 many extra times to find a user or a group, waiting for one second between
14343 retries.
14344
14345 .cindex "&_/etc/passwd_&" "multiple reading of"
14346 You should not set this option greater than zero if your user information is in
14347 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14348 search the file multiple times for non-existent users, and also cause delay.
14349
14350
14351
14352 .option freeze_tell main "string list, comma separated" unset
14353 .cindex "freezing messages" "sending a message when freezing"
14354 On encountering certain errors, or when configured to do so in a system filter,
14355 ACL, or special router, Exim freezes a message. This means that no further
14356 delivery attempts take place until an administrator thaws the message, or the
14357 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14358 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14359 warning message whenever it freezes something, unless the message it is
14360 freezing is a locally-generated bounce message. (Without this exception there
14361 is the possibility of looping.) The warning message is sent to the addresses
14362 supplied as the comma-separated value of this option. If several of the
14363 message's addresses cause freezing, only a single message is sent. If the
14364 freezing was automatic, the reason(s) for freezing can be found in the message
14365 log. If you configure freezing in a filter or ACL, you must arrange for any
14366 logging that you require.
14367
14368
14369 .option gecos_name main string&!! unset
14370 .cindex "HP-UX"
14371 .cindex "&""gecos""& field, parsing"
14372 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14373 password file to hold other information in addition to users' real names. Exim
14374 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14375 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14376 of the field are used unchanged, except that, if an ampersand is encountered,
14377 it is replaced by the user's login name with the first character forced to
14378 upper case, since this is a convention that is observed on many systems.
14379
14380 When these options are set, &%gecos_pattern%& is treated as a regular
14381 expression that is to be applied to the field (again with && replaced by the
14382 login name), and if it matches, &%gecos_name%& is expanded and used as the
14383 user's name.
14384
14385 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14386 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14387 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14388 name terminates at the first comma, the following can be used:
14389 .code
14390 gecos_pattern = ([^,]*)
14391 gecos_name = $1
14392 .endd
14393
14394 .option gecos_pattern main string unset
14395 See &%gecos_name%& above.
14396
14397
14398 .option gnutls_compat_mode main boolean unset
14399 This option controls whether GnuTLS is used in compatibility mode in an Exim
14400 server. This reduces security slightly, but improves interworking with older
14401 implementations of TLS.
14402
14403
14404 option gnutls_allow_auto_pkcs11 main boolean unset
14405 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14406 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14407
14408 See
14409 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14410 for documentation.
14411
14412
14413
14414 .option headers_charset main string "see below"
14415 This option sets a default character set for translating from encoded MIME
14416 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14417 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14418 ultimate default is ISO-8859-1. For more details see the description of header
14419 insertions in section &<<SECTexpansionitems>>&.
14420
14421
14422
14423 .option header_maxsize main integer "see below"
14424 .cindex "header section" "maximum size of"
14425 .cindex "limit" "size of message header section"
14426 This option controls the overall maximum size of a message's header
14427 section. The default is the value of HEADER_MAXSIZE in
14428 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14429 sections are rejected.
14430
14431
14432 .option header_line_maxsize main integer 0
14433 .cindex "header lines" "maximum size of"
14434 .cindex "limit" "size of one header line"
14435 This option limits the length of any individual header line in a message, after
14436 all the continuations have been joined together. Messages with individual
14437 header lines that are longer than the limit are rejected. The default value of
14438 zero means &"no limit"&.
14439
14440
14441
14442
14443 .option helo_accept_junk_hosts main "host list&!!" unset
14444 .cindex "HELO" "accepting junk data"
14445 .cindex "EHLO" "accepting junk data"
14446 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14447 mail, and gives an error response for invalid data. Unfortunately, there are
14448 some SMTP clients that send syntactic junk. They can be accommodated by setting
14449 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14450 if you want to do semantic checking.
14451 See also &%helo_allow_chars%& for a way of extending the permitted character
14452 set.
14453
14454
14455 .option helo_allow_chars main string unset
14456 .cindex "HELO" "underscores in"
14457 .cindex "EHLO" "underscores in"
14458 .cindex "underscore in EHLO/HELO"
14459 This option can be set to a string of rogue characters that are permitted in
14460 all EHLO and HELO names in addition to the standard letters, digits,
14461 hyphens, and dots. If you really must allow underscores, you can set
14462 .code
14463 helo_allow_chars = _
14464 .endd
14465 Note that the value is one string, not a list.
14466
14467
14468 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14469 .cindex "HELO" "forcing reverse lookup"
14470 .cindex "EHLO" "forcing reverse lookup"
14471 If the domain given by a client in a HELO or EHLO command matches this
14472 list, a reverse lookup is done in order to establish the host's true name. The
14473 default forces a lookup if the client host gives the server's name or any of
14474 its IP addresses (in brackets), something that broken clients have been seen to
14475 do.
14476
14477
14478 .option helo_try_verify_hosts main "host list&!!" unset
14479 .cindex "HELO verifying" "optional"
14480 .cindex "EHLO" "verifying, optional"
14481 By default, Exim just checks the syntax of HELO and EHLO commands (see
14482 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14483 to do more extensive checking of the data supplied by these commands. The ACL
14484 condition &`verify = helo`& is provided to make this possible.
14485 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14486 to force the check to occur. From release 4.53 onwards, this is no longer
14487 necessary. If the check has not been done before &`verify = helo`& is
14488 encountered, it is done at that time. Consequently, this option is obsolete.
14489 Its specification is retained here for backwards compatibility.
14490
14491 When an EHLO or HELO command is received, if the calling host matches
14492 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14493 EHLO command either:
14494
14495 .ilist
14496 is an IP literal matching the calling address of the host, or
14497 .next
14498 .cindex "DNS" "reverse lookup"
14499 .cindex "reverse DNS lookup"
14500 matches the host name that Exim obtains by doing a reverse lookup of the
14501 calling host address, or
14502 .next
14503 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14504 available) yields the calling host address.
14505 .endlist
14506
14507 However, the EHLO or HELO command is not rejected if any of the checks
14508 fail. Processing continues, but the result of the check is remembered, and can
14509 be detected later in an ACL by the &`verify = helo`& condition.
14510
14511 .option helo_verify_hosts main "host list&!!" unset
14512 .cindex "HELO verifying" "mandatory"
14513 .cindex "EHLO" "verifying, mandatory"
14514 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14515 backwards compatibility. For hosts that match this option, Exim checks the host
14516 name given in the HELO or EHLO in the same way as for
14517 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14518 rejected with a 550 error, and entries are written to the main and reject logs.
14519 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14520 error.
14521
14522 .option hold_domains main "domain list&!!" unset
14523 .cindex "domain" "delaying delivery"
14524 .cindex "delivery" "delaying certain domains"
14525 This option allows mail for particular domains to be held on the queue
14526 manually. The option is overridden if a message delivery is forced with the
14527 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14528 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14529 item in &%hold_domains%&, no routing or delivery for that address is done, and
14530 it is deferred every time the message is looked at.
14531
14532 This option is intended as a temporary operational measure for delaying the
14533 delivery of mail while some problem is being sorted out, or some new
14534 configuration tested. If you just want to delay the processing of some
14535 domains until a queue run occurs, you should use &%queue_domains%& or
14536 &%queue_smtp_domains%&, not &%hold_domains%&.
14537
14538 A setting of &%hold_domains%& does not override Exim's code for removing
14539 messages from the queue if they have been there longer than the longest retry
14540 time in any retry rule. If you want to hold messages for longer than the normal
14541 retry times, insert a dummy retry rule with a long retry time.
14542
14543
14544 .option host_lookup main "host list&!!" unset
14545 .cindex "host name" "lookup, forcing"
14546 Exim does not look up the name of a calling host from its IP address unless it
14547 is required to compare against some host list, or the host matches
14548 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14549 option (which normally contains IP addresses rather than host names). The
14550 default configuration file contains
14551 .code
14552 host_lookup = *
14553 .endd
14554 which causes a lookup to happen for all hosts. If the expense of these lookups
14555 is felt to be too great, the setting can be changed or removed.
14556
14557 After a successful reverse lookup, Exim does a forward lookup on the name it
14558 has obtained, to verify that it yields the IP address that it started with. If
14559 this check fails, Exim behaves as if the name lookup failed.
14560
14561 .vindex "&$host_lookup_failed$&"
14562 .vindex "&$sender_host_name$&"
14563 After any kind of failure, the host name (in &$sender_host_name$&) remains
14564 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14565 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14566 &`verify = reverse_host_lookup`& in ACLs.
14567
14568
14569 .option host_lookup_order main "string list" &`bydns:byaddr`&
14570 This option specifies the order of different lookup methods when Exim is trying
14571 to find a host name from an IP address. The default is to do a DNS lookup
14572 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14573 if that fails. You can change the order of these lookups, or omit one entirely,
14574 if you want.
14575
14576 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14577 multiple PTR records in the DNS and the IP address is not listed in
14578 &_/etc/hosts_&. Different operating systems give different results in this
14579 case. That is why the default tries a DNS lookup first.
14580
14581
14582
14583 .option host_reject_connection main "host list&!!" unset
14584 .cindex "host" "rejecting connections from"
14585 If this option is set, incoming SMTP calls from the hosts listed are rejected
14586 as soon as the connection is made.
14587 This option is obsolete, and retained only for backward compatibility, because
14588 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14589 connections immediately.
14590
14591 The ability to give an immediate rejection (either by this option or using an
14592 ACL) is provided for use in unusual cases. Many hosts will just try again,
14593 sometimes without much delay. Normally, it is better to use an ACL to reject
14594 incoming messages at a later stage, such as after RCPT commands. See
14595 chapter &<<CHAPACL>>&.
14596
14597
14598 .option hosts_connection_nolog main "host list&!!" unset
14599 .cindex "host" "not logging connections from"
14600 This option defines a list of hosts for which connection logging does not
14601 happen, even though the &%smtp_connection%& log selector is set. For example,
14602 you might want not to log SMTP connections from local processes, or from
14603 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14604 the daemon; you should therefore strive to restrict its value to a short inline
14605 list of IP addresses and networks. To disable logging SMTP connections from
14606 local processes, you must create a host list with an empty item. For example:
14607 .code
14608 hosts_connection_nolog = :
14609 .endd
14610 If the &%smtp_connection%& log selector is not set, this option has no effect.
14611
14612
14613
14614 .option hosts_treat_as_local main "domain list&!!" unset
14615 .cindex "local host" "domains treated as"
14616 .cindex "host" "treated as local"
14617 If this option is set, any host names that match the domain list are treated as
14618 if they were the local host when Exim is scanning host lists obtained from MX
14619 records
14620 or other sources. Note that the value of this option is a domain list, not a
14621 host list, because it is always used to check host names, not IP addresses.
14622
14623 This option also applies when Exim is matching the special items
14624 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14625 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14626 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14627 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14628 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14629 interfaces and recognizing the local host.
14630
14631
14632 .option ibase_servers main "string list" unset
14633 .cindex "InterBase" "server list"
14634 This option provides a list of InterBase servers and associated connection data,
14635 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14636 The option is available only if Exim has been built with InterBase support.
14637
14638
14639
14640 .option ignore_bounce_errors_after main time 10w
14641 .cindex "bounce message" "discarding"
14642 .cindex "discarding bounce message"
14643 This option affects the processing of bounce messages that cannot be delivered,
14644 that is, those that suffer a permanent delivery failure. (Bounce messages that
14645 suffer temporary delivery failures are of course retried in the usual way.)
14646
14647 After a permanent delivery failure, bounce messages are frozen,
14648 because there is no sender to whom they can be returned. When a frozen bounce
14649 message has been on the queue for more than the given time, it is unfrozen at
14650 the next queue run, and a further delivery is attempted. If delivery fails
14651 again, the bounce message is discarded. This makes it possible to keep failed
14652 bounce messages around for a shorter time than the normal maximum retry time
14653 for frozen messages. For example,
14654 .code
14655 ignore_bounce_errors_after = 12h
14656 .endd
14657 retries failed bounce message deliveries after 12 hours, discarding any further
14658 failures. If the value of this option is set to a zero time period, bounce
14659 failures are discarded immediately. Setting a very long time (as in the default
14660 value) has the effect of disabling this option. For ways of automatically
14661 dealing with other kinds of frozen message, see &%auto_thaw%& and
14662 &%timeout_frozen_after%&.
14663
14664
14665 .option ignore_fromline_hosts main "host list&!!" unset
14666 .cindex "&""From""& line"
14667 .cindex "UUCP" "&""From""& line"
14668 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14669 the headers of a message. By default this is treated as the start of the
14670 message's body, which means that any following headers are not recognized as
14671 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14672 match those hosts that insist on sending it. If the sender is actually a local
14673 process rather than a remote host, and is using &%-bs%& to inject the messages,
14674 &%ignore_fromline_local%& must be set to achieve this effect.
14675
14676
14677 .option ignore_fromline_local main boolean false
14678 See &%ignore_fromline_hosts%& above.
14679
14680
14681 .option keep_malformed main time 4d
14682 This option specifies the length of time to keep messages whose spool files
14683 have been corrupted in some way. This should, of course, never happen. At the
14684 next attempt to deliver such a message, it gets removed. The incident is
14685 logged.
14686
14687
14688 .option ldap_ca_cert_dir main string unset
14689 .cindex "LDAP", "TLS CA certificate directory"
14690 This option indicates which directory contains CA certificates for verifying
14691 a TLS certificate presented by an LDAP server.
14692 While Exim does not provide a default value, your SSL library may.
14693 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14694 and constrained to be a directory.
14695
14696
14697 .option ldap_ca_cert_file main string unset
14698 .cindex "LDAP", "TLS CA certificate file"
14699 This option indicates which file contains CA certificates for verifying
14700 a TLS certificate presented by an LDAP server.
14701 While Exim does not provide a default value, your SSL library may.
14702 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14703 and constrained to be a file.
14704
14705
14706 .option ldap_cert_file main string unset
14707 .cindex "LDAP" "TLS client certificate file"
14708 This option indicates which file contains an TLS client certificate which
14709 Exim should present to the LDAP server during TLS negotiation.
14710 Should be used together with &%ldap_cert_key%&.
14711
14712
14713 .option ldap_cert_key main string unset
14714 .cindex "LDAP" "TLS client key file"
14715 This option indicates which file contains the secret/private key to use
14716 to prove identity to the LDAP server during TLS negotiation.
14717 Should be used together with &%ldap_cert_file%&, which contains the
14718 identity to be proven.
14719
14720
14721 .option ldap_cipher_suite main string unset
14722 .cindex "LDAP" "TLS cipher suite"
14723 This controls the TLS cipher-suite negotiation during TLS negotiation with
14724 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14725 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14726
14727
14728 .option ldap_default_servers main "string list" unset
14729 .cindex "LDAP" "default servers"
14730 This option provides a list of LDAP servers which are tried in turn when an
14731 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14732 details of LDAP queries. This option is available only when Exim has been built
14733 with LDAP support.
14734
14735
14736 .option ldap_require_cert main string unset.
14737 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14738 This should be one of the values "hard", "demand", "allow", "try" or "never".
14739 A value other than one of these is interpreted as "never".
14740 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14741 Although Exim does not set a default, the LDAP library probably defaults
14742 to hard/demand.
14743
14744
14745 .option ldap_start_tls main boolean false
14746 .cindex "LDAP" "whether or not to negotiate TLS"
14747 If set, Exim will attempt to negotiate TLS with the LDAP server when
14748 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14749 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14750 of SSL-on-connect.
14751 In the event of failure to negotiate TLS, the action taken is controlled
14752 by &%ldap_require_cert%&.
14753
14754
14755 .option ldap_version main integer unset
14756 .cindex "LDAP" "protocol version, forcing"
14757 This option can be used to force Exim to set a specific protocol version for
14758 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14759 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14760 the LDAP headers; otherwise it is 2. This option is available only when Exim
14761 has been built with LDAP support.
14762
14763
14764
14765 .option local_from_check main boolean true
14766 .cindex "&'Sender:'& header line" "disabling addition of"
14767 .cindex "&'From:'& header line" "disabling checking of"
14768 When a message is submitted locally (that is, not over a TCP/IP connection) by
14769 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14770 checks that the &'From:'& header line matches the login of the calling user and
14771 the domain specified by &%qualify_domain%&.
14772
14773 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14774 locally submitted message is automatically qualified by Exim, unless the
14775 &%-bnq%& command line option is used.
14776
14777 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14778 on the local part. If the &'From:'& header line does not match, Exim adds a
14779 &'Sender:'& header with an address constructed from the calling user's login
14780 and the default qualify domain.
14781
14782 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14783 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14784 &'Sender:'& header lines supplied by untrusted users, you must also set
14785 &%local_sender_retain%& to be true.
14786
14787 .cindex "envelope sender"
14788 These options affect only the header lines in the message. The envelope sender
14789 is still forced to be the login id at the qualify domain unless
14790 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14791
14792 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14793 request similar header line checking. See section &<<SECTthesenhea>>&, which
14794 has more details about &'Sender:'& processing.
14795
14796
14797
14798
14799 .option local_from_prefix main string unset
14800 When Exim checks the &'From:'& header line of locally submitted messages for
14801 matching the login id (see &%local_from_check%& above), it can be configured to
14802 ignore certain prefixes and suffixes in the local part of the address. This is
14803 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14804 appropriate lists, in the same form as the &%local_part_prefix%& and
14805 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14806 example, if
14807 .code
14808 local_from_prefix = *-
14809 .endd
14810 is set, a &'From:'& line containing
14811 .code
14812 From: anything-user@your.domain.example
14813 .endd
14814 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14815 matches the actual sender address that is constructed from the login name and
14816 qualify domain.
14817
14818
14819 .option local_from_suffix main string unset
14820 See &%local_from_prefix%& above.
14821
14822
14823 .option local_interfaces main "string list" "see below"
14824 This option controls which network interfaces are used by the daemon for
14825 listening; they are also used to identify the local host when routing. Chapter
14826 &<<CHAPinterfaces>>& contains a full description of this option and the related
14827 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14828 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14829 &%local_interfaces%& is
14830 .code
14831 local_interfaces = 0.0.0.0
14832 .endd
14833 when Exim is built without IPv6 support; otherwise it is
14834 .code
14835 local_interfaces = <; ::0 ; 0.0.0.0
14836 .endd
14837
14838 .option local_scan_timeout main time 5m
14839 .cindex "timeout" "for &[local_scan()]& function"
14840 .cindex "&[local_scan()]& function" "timeout"
14841 This timeout applies to the &[local_scan()]& function (see chapter
14842 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14843 the incoming message is rejected with a temporary error if it is an SMTP
14844 message. For a non-SMTP message, the message is dropped and Exim ends with a
14845 non-zero code. The incident is logged on the main and reject logs.
14846
14847
14848
14849 .option local_sender_retain main boolean false
14850 .cindex "&'Sender:'& header line" "retaining from local submission"
14851 When a message is submitted locally (that is, not over a TCP/IP connection) by
14852 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14853 do not want this to happen, you must set &%local_sender_retain%&, and you must
14854 also set &%local_from_check%& to be false (Exim will complain if you do not).
14855 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14856 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14857
14858
14859
14860
14861 .option localhost_number main string&!! unset
14862 .cindex "host" "locally unique number for"
14863 .cindex "message ids" "with multiple hosts"
14864 .vindex "&$localhost_number$&"
14865 Exim's message ids are normally unique only within the local host. If
14866 uniqueness among a set of hosts is required, each host must set a different
14867 value for the &%localhost_number%& option. The string is expanded immediately
14868 after reading the configuration file (so that a number can be computed from the
14869 host name, for example) and the result of the expansion must be a number in the
14870 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14871 systems). This is available in subsequent string expansions via the variable
14872 &$localhost_number$&. When &%localhost_number is set%&, the final two
14873 characters of the message id, instead of just being a fractional part of the
14874 time, are computed from the time and the local host number as described in
14875 section &<<SECTmessiden>>&.
14876
14877
14878
14879 .option log_file_path main "string list&!!" "set at compile time"
14880 .cindex "log" "file path for"
14881 This option sets the path which is used to determine the names of Exim's log
14882 files, or indicates that logging is to be to syslog, or both. It is expanded
14883 when Exim is entered, so it can, for example, contain a reference to the host
14884 name. If no specific path is set for the log files at compile or run time, they
14885 are written in a sub-directory called &_log_& in Exim's spool directory.
14886 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14887 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14888 used. If this string is fixed at your installation (contains no expansion
14889 variables) it is recommended that you do not set this option in the
14890 configuration file, but instead supply the path using LOG_FILE_PATH in
14891 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14892 early on &-- in particular, failure to read the configuration file.
14893
14894
14895 .option log_selector main string unset
14896 .cindex "log" "selectors"
14897 This option can be used to reduce or increase the number of things that Exim
14898 writes to its log files. Its argument is made up of names preceded by plus or
14899 minus characters. For example:
14900 .code
14901 log_selector = +arguments -retry_defer
14902 .endd
14903 A list of possible names and what they control is given in the chapter on
14904 logging, in section &<<SECTlogselector>>&.
14905
14906
14907 .option log_timezone main boolean false
14908 .cindex "log" "timezone for entries"
14909 .vindex "&$tod_log$&"
14910 .vindex "&$tod_zone$&"
14911 By default, the timestamps on log lines are in local time without the
14912 timezone. This means that if your timezone changes twice a year, the timestamps
14913 in log lines are ambiguous for an hour when the clocks go back. One way of
14914 avoiding this problem is to set the timezone to UTC. An alternative is to set
14915 &%log_timezone%& true. This turns on the addition of the timezone offset to
14916 timestamps in log lines. Turning on this option can add quite a lot to the size
14917 of log files because each line is extended by 6 characters. Note that the
14918 &$tod_log$& variable contains the log timestamp without the zone, but there is
14919 another variable called &$tod_zone$& that contains just the timezone offset.
14920
14921
14922 .option lookup_open_max main integer 25
14923 .cindex "too many open files"
14924 .cindex "open files, too many"
14925 .cindex "file" "too many open"
14926 .cindex "lookup" "maximum open files"
14927 .cindex "limit" "open files for lookups"
14928 This option limits the number of simultaneously open files for single-key
14929 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14930 Exim normally keeps these files open during routing, because often the same
14931 file is required several times. If the limit is reached, Exim closes the least
14932 recently used file. Note that if you are using the &'ndbm'& library, it
14933 actually opens two files for each logical DBM database, though it still counts
14934 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14935 open files"& errors with NDBM, you need to reduce the value of
14936 &%lookup_open_max%&.
14937
14938
14939 .option max_username_length main integer 0
14940 .cindex "length of login name"
14941 .cindex "user name" "maximum length"
14942 .cindex "limit" "user name length"
14943 Some operating systems are broken in that they truncate long arguments to
14944 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14945 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14946 an argument that is longer behaves as if &[getpwnam()]& failed.
14947
14948
14949 .option message_body_newlines main bool false
14950 .cindex "message body" "newlines in variables"
14951 .cindex "newline" "in message body variables"
14952 .vindex "&$message_body$&"
14953 .vindex "&$message_body_end$&"
14954 By default, newlines in the message body are replaced by spaces when setting
14955 the &$message_body$& and &$message_body_end$& expansion variables. If this
14956 option is set true, this no longer happens.
14957
14958
14959 .option message_body_visible main integer 500
14960 .cindex "body of message" "visible size"
14961 .cindex "message body" "visible size"
14962 .vindex "&$message_body$&"
14963 .vindex "&$message_body_end$&"
14964 This option specifies how much of a message's body is to be included in the
14965 &$message_body$& and &$message_body_end$& expansion variables.
14966
14967
14968 .option message_id_header_domain main string&!! unset
14969 .cindex "&'Message-ID:'& header line"
14970 If this option is set, the string is expanded and used as the right hand side
14971 (domain) of the &'Message-ID:'& header that Exim creates if a
14972 locally-originated incoming message does not have one. &"Locally-originated"&
14973 means &"not received over TCP/IP."&
14974 Otherwise, the primary host name is used.
14975 Only letters, digits, dot and hyphen are accepted; any other characters are
14976 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14977 empty string, the option is ignored.
14978
14979
14980 .option message_id_header_text main string&!! unset
14981 If this variable is set, the string is expanded and used to augment the text of
14982 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14983 message does not have one. The text of this header is required by RFC 2822 to
14984 take the form of an address. By default, Exim uses its internal message id as
14985 the local part, and the primary host name as the domain. If this option is set,
14986 it is expanded, and provided the expansion is not forced to fail, and does not
14987 yield an empty string, the result is inserted into the header immediately
14988 before the @, separated from the internal message id by a dot. Any characters
14989 that are illegal in an address are automatically converted into hyphens. This
14990 means that variables such as &$tod_log$& can be used, because the spaces and
14991 colons will become hyphens.
14992
14993
14994 .option message_logs main boolean true
14995 .cindex "message logs" "disabling"
14996 .cindex "log" "message log; disabling"
14997 If this option is turned off, per-message log files are not created in the
14998 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14999 Exim, by reducing the number of files involved in handling a message from a
15000 minimum of four (header spool file, body spool file, delivery journal, and
15001 per-message log) to three. The other major I/O activity is Exim's main log,
15002 which is not affected by this option.
15003
15004
15005 .option message_size_limit main string&!! 50M
15006 .cindex "message" "size limit"
15007 .cindex "limit" "message size"
15008 .cindex "size" "of message, limit"
15009 This option limits the maximum size of message that Exim will process. The
15010 value is expanded for each incoming connection so, for example, it can be made
15011 to depend on the IP address of the remote host for messages arriving via
15012 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15013 optionally followed by K or M.
15014
15015 &*Note*&: This limit cannot be made to depend on a message's sender or any
15016 other properties of an individual message, because it has to be advertised in
15017 the server's response to EHLO. String expansion failure causes a temporary
15018 error. A value of zero means no limit, but its use is not recommended. See also
15019 &%bounce_return_size_limit%&.
15020
15021 Incoming SMTP messages are failed with a 552 error if the limit is
15022 exceeded; locally-generated messages either get a stderr message or a delivery
15023 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15024 an oversized message is logged in both the main and the reject logs. See also
15025 the generic transport option &%message_size_limit%&, which limits the size of
15026 message that an individual transport can process.
15027
15028 If you use a virus-scanner and set this option to to a value larger than the
15029 maximum size that your virus-scanner is configured to support, you may get
15030 failures triggered by large mails.  The right size to configure for the
15031 virus-scanner depends upon what data is passed and the options in use but it's
15032 probably safest to just set it to a little larger than this value.  Eg, with a
15033 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15034 some problems may result.
15035
15036 A value of 0 will disable size limit checking; Exim will still advertise the
15037 SIZE extension in an EHLO response, but without a limit, so as to permit
15038 SMTP clients to still indicate the message size along with the MAIL verb.
15039
15040
15041 .option move_frozen_messages main boolean false
15042 .cindex "frozen messages" "moving"
15043 This option, which is available only if Exim has been built with the setting
15044 .code
15045 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15046 .endd
15047 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15048 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15049 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15050 standard utilities for handling such moved messages, and they do not show up in
15051 lists generated by &%-bp%& or by the Exim monitor.
15052
15053
15054 .option mua_wrapper main boolean false
15055 Setting this option true causes Exim to run in a very restrictive mode in which
15056 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15057 contains a full description of this facility.
15058
15059
15060
15061 .option mysql_servers main "string list" unset
15062 .cindex "MySQL" "server list"
15063 This option provides a list of MySQL servers and associated connection data, to
15064 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15065 option is available only if Exim has been built with MySQL support.
15066
15067
15068 .option never_users main "string list&!!" unset
15069 This option is expanded just once, at the start of Exim's processing. Local
15070 message deliveries are normally run in processes that are setuid to the
15071 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15072 It is usually desirable to prevent any deliveries from running as root, as a
15073 safety precaution.
15074
15075 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15076 list of users that must not be used for local deliveries. This list is fixed in
15077 the binary and cannot be overridden by the configuration file. By default, it
15078 contains just the single user name &"root"&. The &%never_users%& runtime option
15079 can be used to add more users to the fixed list.
15080
15081 If a message is to be delivered as one of the users on the fixed list or the
15082 &%never_users%& list, an error occurs, and delivery is deferred. A common
15083 example is
15084 .code
15085 never_users = root:daemon:bin
15086 .endd
15087 Including root is redundant if it is also on the fixed list, but it does no
15088 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15089 transport driver.
15090
15091
15092 .option openssl_options main "string list" "+no_sslv2"
15093 .cindex "OpenSSL "compatibility options"
15094 This option allows an administrator to adjust the SSL options applied
15095 by OpenSSL to connections.  It is given as a space-separated list of items,
15096 each one to be +added or -subtracted from the current value.
15097
15098 This option is only available if Exim is built against OpenSSL.  The values
15099 available for this option vary according to the age of your OpenSSL install.
15100 The &"all"& value controls a subset of flags which are available, typically
15101 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15102 list the values known on your system and Exim should support all the
15103 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15104 names lose the leading &"SSL_OP_"& and are lower-cased.
15105
15106 Note that adjusting the options can have severe impact upon the security of
15107 SSL as used by Exim.  It is possible to disable safety checks and shoot
15108 yourself in the foot in various unpleasant ways.  This option should not be
15109 adjusted lightly.  An unrecognised item will be detected at startup, by
15110 invoking Exim with the &%-bV%& flag.
15111
15112 The option affects Exim operating both as a server and as a client.
15113
15114 Historical note: prior to release 4.80, Exim defaulted this value to
15115 "+dont_insert_empty_fragments", which may still be needed for compatibility
15116 with some clients, but which lowers security by increasing exposure to
15117 some now infamous attacks.
15118
15119 Examples:
15120 .code
15121 # Make both old MS and old Eudora happy:
15122 openssl_options = -all +microsoft_big_sslv3_buffer \
15123                        +dont_insert_empty_fragments
15124
15125 # Disable older protocol versions:
15126 openssl_options = +no_sslv2 +no_sslv3
15127 .endd
15128
15129 Possible options may include:
15130 .ilist
15131 &`all`&
15132 .next
15133 &`allow_unsafe_legacy_renegotiation`&
15134 .next
15135 &`cipher_server_preference`&
15136 .next
15137 &`dont_insert_empty_fragments`&
15138 .next
15139 &`ephemeral_rsa`&
15140 .next
15141 &`legacy_server_connect`&
15142 .next
15143 &`microsoft_big_sslv3_buffer`&
15144 .next
15145 &`microsoft_sess_id_bug`&
15146 .next
15147 &`msie_sslv2_rsa_padding`&
15148 .next
15149 &`netscape_challenge_bug`&
15150 .next
15151 &`netscape_reuse_cipher_change_bug`&
15152 .next
15153 &`no_compression`&
15154 .next
15155 &`no_session_resumption_on_renegotiation`&
15156 .next
15157 &`no_sslv2`&
15158 .next
15159 &`no_sslv3`&
15160 .next
15161 &`no_ticket`&
15162 .next
15163 &`no_tlsv1`&
15164 .next
15165 &`no_tlsv1_1`&
15166 .next
15167 &`no_tlsv1_2`&
15168 .next
15169 &`safari_ecdhe_ecdsa_bug`&
15170 .next
15171 &`single_dh_use`&
15172 .next
15173 &`single_ecdh_use`&
15174 .next
15175 &`ssleay_080_client_dh_bug`&
15176 .next
15177 &`sslref2_reuse_cert_type_bug`&
15178 .next
15179 &`tls_block_padding_bug`&
15180 .next
15181 &`tls_d5_bug`&
15182 .next
15183 &`tls_rollback_bug`&
15184 .endlist
15185
15186 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15187 all clients connecting using the MacOS SecureTransport TLS facility prior
15188 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15189 to negotiate TLS then this option value might help, provided that your OpenSSL
15190 release is new enough to contain this work-around.  This may be a situation
15191 where you have to upgrade OpenSSL to get buggy clients working.
15192
15193
15194 .option oracle_servers main "string list" unset
15195 .cindex "Oracle" "server list"
15196 This option provides a list of Oracle servers and associated connection data,
15197 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15198 The option is available only if Exim has been built with Oracle support.
15199
15200
15201 .option percent_hack_domains main "domain list&!!" unset
15202 .cindex "&""percent hack""&"
15203 .cindex "source routing" "in email address"
15204 .cindex "address" "source-routed"
15205 The &"percent hack"& is the convention whereby a local part containing a
15206 percent sign is re-interpreted as a new email address, with the percent
15207 replaced by @. This is sometimes called &"source routing"&, though that term is
15208 also applied to RFC 2822 addresses that begin with an @ character. If this
15209 option is set, Exim implements the percent facility for those domains listed,
15210 but no others. This happens before an incoming SMTP address is tested against
15211 an ACL.
15212
15213 &*Warning*&: The &"percent hack"& has often been abused by people who are
15214 trying to get round relaying restrictions. For this reason, it is best avoided
15215 if at all possible. Unfortunately, a number of less security-conscious MTAs
15216 implement it unconditionally. If you are running Exim on a gateway host, and
15217 routing mail through to internal MTAs without processing the local parts, it is
15218 a good idea to reject recipient addresses with percent characters in their
15219 local parts. Exim's default configuration does this.
15220
15221
15222 .option perl_at_start main boolean false
15223 This option is available only when Exim is built with an embedded Perl
15224 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15225
15226
15227 .option perl_startup main string unset
15228 This option is available only when Exim is built with an embedded Perl
15229 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15230
15231
15232 .option pgsql_servers main "string list" unset
15233 .cindex "PostgreSQL lookup type" "server list"
15234 This option provides a list of PostgreSQL servers and associated connection
15235 data, to be used in conjunction with &(pgsql)& lookups (see section
15236 &<<SECID72>>&). The option is available only if Exim has been built with
15237 PostgreSQL support.
15238
15239
15240 .option pid_file_path main string&!! "set at compile time"
15241 .cindex "daemon" "pid file path"
15242 .cindex "pid file, path for"
15243 This option sets the name of the file to which the Exim daemon writes its
15244 process id. The string is expanded, so it can contain, for example, references
15245 to the host name:
15246 .code
15247 pid_file_path = /var/log/$primary_hostname/exim.pid
15248 .endd
15249 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15250 spool directory.
15251 The value set by the option can be overridden by the &%-oP%& command line
15252 option. A pid file is not written if a &"non-standard"& daemon is run by means
15253 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15254
15255
15256 .option pipelining_advertise_hosts main "host list&!!" *
15257 .cindex "PIPELINING" "suppressing advertising"
15258 This option can be used to suppress the advertisement of the SMTP
15259 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15260 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15261 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15262 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15263 that clients will use it; &"out of order"& commands that are &"expected"& do
15264 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15265
15266
15267 .option prdr_enable main boolean false
15268 .cindex "PRDR" "enabling on server"
15269 This option can be used to enable the Per-Recipient Data Response extension
15270 to SMTP, defined by Eric Hall.
15271 If the option is set, PRDR is advertised by Exim when operating as a server.
15272 If the client requests PRDR, and more than one recipient, for a message 
15273 an additional ACL is called for each recipient after the message content
15274 is recieved.  See section &<<SECTPRDRACL>>&.
15275
15276 .option preserve_message_logs main boolean false
15277 .cindex "message logs" "preserving"
15278 If this option is set, message log files are not deleted when messages are
15279 completed. Instead, they are moved to a sub-directory of the spool directory
15280 called &_msglog.OLD_&, where they remain available for statistical or debugging
15281 purposes. This is a dangerous option to set on systems with any appreciable
15282 volume of mail. Use with care!
15283
15284
15285 .option primary_hostname main string "see below"
15286 .cindex "name" "of local host"
15287 .cindex "host" "name of local"
15288 .cindex "local host" "name of"
15289 .vindex "&$primary_hostname$&"
15290 This specifies the name of the current host. It is used in the default EHLO or
15291 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15292 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15293 The value is also used by default in some SMTP response messages from an Exim
15294 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15295
15296 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15297 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15298 contains only one component, Exim passes it to &[gethostbyname()]& (or
15299 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15300 version. The variable &$primary_hostname$& contains the host name, whether set
15301 explicitly by this option, or defaulted.
15302
15303
15304 .option print_topbitchars main boolean false
15305 .cindex "printing characters"
15306 .cindex "8-bit characters"
15307 By default, Exim considers only those characters whose codes lie in the range
15308 32&--126 to be printing characters. In a number of circumstances (for example,
15309 when writing log entries) non-printing characters are converted into escape
15310 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15311 is set, code values of 128 and above are also considered to be printing
15312 characters.
15313
15314 This option also affects the header syntax checks performed by the
15315 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15316 the user's full name when constructing From: and Sender: addresses (as
15317 described in section &<<SECTconstr>>&). Setting this option can cause
15318 Exim to generate eight bit message headers that do not conform to the
15319 standards.
15320
15321
15322 .option process_log_path main string unset
15323 .cindex "process log path"
15324 .cindex "log" "process log"
15325 .cindex "&'exiwhat'&"
15326 This option sets the name of the file to which an Exim process writes its
15327 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15328 utility script. If this option is unset, the file called &_exim-process.info_&
15329 in Exim's spool directory is used. The ability to specify the name explicitly
15330 can be useful in environments where two different Exims are running, using
15331 different spool directories.
15332
15333
15334 .option prod_requires_admin main boolean true
15335 .oindex "&%-M%&"
15336 .oindex "&%-R%&"
15337 .oindex "&%-q%&"
15338 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15339 admin user unless &%prod_requires_admin%& is set false. See also
15340 &%queue_list_requires_admin%&.
15341
15342
15343 .option qualify_domain main string "see below"
15344 .cindex "domain" "for qualifying addresses"
15345 .cindex "address" "qualification"
15346 This option specifies the domain name that is added to any envelope sender
15347 addresses that do not have a domain qualification. It also applies to
15348 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15349 are accepted by default only for locally-generated messages. Qualification is
15350 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15351 locally-generated messages, unless the &%-bnq%& command line option is used.
15352
15353 Messages from external sources must always contain fully qualified addresses,
15354 unless the sending host matches &%sender_unqualified_hosts%& or
15355 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15356 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15357 necessary. Internally, Exim always works with fully qualified envelope
15358 addresses. If &%qualify_domain%& is not set, it defaults to the
15359 &%primary_hostname%& value.
15360
15361
15362 .option qualify_recipient main string "see below"
15363 This option allows you to specify a different domain for qualifying recipient
15364 addresses to the one that is used for senders. See &%qualify_domain%& above.
15365
15366
15367
15368 .option queue_domains main "domain list&!!" unset
15369 .cindex "domain" "specifying non-immediate delivery"
15370 .cindex "queueing incoming messages"
15371 .cindex "message" "queueing certain domains"
15372 This option lists domains for which immediate delivery is not required.
15373 A delivery process is started whenever a message is received, but only those
15374 domains that do not match are processed. All other deliveries wait until the
15375 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15376
15377
15378 .option queue_list_requires_admin main boolean true
15379 .oindex "&%-bp%&"
15380 The &%-bp%& command-line option, which lists the messages that are on the
15381 queue, requires the caller to be an admin user unless
15382 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15383
15384
15385 .option queue_only main boolean false
15386 .cindex "queueing incoming messages"
15387 .cindex "message" "queueing unconditionally"
15388 If &%queue_only%& is set, a delivery process is not automatically started
15389 whenever a message is received. Instead, the message waits on the queue for the
15390 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15391 delivered immediately when certain conditions (such as heavy load) occur.
15392
15393 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15394 and &%-odi%& command line options override &%queue_only%& unless
15395 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15396 &%queue_only_load%&, and &%smtp_accept_queue%&.
15397
15398
15399 .option queue_only_file main string unset
15400 .cindex "queueing incoming messages"
15401 .cindex "message" "queueing by file existence"
15402 This option can be set to a colon-separated list of absolute path names, each
15403 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15404 it tests for the existence of each listed path using a call to &[stat()]&. For
15405 each path that exists, the corresponding queueing option is set.
15406 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15407 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15408 .code
15409 queue_only_file = smtp/some/file
15410 .endd
15411 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15412 &_/some/file_& exists.
15413
15414
15415 .option queue_only_load main fixed-point unset
15416 .cindex "load average"
15417 .cindex "queueing incoming messages"
15418 .cindex "message" "queueing by load"
15419 If the system load average is higher than this value, incoming messages from
15420 all sources are queued, and no automatic deliveries are started. If this
15421 happens during local or remote SMTP input, all subsequent messages received on
15422 the same SMTP connection are queued by default, whatever happens to the load in
15423 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15424 false.
15425
15426 Deliveries will subsequently be performed by queue runner processes. This
15427 option has no effect on ancient operating systems on which Exim cannot
15428 determine the load average. See also &%deliver_queue_load_max%& and
15429 &%smtp_load_reserve%&.
15430
15431
15432 .option queue_only_load_latch main boolean true
15433 .cindex "load average" "re-evaluating per message"
15434 When this option is true (the default), once one message has been queued
15435 because the load average is higher than the value set by &%queue_only_load%&,
15436 all subsequent messages received on the same SMTP connection are also queued.
15437 This is a deliberate choice; even though the load average may fall below the
15438 threshold, it doesn't seem right to deliver later messages on the same
15439 connection when not delivering earlier ones. However, there are special
15440 circumstances such as very long-lived connections from scanning appliances
15441 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15442 should be set false. This causes the value of the load average to be
15443 re-evaluated for each message.
15444
15445
15446 .option queue_only_override main boolean true
15447 .cindex "queueing incoming messages"
15448 When this option is true, the &%-od%&&'x'& command line options override the
15449 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15450 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15451 to override; they are accepted, but ignored.
15452
15453
15454 .option queue_run_in_order main boolean false
15455 .cindex "queue runner" "processing messages in order"
15456 If this option is set, queue runs happen in order of message arrival instead of
15457 in an arbitrary order. For this to happen, a complete list of the entire queue
15458 must be set up before the deliveries start. When the queue is all held in a
15459 single directory (the default), a single list is created for both the ordered
15460 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15461 single list is not created when &%queue_run_in_order%& is false. In this case,
15462 the sub-directories are processed one at a time (in a random order), and this
15463 avoids setting up one huge list for the whole queue. Thus, setting
15464 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15465 when the queue is large, because of the extra work in setting up the single,
15466 large list. In most situations, &%queue_run_in_order%& should not be set.
15467
15468
15469
15470 .option queue_run_max main integer 5
15471 .cindex "queue runner" "maximum number of"
15472 This controls the maximum number of queue runner processes that an Exim daemon
15473 can run simultaneously. This does not mean that it starts them all at once,
15474 but rather that if the maximum number are still running when the time comes to
15475 start another one, it refrains from starting another one. This can happen with
15476 very large queues and/or very sluggish deliveries. This option does not,
15477 however, interlock with other processes, so additional queue runners can be
15478 started by other means, or by killing and restarting the daemon.
15479
15480 Setting this option to zero does not suppress queue runs; rather, it disables
15481 the limit, allowing any number of simultaneous queue runner processes to be
15482 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15483 the daemon's command line.
15484
15485 .option queue_smtp_domains main "domain list&!!" unset
15486 .cindex "queueing incoming messages"
15487 .cindex "message" "queueing remote deliveries"
15488 When this option is set, a delivery process is started whenever a message is
15489 received, routing is performed, and local deliveries take place.
15490 However, if any SMTP deliveries are required for domains that match
15491 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15492 message waits on the queue for the next queue run. Since routing of the message
15493 has taken place, Exim knows to which remote hosts it must be delivered, and so
15494 when the queue run happens, multiple messages for the same host are delivered
15495 over a single SMTP connection. The &%-odqs%& command line option causes all
15496 SMTP deliveries to be queued in this way, and is equivalent to setting
15497 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15498 &%queue_domains%&.
15499
15500
15501 .option receive_timeout main time 0s
15502 .cindex "timeout" "for non-SMTP input"
15503 This option sets the timeout for accepting a non-SMTP message, that is, the
15504 maximum time that Exim waits when reading a message on the standard input. If
15505 the value is zero, it will wait for ever. This setting is overridden by the
15506 &%-or%& command line option. The timeout for incoming SMTP messages is
15507 controlled by &%smtp_receive_timeout%&.
15508
15509 .option received_header_text main string&!! "see below"
15510 .cindex "customizing" "&'Received:'& header"
15511 .cindex "&'Received:'& header line" "customizing"
15512 This string defines the contents of the &'Received:'& message header that is
15513 added to each message, except for the timestamp, which is automatically added
15514 on at the end (preceded by a semicolon). The string is expanded each time it is
15515 used. If the expansion yields an empty string, no &'Received:'& header line is
15516 added to the message. Otherwise, the string should start with the text
15517 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15518 header lines. The default setting is:
15519
15520 .code
15521 received_header_text = Received: \
15522   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15523   {${if def:sender_ident \
15524   {from ${quote_local_part:$sender_ident} }}\
15525   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15526   by $primary_hostname \
15527   ${if def:received_protocol {with $received_protocol}} \
15528   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15529   (Exim $version_number)\n\t\
15530   ${if def:sender_address \
15531   {(envelope-from <$sender_address>)\n\t}}\
15532   id $message_exim_id\
15533   ${if def:received_for {\n\tfor $received_for}}
15534 .endd
15535
15536 The reference to the TLS cipher is omitted when Exim is built without TLS
15537 support. The use of conditional expansions ensures that this works for both
15538 locally generated messages and messages received from remote hosts, giving
15539 header lines such as the following:
15540 .code
15541 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15542 by marley.carol.example with esmtp (Exim 4.00)
15543 (envelope-from <bob@carol.example>)
15544 id 16IOWa-00019l-00
15545 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15546 Received: by scrooge.carol.example with local (Exim 4.00)
15547 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15548 .endd
15549 Until the body of the message has been received, the timestamp is the time when
15550 the message started to be received. Once the body has arrived, and all policy
15551 checks have taken place, the timestamp is updated to the time at which the
15552 message was accepted.
15553
15554
15555 .option received_headers_max main integer 30
15556 .cindex "loop" "prevention"
15557 .cindex "mail loop prevention"
15558 .cindex "&'Received:'& header line" "counting"
15559 When a message is to be delivered, the number of &'Received:'& headers is
15560 counted, and if it is greater than this parameter, a mail loop is assumed to
15561 have occurred, the delivery is abandoned, and an error message is generated.
15562 This applies to both local and remote deliveries.
15563
15564
15565 .option recipient_unqualified_hosts main "host list&!!" unset
15566 .cindex "unqualified addresses"
15567 .cindex "host" "unqualified addresses from"
15568 This option lists those hosts from which Exim is prepared to accept unqualified
15569 recipient addresses in message envelopes. The addresses are made fully
15570 qualified by the addition of the &%qualify_recipient%& value. This option also
15571 affects message header lines. Exim does not reject unqualified recipient
15572 addresses in headers, but it qualifies them only if the message came from a
15573 host that matches &%recipient_unqualified_hosts%&,
15574 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15575 option was not set.
15576
15577
15578 .option recipients_max main integer 0
15579 .cindex "limit" "number of recipients"
15580 .cindex "recipient" "maximum number"
15581 If this option is set greater than zero, it specifies the maximum number of
15582 original recipients for any message. Additional recipients that are generated
15583 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15584 all recipients over the limit; earlier recipients are delivered as normal.
15585 Non-SMTP messages with too many recipients are failed, and no deliveries are
15586 done.
15587
15588 .cindex "RCPT" "maximum number of incoming"
15589 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15590 RCPT commands in a single message.
15591
15592
15593 .option recipients_max_reject main boolean false
15594 If this option is set true, Exim rejects SMTP messages containing too many
15595 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15596 error to the eventual DATA command. Otherwise (the default) it gives a 452
15597 error to the surplus RCPT commands and accepts the message on behalf of the
15598 initial set of recipients. The remote server should then re-send the message
15599 for the remaining recipients at a later time.
15600
15601
15602 .option remote_max_parallel main integer 2
15603 .cindex "delivery" "parallelism for remote"
15604 This option controls parallel delivery of one message to a number of remote
15605 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15606 does all the remote deliveries for a message one by one. Otherwise, if a single
15607 message has to be delivered to more than one remote host, or if several copies
15608 have to be sent to the same remote host, up to &%remote_max_parallel%&
15609 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15610 deliveries are required, the maximum number of processes are started, and as
15611 each one finishes, another is begun. The order of starting processes is the
15612 same as if sequential delivery were being done, and can be controlled by the
15613 &%remote_sort_domains%& option. If parallel delivery takes place while running
15614 with debugging turned on, the debugging output from each delivery process is
15615 tagged with its process id.
15616
15617 This option controls only the maximum number of parallel deliveries for one
15618 message in one Exim delivery process. Because Exim has no central queue
15619 manager, there is no way of controlling the total number of simultaneous
15620 deliveries if the configuration allows a delivery attempt as soon as a message
15621 is received.
15622
15623 .cindex "number of deliveries"
15624 .cindex "delivery" "maximum number of"
15625 If you want to control the total number of deliveries on the system, you
15626 need to set the &%queue_only%& option. This ensures that all incoming messages
15627 are added to the queue without starting a delivery process. Then set up an Exim
15628 daemon to start queue runner processes at appropriate intervals (probably
15629 fairly often, for example, every minute), and limit the total number of queue
15630 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15631 delivers only one message at a time, the maximum number of deliveries that can
15632 then take place at once is &%queue_run_max%& multiplied by
15633 &%remote_max_parallel%&.
15634
15635 If it is purely remote deliveries you want to control, use
15636 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15637 doing the SMTP routing before queueing, so that several messages for the same
15638 host will eventually get delivered down the same connection.
15639
15640
15641 .option remote_sort_domains main "domain list&!!" unset
15642 .cindex "sorting remote deliveries"
15643 .cindex "delivery" "sorting remote"
15644 When there are a number of remote deliveries for a message, they are sorted by
15645 domain into the order given by this list. For example,
15646 .code
15647 remote_sort_domains = *.cam.ac.uk:*.uk
15648 .endd
15649 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15650 then to those in the &%uk%& domain, then to any others.
15651
15652
15653 .option retry_data_expire main time 7d
15654 .cindex "hints database" "data expiry"
15655 This option sets a &"use before"& time on retry information in Exim's hints
15656 database. Any older retry data is ignored. This means that, for example, once a
15657 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15658 past failures.
15659
15660
15661 .option retry_interval_max main time 24h
15662 .cindex "retry" "limit on interval"
15663 .cindex "limit" "on retry interval"
15664 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15665 intervals between delivery attempts for messages that cannot be delivered
15666 straight away. This option sets an overall limit to the length of time between
15667 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15668 the default value.
15669
15670
15671 .option return_path_remove main boolean true
15672 .cindex "&'Return-path:'& header line" "removing"
15673 RFC 2821, section 4.4, states that an SMTP server must insert a
15674 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15675 The &'Return-path:'& header preserves the sender address as received in the
15676 MAIL command. This description implies that this header should not be present
15677 in an incoming message. If &%return_path_remove%& is true, any existing
15678 &'Return-path:'& headers are removed from messages at the time they are
15679 received. Exim's transports have options for adding &'Return-path:'& headers at
15680 the time of delivery. They are normally used only for final local deliveries.
15681
15682
15683 .option return_size_limit main integer 100K
15684 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15685
15686
15687 .new
15688 .option rfc1413_hosts main "host list&!!" @[]
15689 .cindex "RFC 1413"
15690 .cindex "host" "for RFC 1413 calls"
15691 RFC 1413 identification calls are made to any client host which matches
15692 an item in the list.
15693 The default value specifies just this host, being any local interface
15694 for the system.
15695 .wen
15696
15697 .new
15698 .option rfc1413_query_timeout main time 0s
15699 .wen
15700 .cindex "RFC 1413" "query timeout"
15701 .cindex "timeout" "for RFC 1413 call"
15702 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15703 no RFC 1413 calls are ever made.
15704
15705
15706 .option sender_unqualified_hosts main "host list&!!" unset
15707 .cindex "unqualified addresses"
15708 .cindex "host" "unqualified addresses from"
15709 This option lists those hosts from which Exim is prepared to accept unqualified
15710 sender addresses. The addresses are made fully qualified by the addition of
15711 &%qualify_domain%&. This option also affects message header lines. Exim does
15712 not reject unqualified addresses in headers that contain sender addresses, but
15713 it qualifies them only if the message came from a host that matches
15714 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15715 using TCP/IP), and the &%-bnq%& option was not set.
15716
15717
15718 .option smtp_accept_keepalive main boolean true
15719 .cindex "keepalive" "on incoming connection"
15720 This option controls the setting of the SO_KEEPALIVE option on incoming
15721 TCP/IP socket connections. When set, it causes the kernel to probe idle
15722 connections periodically, by sending packets with &"old"& sequence numbers. The
15723 other end of the connection should send an acknowledgment if the connection is
15724 still okay or a reset if the connection has been aborted. The reason for doing
15725 this is that it has the beneficial effect of freeing up certain types of
15726 connection that can get stuck when the remote host is disconnected without
15727 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15728 hours to detect unreachable hosts.
15729
15730
15731
15732 .option smtp_accept_max main integer 20
15733 .cindex "limit" "incoming SMTP connections"
15734 .cindex "SMTP" "incoming connection count"
15735 .cindex "inetd"
15736 This option specifies the maximum number of simultaneous incoming SMTP calls
15737 that Exim will accept. It applies only to the listening daemon; there is no
15738 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15739 value is set to zero, no limit is applied. However, it is required to be
15740 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15741 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15742
15743 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15744 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15745 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15746 and &%smtp_load_reserve%& are then checked before accepting the connection.
15747
15748
15749 .option smtp_accept_max_nonmail main integer 10
15750 .cindex "limit" "non-mail SMTP commands"
15751 .cindex "SMTP" "limiting non-mail commands"
15752 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15753 the connection if there are too many. This option defines &"too many"&. The
15754 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15755 client looping sending EHLO, for example. The check is applied only if the
15756 client host matches &%smtp_accept_max_nonmail_hosts%&.
15757
15758 When a new message is expected, one occurrence of RSET is not counted. This
15759 allows a client to send one RSET between messages (this is not necessary,
15760 but some clients do it). Exim also allows one uncounted occurrence of HELO
15761 or EHLO, and one occurrence of STARTTLS between messages. After
15762 starting up a TLS session, another EHLO is expected, and so it too is not
15763 counted. The first occurrence of AUTH in a connection, or immediately
15764 following STARTTLS is not counted. Otherwise, all commands other than
15765 MAIL, RCPT, DATA, and QUIT are counted.
15766
15767
15768 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15769 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15770 check by setting this option. The default value makes it apply to all hosts. By
15771 changing the value, you can exclude any badly-behaved hosts that you have to
15772 live with.
15773
15774
15775 . Allow this long option name to split; give it unsplit as a fifth argument
15776 . for the automatic .oindex that is generated by .option.
15777 . We insert " &~&~" which is both pretty nasty visually and results in
15778 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15779 . zero-width-space, which would be nicer visually and results in (at least)
15780 . html that Firefox will split on when it's forced to reflow (rather than
15781 . inserting a horizontal scrollbar).  However, the text is still not
15782 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15783 . the option name to split.
15784
15785 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15786          smtp_accept_max_per_connection
15787 .cindex "SMTP" "limiting incoming message count"
15788 .cindex "limit" "messages per SMTP connection"
15789 The value of this option limits the number of MAIL commands that Exim is
15790 prepared to accept over a single SMTP connection, whether or not each command
15791 results in the transfer of a message. After the limit is reached, a 421
15792 response is given to subsequent MAIL commands. This limit is a safety
15793 precaution against a client that goes mad (incidents of this type have been
15794 seen).
15795
15796
15797 .option smtp_accept_max_per_host main string&!! unset
15798 .cindex "limit" "SMTP connections from one host"
15799 .cindex "host" "limiting SMTP connections from"
15800 This option restricts the number of simultaneous IP connections from a single
15801 host (strictly, from a single IP address) to the Exim daemon. The option is
15802 expanded, to enable different limits to be applied to different hosts by
15803 reference to &$sender_host_address$&. Once the limit is reached, additional
15804 connection attempts from the same host are rejected with error code 421. This
15805 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15806 of zero imposes no limit. If this option is set greater than zero, it is
15807 required that &%smtp_accept_max%& be non-zero.
15808
15809 &*Warning*&: When setting this option you should not use any expansion
15810 constructions that take an appreciable amount of time. The expansion and test
15811 happen in the main daemon loop, in order to reject additional connections
15812 without forking additional processes (otherwise a denial-of-service attack
15813 could cause a vast number or processes to be created). While the daemon is
15814 doing this processing, it cannot accept any other incoming connections.
15815
15816
15817
15818 .option smtp_accept_queue main integer 0
15819 .cindex "SMTP" "incoming connection count"
15820 .cindex "queueing incoming messages"
15821 .cindex "message" "queueing by SMTP connection count"
15822 If the number of simultaneous incoming SMTP connections being handled via the
15823 listening daemon exceeds this value, messages received by SMTP are just placed
15824 on the queue; no delivery processes are started automatically. The count is
15825 fixed at the start of an SMTP connection. It cannot be updated in the
15826 subprocess that receives messages, and so the queueing or not queueing applies
15827 to all messages received in the same connection.
15828
15829 A value of zero implies no limit, and clearly any non-zero value is useful only
15830 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15831 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15832 various &%-od%&&'x'& command line options.
15833
15834
15835 . See the comment on smtp_accept_max_per_connection
15836
15837 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15838          smtp_accept_queue_per_connection
15839 .cindex "queueing incoming messages"
15840 .cindex "message" "queueing by message count"
15841 This option limits the number of delivery processes that Exim starts
15842 automatically when receiving messages via SMTP, whether via the daemon or by
15843 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15844 and the number of messages received in a single SMTP session exceeds this
15845 number, subsequent messages are placed on the queue, but no delivery processes
15846 are started. This helps to limit the number of Exim processes when a server
15847 restarts after downtime and there is a lot of mail waiting for it on other
15848 systems. On large systems, the default should probably be increased, and on
15849 dial-in client systems it should probably be set to zero (that is, disabled).
15850
15851
15852 .option smtp_accept_reserve main integer 0
15853 .cindex "SMTP" "incoming call count"
15854 .cindex "host" "reserved"
15855 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15856 number of SMTP connections that are reserved for connections from the hosts
15857 that are specified in &%smtp_reserve_hosts%&. The value set in
15858 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15859 restricted to this number of connections; the option specifies a minimum number
15860 of connection slots for them, not a maximum. It is a guarantee that this group
15861 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15862 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15863 individual host.
15864
15865 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15866 set to 5, once there are 45 active connections (from any hosts), new
15867 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15868 provided the other criteria for acceptance are met.
15869
15870
15871 .option smtp_active_hostname main string&!! unset
15872 .cindex "host" "name in SMTP responses"
15873 .cindex "SMTP" "host name in responses"
15874 .vindex "&$primary_hostname$&"
15875 This option is provided for multi-homed servers that want to masquerade as
15876 several different hosts. At the start of an incoming SMTP connection, its value
15877 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15878 responses. For example, it is used as domain name in the response to an
15879 incoming HELO or EHLO command.
15880
15881 .vindex "&$smtp_active_hostname$&"
15882 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15883 is saved with any messages that are received. It is therefore available for use
15884 in routers and transports when the message is later delivered.
15885
15886 If this option is unset, or if its expansion is forced to fail, or if the
15887 expansion results in an empty string, the value of &$primary_hostname$& is
15888 used. Other expansion failures cause a message to be written to the main and
15889 panic logs, and the SMTP command receives a temporary error. Typically, the
15890 value of &%smtp_active_hostname%& depends on the incoming interface address.
15891 For example:
15892 .code
15893 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15894   {cox.mydomain}{box.mydomain}}
15895 .endd
15896
15897 Although &$smtp_active_hostname$& is primarily concerned with incoming
15898 messages, it is also used as the default for HELO commands in callout
15899 verification if there is no remote transport from which to obtain a
15900 &%helo_data%& value.
15901
15902 .option smtp_banner main string&!! "see below"
15903 .cindex "SMTP" "welcome banner"
15904 .cindex "banner for SMTP"
15905 .cindex "welcome banner for SMTP"
15906 .cindex "customizing" "SMTP banner"
15907 This string, which is expanded every time it is used, is output as the initial
15908 positive response to an SMTP connection. The default setting is:
15909 .code
15910 smtp_banner = $smtp_active_hostname ESMTP Exim \
15911   $version_number $tod_full
15912 .endd
15913 Failure to expand the string causes a panic error. If you want to create a
15914 multiline response to the initial SMTP connection, use &"\n"& in the string at
15915 appropriate points, but not at the end. Note that the 220 code is not included
15916 in this string. Exim adds it automatically (several times in the case of a
15917 multiline response).
15918
15919
15920 .option smtp_check_spool_space main boolean true
15921 .cindex "checking disk space"
15922 .cindex "disk space, checking"
15923 .cindex "spool directory" "checking space"
15924 When this option is set, if an incoming SMTP session encounters the SIZE
15925 option on a MAIL command, it checks that there is enough space in the
15926 spool directory's partition to accept a message of that size, while still
15927 leaving free the amount specified by &%check_spool_space%& (even if that value
15928 is zero). If there isn't enough space, a temporary error code is returned.
15929
15930
15931 .option smtp_connect_backlog main integer 20
15932 .cindex "connection backlog"
15933 .cindex "SMTP" "connection backlog"
15934 .cindex "backlog of connections"
15935 This option specifies a maximum number of waiting SMTP connections. Exim passes
15936 this value to the TCP/IP system when it sets up its listener. Once this number
15937 of connections are waiting for the daemon's attention, subsequent connection
15938 attempts are refused at the TCP/IP level. At least, that is what the manuals
15939 say; in some circumstances such connection attempts have been observed to time
15940 out instead. For large systems it is probably a good idea to increase the
15941 value (to 50, say). It also gives some protection against denial-of-service
15942 attacks by SYN flooding.
15943
15944
15945 .option smtp_enforce_sync main boolean true
15946 .cindex "SMTP" "synchronization checking"
15947 .cindex "synchronization checking in SMTP"
15948 The SMTP protocol specification requires the client to wait for a response from
15949 the server at certain points in the dialogue. Without PIPELINING these
15950 synchronization points are after every command; with PIPELINING they are
15951 fewer, but they still exist.
15952
15953 Some spamming sites send out a complete set of SMTP commands without waiting
15954 for any response. Exim protects against this by rejecting a message if the
15955 client has sent further input when it should not have. The error response &"554
15956 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15957 for this error cannot be perfect because of transmission delays (unexpected
15958 input may be on its way but not yet received when Exim checks). However, it
15959 does detect many instances.
15960
15961 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15962 If you want to disable the check selectively (for example, only for certain
15963 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15964 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15965
15966
15967
15968 .option smtp_etrn_command main string&!! unset
15969 .cindex "ETRN" "command to be run"
15970 .vindex "&$domain$&"
15971 If this option is set, the given command is run whenever an SMTP ETRN
15972 command is received from a host that is permitted to issue such commands (see
15973 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15974 are independently expanded. The expansion variable &$domain$& is set to the
15975 argument of the ETRN command, and no syntax checking is done on it. For
15976 example:
15977 .code
15978 smtp_etrn_command = /etc/etrn_command $domain \
15979                     $sender_host_address
15980 .endd
15981 A new process is created to run the command, but Exim does not wait for it to
15982 complete. Consequently, its status cannot be checked. If the command cannot be
15983 run, a line is written to the panic log, but the ETRN caller still receives
15984 a 250 success response. Exim is normally running under its own uid when
15985 receiving SMTP, so it is not possible for it to change the uid before running
15986 the command.
15987
15988
15989 .option smtp_etrn_serialize main boolean true
15990 .cindex "ETRN" "serializing"
15991 When this option is set, it prevents the simultaneous execution of more than
15992 one identical command as a result of ETRN in an SMTP connection. See
15993 section &<<SECTETRN>>& for details.
15994
15995
15996 .option smtp_load_reserve main fixed-point unset
15997 .cindex "load average"
15998 If the system load average ever gets higher than this, incoming SMTP calls are
15999 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16000 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16001 the load is over the limit. The option has no effect on ancient operating
16002 systems on which Exim cannot determine the load average. See also
16003 &%deliver_queue_load_max%& and &%queue_only_load%&.
16004
16005
16006
16007 .option smtp_max_synprot_errors main integer 3
16008 .cindex "SMTP" "limiting syntax and protocol errors"
16009 .cindex "limit" "SMTP syntax and protocol errors"
16010 Exim rejects SMTP commands that contain syntax or protocol errors. In
16011 particular, a syntactically invalid email address, as in this command:
16012 .code
16013 RCPT TO:<abc xyz@a.b.c>
16014 .endd
16015 causes immediate rejection of the command, before any other tests are done.
16016 (The ACL cannot be run if there is no valid address to set up for it.) An
16017 example of a protocol error is receiving RCPT before MAIL. If there are
16018 too many syntax or protocol errors in one SMTP session, the connection is
16019 dropped. The limit is set by this option.
16020
16021 .cindex "PIPELINING" "expected errors"
16022 When the PIPELINING extension to SMTP is in use, some protocol errors are
16023 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16024 Exim assumes that PIPELINING will be used if it advertises it (see
16025 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16026 not count towards the limit.
16027
16028
16029
16030 .option smtp_max_unknown_commands main integer 3
16031 .cindex "SMTP" "limiting unknown commands"
16032 .cindex "limit" "unknown SMTP commands"
16033 If there are too many unrecognized commands in an incoming SMTP session, an
16034 Exim server drops the connection. This is a defence against some kinds of abuse
16035 that subvert web
16036 clients
16037 into making connections to SMTP ports; in these circumstances, a number of
16038 non-SMTP command lines are sent first.
16039
16040
16041
16042 .option smtp_ratelimit_hosts main "host list&!!" unset
16043 .cindex "SMTP" "rate limiting"
16044 .cindex "limit" "rate of message arrival"
16045 .cindex "RCPT" "rate limiting"
16046 Some sites find it helpful to be able to limit the rate at which certain hosts
16047 can send them messages, and the rate at which an individual message can specify
16048 recipients.
16049
16050 Exim has two rate-limiting facilities. This section describes the older
16051 facility, which can limit rates within a single connection. The newer
16052 &%ratelimit%& ACL condition can limit rates across all connections. See section
16053 &<<SECTratelimiting>>& for details of the newer facility.
16054
16055 When a host matches &%smtp_ratelimit_hosts%&, the values of
16056 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16057 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16058 respectively. Each option, if set, must contain a set of four comma-separated
16059 values:
16060
16061 .ilist
16062 A threshold, before which there is no rate limiting.
16063 .next
16064 An initial time delay. Unlike other times in Exim, numbers with decimal
16065 fractional parts are allowed here.
16066 .next
16067 A factor by which to increase the delay each time.
16068 .next
16069 A maximum value for the delay. This should normally be less than 5 minutes,
16070 because after that time, the client is liable to timeout the SMTP command.
16071 .endlist
16072
16073 For example, these settings have been used successfully at the site which
16074 first suggested this feature, for controlling mail from their customers:
16075 .code
16076 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16077 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16078 .endd
16079 The first setting specifies delays that are applied to MAIL commands after
16080 two have been received over a single connection. The initial delay is 0.5
16081 seconds, increasing by a factor of 1.05 each time. The second setting applies
16082 delays to RCPT commands when more than four occur in a single message.
16083
16084
16085 .option smtp_ratelimit_mail main string unset
16086 See &%smtp_ratelimit_hosts%& above.
16087
16088
16089 .option smtp_ratelimit_rcpt main string unset
16090 See &%smtp_ratelimit_hosts%& above.
16091
16092
16093 .option smtp_receive_timeout main time&!! 5m
16094 .cindex "timeout" "for SMTP input"
16095 .cindex "SMTP" "input timeout"
16096 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16097 input, including batch SMTP. If a line of input (either an SMTP command or a
16098 data line) is not received within this time, the SMTP connection is dropped and
16099 the message is abandoned.
16100 A line is written to the log containing one of the following messages:
16101 .code
16102 SMTP command timeout on connection from...
16103 SMTP data timeout on connection from...
16104 .endd
16105 The former means that Exim was expecting to read an SMTP command; the latter
16106 means that it was in the DATA phase, reading the contents of a message.
16107
16108 If the first character of the option is a &"$"& the option is
16109 expanded before use and may depend on
16110 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16111
16112
16113 .oindex "&%-os%&"
16114 The value set by this option can be overridden by the
16115 &%-os%& command-line option. A setting of zero time disables the timeout, but
16116 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16117 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16118 timeout is controlled by &%receive_timeout%& and &%-or%&.
16119
16120
16121 .option smtp_reserve_hosts main "host list&!!" unset
16122 This option defines hosts for which SMTP connections are reserved; see
16123 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16124
16125
16126 .option smtp_return_error_details main boolean false
16127 .cindex "SMTP" "details policy failures"
16128 .cindex "policy control" "rejection, returning details"
16129 In the default state, Exim uses bland messages such as
16130 &"Administrative prohibition"& when it rejects SMTP commands for policy
16131 reasons. Many sysadmins like this because it gives away little information
16132 to spammers. However, some other sysadmins who are applying strict checking
16133 policies want to give out much fuller information about failures. Setting
16134 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16135 example, instead of &"Administrative prohibition"&, it might give:
16136 .code
16137 550-Rejected after DATA: '>' missing at end of address:
16138 550 failing address in "From" header is: <user@dom.ain
16139 .endd
16140
16141 .option spamd_address main string "see below"
16142 This option is available when Exim is compiled with the content-scanning
16143 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16144 The default value is
16145 .code
16146 127.0.0.1 783
16147 .endd
16148 See section &<<SECTscanspamass>>& for more details.
16149
16150
16151
16152 .option split_spool_directory main boolean false
16153 .cindex "multiple spool directories"
16154 .cindex "spool directory" "split"
16155 .cindex "directories, multiple"
16156 If this option is set, it causes Exim to split its input directory into 62
16157 subdirectories, each with a single alphanumeric character as its name. The
16158 sixth character of the message id is used to allocate messages to
16159 subdirectories; this is the least significant base-62 digit of the time of
16160 arrival of the message.
16161
16162 Splitting up the spool in this way may provide better performance on systems
16163 where there are long mail queues, by reducing the number of files in any one
16164 directory. The msglog directory is also split up in a similar way to the input
16165 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16166 are still placed in the single directory &_msglog.OLD_&.
16167
16168 It is not necessary to take any special action for existing messages when
16169 changing &%split_spool_directory%&. Exim notices messages that are in the
16170 &"wrong"& place, and continues to process them. If the option is turned off
16171 after a period of being on, the subdirectories will eventually empty and be
16172 automatically deleted.
16173
16174 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16175 changes. Instead of creating a list of all messages in the queue, and then
16176 trying to deliver each one in turn, it constructs a list of those in one
16177 sub-directory and tries to deliver them, before moving on to the next
16178 sub-directory. The sub-directories are processed in a random order. This
16179 spreads out the scanning of the input directories, and uses less memory. It is
16180 particularly beneficial when there are lots of messages on the queue. However,
16181 if &%queue_run_in_order%& is set, none of this new processing happens. The
16182 entire queue has to be scanned and sorted before any deliveries can start.
16183
16184
16185 .option spool_directory main string&!! "set at compile time"
16186 .cindex "spool directory" "path to"
16187 This defines the directory in which Exim keeps its spool, that is, the messages
16188 it is waiting to deliver. The default value is taken from the compile-time
16189 configuration setting, if there is one. If not, this option must be set. The
16190 string is expanded, so it can contain, for example, a reference to
16191 &$primary_hostname$&.
16192
16193 If the spool directory name is fixed on your installation, it is recommended
16194 that you set it at build time rather than from this option, particularly if the
16195 log files are being written to the spool directory (see &%log_file_path%&).
16196 Otherwise log files cannot be used for errors that are detected early on, such
16197 as failures in the configuration file.
16198
16199 By using this option to override the compiled-in path, it is possible to run
16200 tests of Exim without using the standard spool.
16201
16202 .option sqlite_lock_timeout main time 5s
16203 .cindex "sqlite lookup type" "lock timeout"
16204 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16205 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16206
16207 .option strict_acl_vars main boolean false
16208 .cindex "&ACL;" "variables, handling unset"
16209 This option controls what happens if a syntactically valid but undefined ACL
16210 variable is referenced. If it is false (the default), an empty string
16211 is substituted; if it is true, an error is generated. See section
16212 &<<SECTaclvariables>>& for details of ACL variables.
16213
16214 .option strip_excess_angle_brackets main boolean false
16215 .cindex "angle brackets, excess"
16216 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16217 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16218 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16219 passed on to another MTA, the excess angle brackets are not passed on. If this
16220 option is not set, multiple pairs of angle brackets cause a syntax error.
16221
16222
16223 .option strip_trailing_dot main boolean false
16224 .cindex "trailing dot on domain"
16225 .cindex "dot" "trailing on domain"
16226 If this option is set, a trailing dot at the end of a domain in an address is
16227 ignored. If this is in the envelope and the message is passed on to another
16228 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16229 domain causes a syntax error.
16230 However, addresses in header lines are checked only when an ACL requests header
16231 syntax checking.
16232
16233
16234 .option syslog_duplication main boolean true
16235 .cindex "syslog" "duplicate log lines; suppressing"
16236 When Exim is logging to syslog, it writes the log lines for its three
16237 separate logs at different syslog priorities so that they can in principle
16238 be separated on the logging hosts. Some installations do not require this
16239 separation, and in those cases, the duplication of certain log lines is a
16240 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16241 particular log line is written to syslog. For lines that normally go to
16242 both the main log and the reject log, the reject log version (possibly
16243 containing message header lines) is written, at LOG_NOTICE priority.
16244 Lines that normally go to both the main and the panic log are written at
16245 the LOG_ALERT priority.
16246
16247
16248 .option syslog_facility main string unset
16249 .cindex "syslog" "facility; setting"
16250 This option sets the syslog &"facility"& name, used when Exim is logging to
16251 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16252 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16253 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16254 details of Exim's logging.
16255
16256
16257
16258 .option syslog_processname main string &`exim`&
16259 .cindex "syslog" "process name; setting"
16260 This option sets the syslog &"ident"& name, used when Exim is logging to
16261 syslog. The value must be no longer than 32 characters. See chapter
16262 &<<CHAPlog>>& for details of Exim's logging.
16263
16264
16265
16266 .option syslog_timestamp main boolean true
16267 .cindex "syslog" "timestamps"
16268 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16269 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16270 details of Exim's logging.
16271
16272
16273 .option system_filter main string&!! unset
16274 .cindex "filter" "system filter"
16275 .cindex "system filter" "specifying"
16276 .cindex "Sieve filter" "not available for system filter"
16277 This option specifies an Exim filter file that is applied to all messages at
16278 the start of each delivery attempt, before any routing is done. System filters
16279 must be Exim filters; they cannot be Sieve filters. If the system filter
16280 generates any deliveries to files or pipes, or any new mail messages, the
16281 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16282 which transports are to be used. Details of this facility are given in chapter
16283 &<<CHAPsystemfilter>>&.
16284
16285
16286 .option system_filter_directory_transport main string&!! unset
16287 .vindex "&$address_file$&"
16288 This sets the name of the transport driver that is to be used when the
16289 &%save%& command in a system message filter specifies a path ending in &"/"&,
16290 implying delivery of each message into a separate file in some directory.
16291 During the delivery, the variable &$address_file$& contains the path name.
16292
16293
16294 .option system_filter_file_transport main string&!! unset
16295 .cindex "file" "transport for system filter"
16296 This sets the name of the transport driver that is to be used when the &%save%&
16297 command in a system message filter specifies a path not ending in &"/"&. During
16298 the delivery, the variable &$address_file$& contains the path name.
16299
16300 .option system_filter_group main string unset
16301 .cindex "gid (group id)" "system filter"
16302 This option is used only when &%system_filter_user%& is also set. It sets the
16303 gid under which the system filter is run, overriding any gid that is associated
16304 with the user. The value may be numerical or symbolic.
16305
16306 .option system_filter_pipe_transport main string&!! unset
16307 .cindex "&(pipe)& transport" "for system filter"
16308 .vindex "&$address_pipe$&"
16309 This specifies the transport driver that is to be used when a &%pipe%& command
16310 is used in a system filter. During the delivery, the variable &$address_pipe$&
16311 contains the pipe command.
16312
16313
16314 .option system_filter_reply_transport main string&!! unset
16315 .cindex "&(autoreply)& transport" "for system filter"
16316 This specifies the transport driver that is to be used when a &%mail%& command
16317 is used in a system filter.
16318
16319
16320 .option system_filter_user main string unset
16321 .cindex "uid (user id)" "system filter"
16322 If this option is set to root, the system filter is run in the main Exim
16323 delivery process, as root.  Otherwise, the system filter runs in a separate
16324 process, as the given user, defaulting to the Exim run-time user.
16325 Unless the string consists entirely of digits, it
16326 is looked up in the password data. Failure to find the named user causes a
16327 configuration error. The gid is either taken from the password data, or
16328 specified by &%system_filter_group%&. When the uid is specified numerically,
16329 &%system_filter_group%& is required to be set.
16330
16331 If the system filter generates any pipe, file, or reply deliveries, the uid
16332 under which the filter is run is used when transporting them, unless a
16333 transport option overrides.
16334
16335
16336 .option tcp_nodelay main boolean true
16337 .cindex "daemon" "TCP_NODELAY on sockets"
16338 .cindex "Nagle algorithm"
16339 .cindex "TCP_NODELAY on listening sockets"
16340 If this option is set false, it stops the Exim daemon setting the
16341 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16342 turns off the &"Nagle algorithm"&, which is a way of improving network
16343 performance in interactive (character-by-character) situations. Turning it off
16344 should improve Exim's performance a bit, so that is what happens by default.
16345 However, it appears that some broken clients cannot cope, and time out. Hence
16346 this option. It affects only those sockets that are set up for listening by the
16347 daemon. Sockets created by the smtp transport for delivering mail always set
16348 TCP_NODELAY.
16349
16350
16351 .option timeout_frozen_after main time 0s
16352 .cindex "frozen messages" "timing out"
16353 .cindex "timeout" "frozen messages"
16354 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16355 message of any kind that has been on the queue for longer than the given time
16356 is automatically cancelled at the next queue run. If the frozen message is a
16357 bounce message, it is just discarded; otherwise, a bounce is sent to the
16358 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16359 If you want to timeout frozen bounce messages earlier than other kinds of
16360 frozen message, see &%ignore_bounce_errors_after%&.
16361
16362 &*Note:*& the default value of zero means no timeouts; with this setting,
16363 frozen messages remain on the queue forever (except for any frozen bounce
16364 messages that are released by &%ignore_bounce_errors_after%&).
16365
16366
16367 .option timezone main string unset
16368 .cindex "timezone, setting"
16369 The value of &%timezone%& is used to set the environment variable TZ while
16370 running Exim (if it is different on entry). This ensures that all timestamps
16371 created by Exim are in the required timezone. If you want all your timestamps
16372 to be in UTC (aka GMT) you should set
16373 .code
16374 timezone = UTC
16375 .endd
16376 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16377 or, if that is not set, from the value of the TZ environment variable when Exim
16378 is built. If &%timezone%& is set to the empty string, either at build or run
16379 time, any existing TZ variable is removed from the environment when Exim
16380 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16381 unfortunately not all, operating systems.
16382
16383
16384 .option tls_advertise_hosts main "host list&!!" unset
16385 .cindex "TLS" "advertising"
16386 .cindex "encryption" "on SMTP connection"
16387 .cindex "SMTP" "encrypted connection"
16388 When Exim is built with support for TLS encrypted connections, the availability
16389 of the STARTTLS command to set up an encrypted session is advertised in
16390 response to EHLO only to those client hosts that match this option. See
16391 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16392
16393
16394 .option tls_certificate main string&!! unset
16395 .cindex "TLS" "server certificate; location of"
16396 .cindex "certificate" "server, location of"
16397 The value of this option is expanded, and must then be the absolute path to a
16398 file which contains the server's certificates. The server's private key is also
16399 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16400 &<<CHAPTLS>>& for further details.
16401
16402 &*Note*&: The certificates defined by this option are used only when Exim is
16403 receiving incoming messages as a server. If you want to supply certificates for
16404 use when sending messages as a client, you must set the &%tls_certificate%&
16405 option in the relevant &(smtp)& transport.
16406
16407 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16408 if the OpenSSL build supports TLS extensions and the TLS client sends the
16409 Server Name Indication extension, then this option and others documented in
16410 &<<SECTtlssni>>& will be re-expanded.
16411
16412 .option tls_crl main string&!! unset
16413 .cindex "TLS" "server certificate revocation list"
16414 .cindex "certificate" "revocation list for server"
16415 This option specifies a certificate revocation list. The expanded value must
16416 be the name of a file that contains a CRL in PEM format.
16417
16418 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16419
16420
16421 .option tls_dh_max_bits main integer 2236
16422 .cindex "TLS" "D-H bit count"
16423 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16424 the chosen TLS library.  That value might prove to be too high for
16425 interoperability.  This option provides a maximum clamp on the value
16426 suggested, trading off security for interoperability.
16427
16428 The value must be at least 1024.
16429
16430 The value 2236 was chosen because, at time of adding the option, it was the
16431 hard-coded maximum value supported by the NSS cryptographic library, as used
16432 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16433
16434 If you prefer more security and are willing to break some clients, raise this
16435 number.
16436
16437 Note that the value passed to GnuTLS for *generating* a new prime may be a
16438 little less than this figure, because GnuTLS is inexact and may produce a
16439 larger prime than requested.
16440
16441
16442 .option tls_dhparam main string&!! unset
16443 .cindex "TLS" "D-H parameters for server"
16444 The value of this option is expanded and indicates the source of DH parameters
16445 to be used by Exim.
16446
16447 If it is a filename starting with a &`/`&, then it names a file from which DH
16448 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16449 PKCS#3 representation of the DH prime.  If the file does not exist, for
16450 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16451 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16452 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16453 and treated as though the &%tls_dhparam%& were set to "none".
16454
16455 If this option expands to the string "none", then no DH parameters will be
16456 loaded by Exim.
16457
16458 If this option expands to the string "historic" and Exim is using GnuTLS, then
16459 Exim will attempt to load a file from inside the spool directory.  If the file
16460 does not exist, Exim will attempt to create it.
16461 See section &<<SECTgnutlsparam>>& for further details.
16462
16463 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16464 a default DH prime; the default is the 2048 bit prime described in section
16465 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16466 in IKE is assigned number 23.
16467
16468 Otherwise, the option must expand to the name used by Exim for any of a number
16469 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16470 "ike" followed by the number used by IKE, of "default" which corresponds to
16471 "ike23".
16472
16473 The available primes are:
16474 &`ike1`&, &`ike2`&, &`ike5`&,
16475 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16476 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16477
16478 Some of these will be too small to be accepted by clients.
16479 Some may be too large to be accepted by clients.
16480
16481 The TLS protocol does not negotiate an acceptable size for this; clients tend
16482 to hard-drop connections if what is offered by the server is unacceptable,
16483 whether too large or too small, and there's no provision for the client to
16484 tell the server what these constraints are.  Thus, as a server operator, you
16485 need to make an educated guess as to what is most likely to work for your
16486 userbase.
16487
16488 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16489 is most likely to maximise interoperability.  The upper bound comes from
16490 applications using the Mozilla Network Security Services (NSS) library, which
16491 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16492 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16493 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16494 acceptable bound from 1024 to 2048.
16495
16496
16497 .option tls_ocsp_file main string&!! unset
16498 This option
16499 must if set expand to the absolute path to a file which contains a current
16500 status proof for the server's certificate, as obtained from the
16501 Certificate Authority.
16502
16503
16504 .option tls_on_connect_ports main "string list" unset
16505 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16506 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16507 set up without waiting for the client to issue a STARTTLS command. For
16508 further details, see section &<<SECTsupobssmt>>&.
16509
16510
16511
16512 .option tls_privatekey main string&!! unset
16513 .cindex "TLS" "server private key; location of"
16514 The value of this option is expanded, and must then be the absolute path to a
16515 file which contains the server's private key. If this option is unset, or if
16516 the expansion is forced to fail, or the result is an empty string, the private
16517 key is assumed to be in the same file as the server's certificates. See chapter
16518 &<<CHAPTLS>>& for further details.
16519
16520 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16521
16522
16523 .option tls_remember_esmtp main boolean false
16524 .cindex "TLS" "esmtp state; remembering"
16525 .cindex "TLS" "broken clients"
16526 If this option is set true, Exim violates the RFCs by remembering that it is in
16527 &"esmtp"& state after successfully negotiating a TLS session. This provides
16528 support for broken clients that fail to send a new EHLO after starting a
16529 TLS session.
16530
16531
16532 .option tls_require_ciphers main string&!! unset
16533 .cindex "TLS" "requiring specific ciphers"
16534 .cindex "cipher" "requiring specific"
16535 This option controls which ciphers can be used for incoming TLS connections.
16536 The &(smtp)& transport has an option of the same name for controlling outgoing
16537 connections. This option is expanded for each connection, so can be varied for
16538 different clients if required. The value of this option must be a list of
16539 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16540 in somewhat different ways. If GnuTLS is being used, the client controls the
16541 preference order of the available ciphers. Details are given in sections
16542 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16543
16544
16545 .option tls_try_verify_hosts main "host list&!!" unset
16546 .cindex "TLS" "client certificate verification"
16547 .cindex "certificate" "verification of client"
16548 See &%tls_verify_hosts%& below.
16549
16550
16551 .new
16552 .option tls_verify_certificates main string&!! system
16553 .cindex "TLS" "client certificate verification"
16554 .cindex "certificate" "verification of client"
16555 The value of this option is expanded, and must then be either the
16556 word "system"
16557 or the absolute path to
16558 a file or directory containing permitted certificates for clients that
16559 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16560
16561 The "system" value for the option will use a
16562 system default location compiled into the SSL library.
16563 This is not available for GnuTLS versions preceding 3.0.20,
16564 and will be taken as empty; an explicit location
16565 must be specified.
16566
16567 The use of a directory for the option value is not avilable for GnuTLS versions
16568 preceding 3.3.6 and a single file must be used.
16569
16570 With OpenSSL the certificates specified
16571 explicitly
16572 either by file or directory
16573 are added to those given by the system default location.
16574 .wen
16575
16576 These certificates should be for the certificate authorities trusted, rather
16577 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16578 the value is a file then the certificates are sent by Exim as a server to
16579 connecting clients, defining the list of accepted certificate authorities.
16580 Thus the values defined should be considered public data.  To avoid this,
16581 use the explicit directory version.
16582
16583 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16584
16585 A forced expansion failure or setting to an empty string is equivalent to
16586 being unset.
16587
16588
16589 .option tls_verify_hosts main "host list&!!" unset
16590 .cindex "TLS" "client certificate verification"
16591 .cindex "certificate" "verification of client"
16592 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16593 certificates from clients. The expected certificates are defined by
16594 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16595 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16596 &%tls_verify_certificates%& is not set.
16597
16598 Any client that matches &%tls_verify_hosts%& is constrained by
16599 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16600 present one of the listed certificates. If it does not, the connection is
16601 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16602 the host to use TLS. It can still send SMTP commands through unencrypted
16603 connections. Forcing a client to use TLS has to be done separately using an
16604 ACL to reject inappropriate commands when the connection is not encrypted.
16605
16606 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16607 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16608 certificate and checks it against &%tls_verify_certificates%&, but does not
16609 abort the connection if there is no certificate or if it does not match. This
16610 state can be detected in an ACL, which makes it possible to implement policies
16611 such as &"accept for relay only if a verified certificate has been received,
16612 but accept for local delivery if encrypted, even without a verified
16613 certificate"&.
16614
16615 Client hosts that match neither of these lists are not asked to present
16616 certificates.
16617
16618
16619 .option trusted_groups main "string list&!!" unset
16620 .cindex "trusted groups"
16621 .cindex "groups" "trusted"
16622 This option is expanded just once, at the start of Exim's processing. If this
16623 option is set, any process that is running in one of the listed groups, or
16624 which has one of them as a supplementary group, is trusted. The groups can be
16625 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16626 details of what trusted callers are permitted to do. If neither
16627 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16628 are trusted.
16629
16630 .option trusted_users main "string list&!!" unset
16631 .cindex "trusted users"
16632 .cindex "user" "trusted"
16633 This option is expanded just once, at the start of Exim's processing. If this
16634 option is set, any process that is running as one of the listed users is
16635 trusted. The users can be specified numerically or by name. See section
16636 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16637 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16638 Exim user are trusted.
16639
16640 .option unknown_login main string&!! unset
16641 .cindex "uid (user id)" "unknown caller"
16642 .vindex "&$caller_uid$&"
16643 This is a specialized feature for use in unusual configurations. By default, if
16644 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16645 gives up. The &%unknown_login%& option can be used to set a login name to be
16646 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16647 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16648 is used for the user's real name (gecos field), unless this has been set by the
16649 &%-F%& option.
16650
16651 .option unknown_username main string unset
16652 See &%unknown_login%&.
16653
16654 .option untrusted_set_sender main "address list&!!" unset
16655 .cindex "trusted users"
16656 .cindex "sender" "setting by untrusted user"
16657 .cindex "untrusted user setting sender"
16658 .cindex "user" "untrusted setting sender"
16659 .cindex "envelope sender"
16660 When an untrusted user submits a message to Exim using the standard input, Exim
16661 normally creates an envelope sender address from the user's login and the
16662 default qualification domain. Data from the &%-f%& option (for setting envelope
16663 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16664 is used) is ignored.
16665
16666 However, untrusted users are permitted to set an empty envelope sender address,
16667 to declare that a message should never generate any bounces. For example:
16668 .code
16669 exim -f '<>' user@domain.example
16670 .endd
16671 .vindex "&$sender_ident$&"
16672 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16673 other envelope sender addresses in a controlled way. When it is set, untrusted
16674 users are allowed to set envelope sender addresses that match any of the
16675 patterns in the list. Like all address lists, the string is expanded. The
16676 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16677 users to setting senders that start with their login ids
16678 followed by a hyphen
16679 by a setting like this:
16680 .code
16681 untrusted_set_sender = ^$sender_ident-
16682 .endd
16683 If you want to allow untrusted users to set envelope sender addresses without
16684 restriction, you can use
16685 .code
16686 untrusted_set_sender = *
16687 .endd
16688 The &%untrusted_set_sender%& option applies to all forms of local input, but
16689 only to the setting of the envelope sender. It does not permit untrusted users
16690 to use the other options which trusted user can use to override message
16691 parameters. Furthermore, it does not stop Exim from removing an existing
16692 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16693 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16694 overriding these actions. The handling of the &'Sender:'& header is also
16695 described in section &<<SECTthesenhea>>&.
16696
16697 The log line for a message's arrival shows the envelope sender following
16698 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16699 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16700 envelope sender address, the user's login is shown in parentheses after the
16701 sender address.
16702
16703
16704 .option uucp_from_pattern main string "see below"
16705 .cindex "&""From""& line"
16706 .cindex "UUCP" "&""From""& line"
16707 Some applications that pass messages to an MTA via a command line interface use
16708 an initial line starting with &"From&~"& to pass the envelope sender. In
16709 particular, this is used by UUCP software. Exim recognizes such a line by means
16710 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16711 matches, the sender address is constructed by expanding the contents of
16712 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16713 default pattern recognizes lines in the following two forms:
16714 .code
16715 From ph10 Fri Jan  5 12:35 GMT 1996
16716 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16717 .endd
16718 The pattern can be seen by running
16719 .code
16720 exim -bP uucp_from_pattern
16721 .endd
16722 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16723 year in the second case. The first word after &"From&~"& is matched in the
16724 regular expression by a parenthesized subpattern. The default value for
16725 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16726 (&"ph10"& in the example above) as the message's sender. See also
16727 &%ignore_fromline_hosts%&.
16728
16729
16730 .option uucp_from_sender main string&!! &`$1`&
16731 See &%uucp_from_pattern%& above.
16732
16733
16734 .option warn_message_file main string unset
16735 .cindex "warning of delay" "customizing the message"
16736 .cindex "customizing" "warning message"
16737 This option defines a template file containing paragraphs of text to be used
16738 for constructing the warning message which is sent by Exim when a message has
16739 been on the queue for a specified amount of time, as specified by
16740 &%delay_warning%&. Details of the file's contents are given in chapter
16741 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16742
16743
16744 .option write_rejectlog main boolean true
16745 .cindex "reject log" "disabling"
16746 If this option is set false, Exim no longer writes anything to the reject log.
16747 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16748 .ecindex IIDconfima
16749 .ecindex IIDmaiconf
16750
16751
16752
16753
16754 . ////////////////////////////////////////////////////////////////////////////
16755 . ////////////////////////////////////////////////////////////////////////////
16756
16757 .chapter "Generic options for routers" "CHAProutergeneric"
16758 .scindex IIDgenoprou1 "options" "generic; for routers"
16759 .scindex IIDgenoprou2 "generic options" "router"
16760 This chapter describes the generic options that apply to all routers.
16761 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16762
16763 For a general description of how a router operates, see sections
16764 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16765 which the preconditions are tested. The order of expansion of the options that
16766 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16767 &%headers_remove%&, &%transport%&.
16768
16769
16770
16771 .option address_data routers string&!! unset
16772 .cindex "router" "data attached to address"
16773 The string is expanded just before the router is run, that is, after all the
16774 precondition tests have succeeded. If the expansion is forced to fail, the
16775 router declines, the value of &%address_data%& remains unchanged, and the
16776 &%more%& option controls what happens next. Other expansion failures cause
16777 delivery of the address to be deferred.
16778
16779 .vindex "&$address_data$&"
16780 When the expansion succeeds, the value is retained with the address, and can be
16781 accessed using the variable &$address_data$& in the current router, subsequent
16782 routers, and the eventual transport.
16783
16784 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16785 that runs a user's filter file, the contents of &$address_data$& are accessible
16786 in the filter. This is not normally a problem, because such data is usually
16787 either not confidential or it &"belongs"& to the current user, but if you do
16788 put confidential data into &$address_data$& you need to remember this point.
16789
16790 Even if the router declines or passes, the value of &$address_data$& remains
16791 with the address, though it can be changed by another &%address_data%& setting
16792 on a subsequent router. If a router generates child addresses, the value of
16793 &$address_data$& propagates to them. This also applies to the special kind of
16794 &"child"& that is generated by a router with the &%unseen%& option.
16795
16796 The idea of &%address_data%& is that you can use it to look up a lot of data
16797 for the address once, and then pick out parts of the data later. For example,
16798 you could use a single LDAP lookup to return a string of the form
16799 .code
16800 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16801 .endd
16802 In the transport you could pick out the mailbox by a setting such as
16803 .code
16804 file = ${extract{mailbox}{$address_data}}
16805 .endd
16806 This makes the configuration file less messy, and also reduces the number of
16807 lookups (though Exim does cache lookups).
16808
16809 .vindex "&$sender_address_data$&"
16810 .vindex "&$address_data$&"
16811 The &%address_data%& facility is also useful as a means of passing information
16812 from one router to another, and from a router to a transport. In addition, if
16813 &$address_data$& is set by a router when verifying a recipient address from an
16814 ACL, it remains available for use in the rest of the ACL statement. After
16815 verifying a sender, the value is transferred to &$sender_address_data$&.
16816
16817
16818
16819 .option address_test routers&!? boolean true
16820 .oindex "&%-bt%&"
16821 .cindex "router" "skipping when address testing"
16822 If this option is set false, the router is skipped when routing is being tested
16823 by means of the &%-bt%& command line option. This can be a convenience when
16824 your first router sends messages to an external scanner, because it saves you
16825 having to set the &"already scanned"& indicator when testing real address
16826 routing.
16827
16828
16829
16830 .option cannot_route_message routers string&!! unset
16831 .cindex "router" "customizing &""cannot route""& message"
16832 .cindex "customizing" "&""cannot route""& message"
16833 This option specifies a text message that is used when an address cannot be
16834 routed because Exim has run out of routers. The default message is
16835 &"Unrouteable address"&. This option is useful only on routers that have
16836 &%more%& set false, or on the very last router in a configuration, because the
16837 value that is used is taken from the last router that is considered. This
16838 includes a router that is skipped because its preconditions are not met, as
16839 well as a router that declines. For example, using the default configuration,
16840 you could put:
16841 .code
16842 cannot_route_message = Remote domain not found in DNS
16843 .endd
16844 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16845 and
16846 .code
16847 cannot_route_message = Unknown local user
16848 .endd
16849 on the final router that checks for local users. If string expansion fails for
16850 this option, the default message is used. Unless the expansion failure was
16851 explicitly forced, a message about the failure is written to the main and panic
16852 logs, in addition to the normal message about the routing failure.
16853
16854
16855 .option caseful_local_part routers boolean false
16856 .cindex "case of local parts"
16857 .cindex "router" "case of local parts"
16858 By default, routers handle the local parts of addresses in a case-insensitive
16859 manner, though the actual case is preserved for transmission with the message.
16860 If you want the case of letters to be significant in a router, you must set
16861 this option true. For individual router options that contain address or local
16862 part lists (for example, &%local_parts%&), case-sensitive matching can be
16863 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16864 more details.
16865
16866 .vindex "&$local_part$&"
16867 .vindex "&$original_local_part$&"
16868 .vindex "&$parent_local_part$&"
16869 The value of the &$local_part$& variable is forced to lower case while a
16870 router is running unless &%caseful_local_part%& is set. When a router assigns
16871 an address to a transport, the value of &$local_part$& when the transport runs
16872 is the same as it was in the router. Similarly, when a router generates child
16873 addresses by aliasing or forwarding, the values of &$original_local_part$&
16874 and &$parent_local_part$& are those that were used by the redirecting router.
16875
16876 This option applies to the processing of an address by a router. When a
16877 recipient address is being processed in an ACL, there is a separate &%control%&
16878 modifier that can be used to specify case-sensitive processing within the ACL
16879 (see section &<<SECTcontrols>>&).
16880
16881
16882
16883 .option check_local_user routers&!? boolean false
16884 .cindex "local user, checking in router"
16885 .cindex "router" "checking for local user"
16886 .cindex "&_/etc/passwd_&"
16887 .vindex "&$home$&"
16888 When this option is true, Exim checks that the local part of the recipient
16889 address (with affixes removed if relevant) is the name of an account on the
16890 local system. The check is done by calling the &[getpwnam()]& function rather
16891 than trying to read &_/etc/passwd_& directly. This means that other methods of
16892 holding password data (such as NIS) are supported. If the local part is a local
16893 user, &$home$& is set from the password data, and can be tested in other
16894 preconditions that are evaluated after this one (the order of evaluation is
16895 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16896 overridden by &%router_home_directory%&. If the local part is not a local user,
16897 the router is skipped.
16898
16899 If you want to check that the local part is either the name of a local user
16900 or matches something else, you cannot combine &%check_local_user%& with a
16901 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16902 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16903 setting to achieve this. For example:
16904 .code
16905 local_parts = passwd;$local_part : lsearch;/etc/other/users
16906 .endd
16907 Note, however, that the side effects of &%check_local_user%& (such as setting
16908 up a home directory) do not occur when a &(passwd)& lookup is used in a
16909 &%local_parts%& (or any other) precondition.
16910
16911
16912
16913 .option condition routers&!? string&!! unset
16914 .cindex "router" "customized precondition"
16915 This option specifies a general precondition test that has to succeed for the
16916 router to be called. The &%condition%& option is the last precondition to be
16917 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16918 result is a forced failure, or an empty string, or one of the strings &"0"& or
16919 &"no"& or &"false"& (checked without regard to the case of the letters), the
16920 router is skipped, and the address is offered to the next one.
16921
16922 If the result is any other value, the router is run (as this is the last
16923 precondition to be evaluated, all the other preconditions must be true).
16924
16925 This option is unusual in that multiple &%condition%& options may be present.
16926 All &%condition%& options must succeed.
16927
16928 The &%condition%& option provides a means of applying custom conditions to the
16929 running of routers. Note that in the case of a simple conditional expansion,
16930 the default expansion values are exactly what is wanted. For example:
16931 .code
16932 condition = ${if >{$message_age}{600}}
16933 .endd
16934 Because of the default behaviour of the string expansion, this is equivalent to
16935 .code
16936 condition = ${if >{$message_age}{600}{true}{}}
16937 .endd
16938
16939 A multiple condition example, which succeeds:
16940 .code
16941 condition = ${if >{$message_age}{600}}
16942 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16943 condition = foobar
16944 .endd
16945
16946 If the expansion fails (other than forced failure) delivery is deferred. Some
16947 of the other precondition options are common special cases that could in fact
16948 be specified using &%condition%&.
16949
16950 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16951 are far older, and use one set of semantics.  ACLs are newer and when
16952 they were created, the ACL &%condition%& process was given far stricter
16953 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16954 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16955 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16956 Router rules processing behavior.
16957
16958 This is best illustrated in an example:
16959 .code
16960 # If used in an ACL condition will fail with a syntax error, but
16961 # in a router condition any extra characters are treated as a string
16962
16963 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16964 true {yes} {no}}
16965
16966 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16967  {yes} {no}}
16968 .endd
16969 In each example above, the &%if%& statement actually ends after
16970 &"{google.com}}"&.  Since no true or false braces were defined, the
16971 default &%if%& behavior is to return a boolean true or a null answer
16972 (which evaluates to false). The rest of the line is then treated as a
16973 string. So the first example resulted in the boolean answer &"true"&
16974 with the string &" {yes} {no}}"& appended to it. The second example
16975 resulted in the null output (indicating false) with the string
16976 &" {yes} {no}}"& appended to it.
16977
16978 In fact you can put excess forward braces in too.  In the router
16979 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16980 mean something, like after a &"$"& or when required as part of a
16981 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16982 string characters.
16983
16984 Thus, in a Router, the above expansion strings will both always evaluate
16985 true, as the result of expansion is a non-empty string which doesn't
16986 match an explicit false value.  This can be tricky to debug.  By
16987 contrast, in an ACL either of those strings will always result in an
16988 expansion error because the result doesn't look sufficiently boolean.
16989
16990
16991 .option debug_print routers string&!! unset
16992 .cindex "testing" "variables in drivers"
16993 If this option is set and debugging is enabled (see the &%-d%& command line
16994 option) or in address-testing mode (see the &%-bt%& command line option),
16995 the string is expanded and included in the debugging output.
16996 If expansion of the string fails, the error message is written to the debugging
16997 output, and Exim carries on processing.
16998 This option is provided to help with checking out the values of variables and
16999 so on when debugging router configurations. For example, if a &%condition%&
17000 option appears not to be working, &%debug_print%& can be used to output the
17001 variables it references. The output happens after checks for &%domains%&,
17002 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17003 are tested. A newline is added to the text if it does not end with one.
17004 The variable &$router_name$& contains the name of the router.
17005
17006
17007
17008 .option disable_logging routers boolean false
17009 If this option is set true, nothing is logged for any routing errors
17010 or for any deliveries caused by this router. You should not set this option
17011 unless you really, really know what you are doing. See also the generic
17012 transport option of the same name.
17013
17014
17015 .option domains routers&!? "domain list&!!" unset
17016 .cindex "router" "restricting to specific domains"
17017 .vindex "&$domain_data$&"
17018 If this option is set, the router is skipped unless the current domain matches
17019 the list. If the match is achieved by means of a file lookup, the data that the
17020 lookup returned for the domain is placed in &$domain_data$& for use in string
17021 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17022 a list of the order in which preconditions are evaluated.
17023
17024
17025
17026 .option driver routers string unset
17027 This option must always be set. It specifies which of the available routers is
17028 to be used.
17029
17030
17031 .new
17032 .option dsn_lasthop routers boolean false
17033 .cindex "DSN" "success"
17034 .cindex "Delivery Status Notification" "success"
17035 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17036 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17037 instead send a success DSN as if the next hop does not support DSN.
17038 Not effective on redirect routers.
17039 .wen
17040
17041
17042
17043 .option errors_to routers string&!! unset
17044 .cindex "envelope sender"
17045 .cindex "router" "changing address for errors"
17046 If a router successfully handles an address, it may assign the address to a
17047 transport for delivery or it may generate child addresses. In both cases, if
17048 there is a delivery problem during later processing, the resulting bounce
17049 message is sent to the address that results from expanding this string,
17050 provided that the address verifies successfully. The &%errors_to%& option is
17051 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17052
17053 The &%errors_to%& setting associated with an address can be overridden if it
17054 subsequently passes through other routers that have their own &%errors_to%&
17055 settings, or if the message is delivered by a transport with a &%return_path%&
17056 setting.
17057
17058 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17059 the expansion fails to verify, the errors address associated with the incoming
17060 address is used. At top level, this is the envelope sender. A non-forced
17061 expansion failure causes delivery to be deferred.
17062
17063 If an address for which &%errors_to%& has been set ends up being delivered over
17064 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17065 any bounces that are generated by other MTAs on the delivery route are also
17066 sent there. You can set &%errors_to%& to the empty string by either of these
17067 settings:
17068 .code
17069 errors_to =
17070 errors_to = ""
17071 .endd
17072 An expansion item that yields an empty string has the same effect. If you do
17073 this, a locally detected delivery error for addresses processed by this router
17074 no longer gives rise to a bounce message; the error is discarded. If the
17075 address is delivered to a remote host, the return path is set to &`<>`&, unless
17076 overridden by the &%return_path%& option on the transport.
17077
17078 .vindex "&$address_data$&"
17079 If for some reason you want to discard local errors, but use a non-empty
17080 MAIL command for remote delivery, you can preserve the original return
17081 path in &$address_data$& in the router, and reinstate it in the transport by
17082 setting &%return_path%&.
17083
17084 The most common use of &%errors_to%& is to direct mailing list bounces to the
17085 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17086 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17087
17088
17089
17090 .option expn routers&!? boolean true
17091 .cindex "address" "testing"
17092 .cindex "testing" "addresses"
17093 .cindex "EXPN" "router skipping"
17094 .cindex "router" "skipping for EXPN"
17095 If this option is turned off, the router is skipped when testing an address
17096 as a result of processing an SMTP EXPN command. You might, for example,
17097 want to turn it off on a router for users' &_.forward_& files, while leaving it
17098 on for the system alias file.
17099 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17100 are evaluated.
17101
17102 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17103 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17104 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17105
17106
17107
17108 .option fail_verify routers boolean false
17109 .cindex "router" "forcing verification failure"
17110 Setting this option has the effect of setting both &%fail_verify_sender%& and
17111 &%fail_verify_recipient%& to the same value.
17112
17113
17114
17115 .option fail_verify_recipient routers boolean false
17116 If this option is true and an address is accepted by this router when
17117 verifying a recipient, verification fails.
17118
17119
17120
17121 .option fail_verify_sender routers boolean false
17122 If this option is true and an address is accepted by this router when
17123 verifying a sender, verification fails.
17124
17125
17126
17127 .option fallback_hosts routers "string list" unset
17128 .cindex "router" "fallback hosts"
17129 .cindex "fallback" "hosts specified on router"
17130 String expansion is not applied to this option. The argument must be a
17131 colon-separated list of host names or IP addresses. The list separator can be
17132 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17133 each name or address. In fact, the format of each item is exactly the same as
17134 defined for the list of hosts in a &(manualroute)& router (see section
17135 &<<SECTformatonehostitem>>&).
17136
17137 If a router queues an address for a remote transport, this host list is
17138 associated with the address, and used instead of the transport's fallback host
17139 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17140 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17141 transport for further details.
17142
17143
17144 .option group routers string&!! "see below"
17145 .cindex "gid (group id)" "local delivery"
17146 .cindex "local transports" "uid and gid"
17147 .cindex "transport" "local"
17148 .cindex "router" "setting group"
17149 When a router queues an address for a transport, and the transport does not
17150 specify a group, the group given here is used when running the delivery
17151 process.
17152 The group may be specified numerically or by name. If expansion fails, the
17153 error is logged and delivery is deferred.
17154 The default is unset, unless &%check_local_user%& is set, when the default
17155 is taken from the password information. See also &%initgroups%& and &%user%&
17156 and the discussion in chapter &<<CHAPenvironment>>&.
17157
17158
17159
17160 .option headers_add routers list&!! unset
17161 .cindex "header lines" "adding"
17162 .cindex "router" "adding header lines"
17163 This option specifies a list of text headers,
17164 .new
17165 newline-separated (by default, changeable in the usual way),
17166 .wen
17167 that is associated with any addresses that are accepted by the router.
17168 Each item is separately expanded, at routing time.  However, this
17169 option has no effect when an address is just being verified. The way in which
17170 the text is used to add header lines at transport time is described in section
17171 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17172 message is in the process of being transported. This means that references to
17173 header lines in string expansions in the transport's configuration do not
17174 &"see"& the added header lines.
17175
17176 The &%headers_add%& option is expanded after &%errors_to%&, but before
17177 &%headers_remove%& and &%transport%&. If an item is empty, or if
17178 an item expansion is forced to fail, the item has no effect. Other expansion
17179 failures are treated as configuration errors.
17180
17181 Unlike most options, &%headers_add%& can be specified multiple times
17182 for a router; all listed headers are added.
17183
17184 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17185 router that has the &%one_time%& option set.
17186
17187 .cindex "duplicate addresses"
17188 .oindex "&%unseen%&"
17189 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17190 additions are deleted when the address is passed on to subsequent routers.
17191 For a &%redirect%& router, if a generated address is the same as the incoming
17192 address, this can lead to duplicate addresses with different header
17193 modifications. Exim does not do duplicate deliveries (except, in certain
17194 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17195 which of the duplicates is discarded, so this ambiguous situation should be
17196 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17197
17198
17199
17200 .option headers_remove routers list&!! unset
17201 .cindex "header lines" "removing"
17202 .cindex "router" "removing header lines"
17203 This option specifies a list of text headers,
17204 .new
17205 colon-separated (by default, changeable in the usual way),
17206 .wen
17207 that is associated with any addresses that are accepted by the router.
17208 Each item is separately expanded, at routing time.  However, this
17209 option has no effect when an address is just being verified. The way in which
17210 the text is used to remove header lines at transport time is described in
17211 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17212 the message is in the process of being transported. This means that references
17213 to header lines in string expansions in the transport's configuration still
17214 &"see"& the original header lines.
17215
17216 The &%headers_remove%& option is expanded after &%errors_to%& and
17217 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17218 the item has no effect. Other expansion failures are treated as configuration
17219 errors.
17220
17221 Unlike most options, &%headers_remove%& can be specified multiple times
17222 for a router; all listed headers are removed.
17223
17224 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17225 router that has the &%one_time%& option set.
17226
17227 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17228 removal requests are deleted when the address is passed on to subsequent
17229 routers, and this can lead to problems with duplicates -- see the similar
17230 warning for &%headers_add%& above.
17231
17232
17233 .option ignore_target_hosts routers "host list&!!" unset
17234 .cindex "IP address" "discarding"
17235 .cindex "router" "discarding IP addresses"
17236 Although this option is a host list, it should normally contain IP address
17237 entries rather than names. If any host that is looked up by the router has an
17238 IP address that matches an item in this list, Exim behaves as if that IP
17239 address did not exist. This option allows you to cope with rogue DNS entries
17240 like
17241 .code
17242 remote.domain.example.  A  127.0.0.1
17243 .endd
17244 by setting
17245 .code
17246 ignore_target_hosts = 127.0.0.1
17247 .endd
17248 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17249 discarded in this way, the router declines. In a conventional configuration, an
17250 attempt to mail to such a domain would normally provoke the &"unrouteable
17251 domain"& error, and an attempt to verify an address in the domain would fail.
17252 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17253 router declines if presented with one of the listed addresses.
17254
17255 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17256 means of the first or the second of the following settings, respectively:
17257 .code
17258 ignore_target_hosts = 0.0.0.0/0
17259 ignore_target_hosts = <; 0::0/0
17260 .endd
17261 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17262 in the second line matches all IPv6 addresses.
17263
17264 This option may also be useful for ignoring link-local and site-local IPv6
17265 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17266 is expanded before use as a list, it is possible to make it dependent on the
17267 domain that is being routed.
17268
17269 .vindex "&$host_address$&"
17270 During its expansion, &$host_address$& is set to the IP address that is being
17271 checked.
17272
17273 .option initgroups routers boolean false
17274 .cindex "additional groups"
17275 .cindex "groups" "additional"
17276 .cindex "local transports" "uid and gid"
17277 .cindex "transport" "local"
17278 If the router queues an address for a transport, and this option is true, and
17279 the uid supplied by the router is not overridden by the transport, the
17280 &[initgroups()]& function is called when running the transport to ensure that
17281 any additional groups associated with the uid are set up. See also &%group%&
17282 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17283
17284
17285
17286 .option local_part_prefix routers&!? "string list" unset
17287 .cindex "router" "prefix for local part"
17288 .cindex "prefix" "for local part, used in router"
17289 If this option is set, the router is skipped unless the local part starts with
17290 one of the given strings, or &%local_part_prefix_optional%& is true. See
17291 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17292 evaluated.
17293
17294 The list is scanned from left to right, and the first prefix that matches is
17295 used. A limited form of wildcard is available; if the prefix begins with an
17296 asterisk, it matches the longest possible sequence of arbitrary characters at
17297 the start of the local part. An asterisk should therefore always be followed by
17298 some character that does not occur in normal local parts.
17299 .cindex "multiple mailboxes"
17300 .cindex "mailbox" "multiple"
17301 Wildcarding can be used to set up multiple user mailboxes, as described in
17302 section &<<SECTmulbox>>&.
17303
17304 .vindex "&$local_part$&"
17305 .vindex "&$local_part_prefix$&"
17306 During the testing of the &%local_parts%& option, and while the router is
17307 running, the prefix is removed from the local part, and is available in the
17308 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17309 the router accepts the address, this remains true during subsequent delivery by
17310 a transport. In particular, the local part that is transmitted in the RCPT
17311 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17312 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17313 the relevant transport.
17314
17315 When an address is being verified, &%local_part_prefix%& affects only the
17316 behaviour of the router. If the callout feature of verification is in use, this
17317 means that the full address, including the prefix, will be used during the
17318 callout.
17319
17320 The prefix facility is commonly used to handle local parts of the form
17321 &%owner-something%&. Another common use is to support local parts of the form
17322 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17323 to tell a user their forwarding is broken &-- by placing a router like this one
17324 immediately before the router that handles &_.forward_& files:
17325 .code
17326 real_localuser:
17327   driver = accept
17328   local_part_prefix = real-
17329   check_local_user
17330   transport = local_delivery
17331 .endd
17332 For security, it would probably be a good idea to restrict the use of this
17333 router to locally-generated messages, using a condition such as this:
17334 .code
17335   condition = ${if match {$sender_host_address}\
17336                          {\N^(|127\.0\.0\.1)$\N}}
17337 .endd
17338
17339 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17340 both conditions must be met if not optional. Care must be taken if wildcards
17341 are used in both a prefix and a suffix on the same router. Different
17342 separator characters must be used to avoid ambiguity.
17343
17344
17345 .option local_part_prefix_optional routers boolean false
17346 See &%local_part_prefix%& above.
17347
17348
17349
17350 .option local_part_suffix routers&!? "string list" unset
17351 .cindex "router" "suffix for local part"
17352 .cindex "suffix for local part" "used in router"
17353 This option operates in the same way as &%local_part_prefix%&, except that the
17354 local part must end (rather than start) with the given string, the
17355 &%local_part_suffix_optional%& option determines whether the suffix is
17356 mandatory, and the wildcard * character, if present, must be the last
17357 character of the suffix. This option facility is commonly used to handle local
17358 parts of the form &%something-request%& and multiple user mailboxes of the form
17359 &%username-foo%&.
17360
17361
17362 .option local_part_suffix_optional routers boolean false
17363 See &%local_part_suffix%& above.
17364
17365
17366
17367 .option local_parts routers&!? "local part list&!!" unset
17368 .cindex "router" "restricting to specific local parts"
17369 .cindex "local part" "checking in router"
17370 The router is run only if the local part of the address matches the list.
17371 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17372 are evaluated, and
17373 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17374 string is expanded, it is possible to make it depend on the domain, for
17375 example:
17376 .code
17377 local_parts = dbm;/usr/local/specials/$domain
17378 .endd
17379 .vindex "&$local_part_data$&"
17380 If the match is achieved by a lookup, the data that the lookup returned
17381 for the local part is placed in the variable &$local_part_data$& for use in
17382 expansions of the router's private options. You might use this option, for
17383 example, if you have a large number of local virtual domains, and you want to
17384 send all postmaster mail to the same place without having to set up an alias in
17385 each virtual domain:
17386 .code
17387 postmaster:
17388   driver = redirect
17389   local_parts = postmaster
17390   data = postmaster@real.domain.example
17391 .endd
17392
17393
17394 .option log_as_local routers boolean "see below"
17395 .cindex "log" "delivery line"
17396 .cindex "delivery" "log line format"
17397 Exim has two logging styles for delivery, the idea being to make local
17398 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17399 recipient address is given just as the local part, without a domain. The use of
17400 this style is controlled by this option. It defaults to true for the &(accept)&
17401 router, and false for all the others. This option applies only when a
17402 router assigns an address to a transport. It has no effect on routers that
17403 redirect addresses.
17404
17405
17406
17407 .option more routers boolean&!! true
17408 The result of string expansion for this option must be a valid boolean value,
17409 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17410 result causes an error, and delivery is deferred. If the expansion is forced to
17411 fail, the default value for the option (true) is used. Other failures cause
17412 delivery to be deferred.
17413
17414 If this option is set false, and the router declines to handle the address, no
17415 further routers are tried, routing fails, and the address is bounced.
17416 .oindex "&%self%&"
17417 However, if the router explicitly passes an address to the following router by
17418 means of the setting
17419 .code
17420 self = pass
17421 .endd
17422 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17423 does not affect the behaviour if one of the precondition tests fails. In that
17424 case, the address is always passed to the next router.
17425
17426 Note that &%address_data%& is not considered to be a precondition. If its
17427 expansion is forced to fail, the router declines, and the value of &%more%&
17428 controls what happens next.
17429
17430
17431 .option pass_on_timeout routers boolean false
17432 .cindex "timeout" "of router"
17433 .cindex "router" "timeout"
17434 If a router times out during a host lookup, it normally causes deferral of the
17435 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17436 router, overriding &%no_more%&. This may be helpful for systems that are
17437 intermittently connected to the Internet, or those that want to pass to a smart
17438 host any messages that cannot immediately be delivered.
17439
17440 There are occasional other temporary errors that can occur while doing DNS
17441 lookups. They are treated in the same way as a timeout, and this option
17442 applies to all of them.
17443
17444
17445
17446 .option pass_router routers string unset
17447 .cindex "router" "go to after &""pass""&"
17448 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17449 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17450 routing to continue, and overriding a false setting of &%more%&. When one of
17451 these routers returns &"pass"&, the address is normally handed on to the next
17452 router in sequence. This can be changed by setting &%pass_router%& to the name
17453 of another router. However (unlike &%redirect_router%&) the named router must
17454 be below the current router, to avoid loops. Note that this option applies only
17455 to the special case of &"pass"&. It does not apply when a router returns
17456 &"decline"& because it cannot handle an address.
17457
17458
17459
17460 .option redirect_router routers string unset
17461 .cindex "router" "start at after redirection"
17462 Sometimes an administrator knows that it is pointless to reprocess addresses
17463 generated from alias or forward files with the same router again. For
17464 example, if an alias file translates real names into login ids there is no
17465 point searching the alias file a second time, especially if it is a large file.
17466
17467 The &%redirect_router%& option can be set to the name of any router instance.
17468 It causes the routing of any generated addresses to start at the named router
17469 instead of at the first router. This option has no effect if the router in
17470 which it is set does not generate new addresses.
17471
17472
17473
17474 .option require_files routers&!? "string list&!!" unset
17475 .cindex "file" "requiring for router"
17476 .cindex "router" "requiring file existence"
17477 This option provides a general mechanism for predicating the running of a
17478 router on the existence or non-existence of certain files or directories.
17479 Before running a router, as one of its precondition tests, Exim works its way
17480 through the &%require_files%& list, expanding each item separately.
17481
17482 Because the list is split before expansion, any colons in expansion items must
17483 be doubled, or the facility for using a different list separator must be used.
17484 If any expansion is forced to fail, the item is ignored. Other expansion
17485 failures cause routing of the address to be deferred.
17486
17487 If any expanded string is empty, it is ignored. Otherwise, except as described
17488 below, each string must be a fully qualified file path, optionally preceded by
17489 &"!"&. The paths are passed to the &[stat()]& function to test for the
17490 existence of the files or directories. The router is skipped if any paths not
17491 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17492
17493 .cindex "NFS"
17494 If &[stat()]& cannot determine whether a file exists or not, delivery of
17495 the message is deferred. This can happen when NFS-mounted filesystems are
17496 unavailable.
17497
17498 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17499 options, so you cannot use it to check for the existence of a file in which to
17500 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17501 full list of the order in which preconditions are evaluated.) However, as
17502 these options are all expanded, you can use the &%exists%& expansion condition
17503 to make such tests. The &%require_files%& option is intended for checking files
17504 that the router may be going to use internally, or which are needed by a
17505 transport (for example &_.procmailrc_&).
17506
17507 During delivery, the &[stat()]& function is run as root, but there is a
17508 facility for some checking of the accessibility of a file by another user.
17509 This is not a proper permissions check, but just a &"rough"& check that
17510 operates as follows:
17511
17512 If an item in a &%require_files%& list does not contain any forward slash
17513 characters, it is taken to be the user (and optional group, separated by a
17514 comma) to be checked for subsequent files in the list. If no group is specified
17515 but the user is specified symbolically, the gid associated with the uid is
17516 used. For example:
17517 .code
17518 require_files = mail:/some/file
17519 require_files = $local_part:$home/.procmailrc
17520 .endd
17521 If a user or group name in a &%require_files%& list does not exist, the
17522 &%require_files%& condition fails.
17523
17524 Exim performs the check by scanning along the components of the file path, and
17525 checking the access for the given uid and gid. It checks for &"x"& access on
17526 directories, and &"r"& access on the final file. Note that this means that file
17527 access control lists, if the operating system has them, are ignored.
17528
17529 &*Warning 1*&: When the router is being run to verify addresses for an
17530 incoming SMTP message, Exim is not running as root, but under its own uid. This
17531 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17532 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17533 user is not permitted to read one of the directories on the file's path.
17534
17535 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17536 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17537 without root access. In this case, if a check for access by a particular user
17538 is requested, Exim creates a subprocess that runs as that user, and tries the
17539 check again in that process.
17540
17541 The default action for handling an unresolved EACCES is to consider it to
17542 be caused by a configuration error, and routing is deferred because the
17543 existence or non-existence of the file cannot be determined. However, in some
17544 circumstances it may be desirable to treat this condition as if the file did
17545 not exist. If the file name (or the exclamation mark that precedes the file
17546 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17547 as if the file did not exist. For example:
17548 .code
17549 require_files = +/some/file
17550 .endd
17551 If the router is not an essential part of verification (for example, it
17552 handles users' &_.forward_& files), another solution is to set the &%verify%&
17553 option false so that the router is skipped when verifying.
17554
17555
17556
17557 .option retry_use_local_part routers boolean "see below"
17558 .cindex "hints database" "retry keys"
17559 .cindex "local part" "in retry keys"
17560 When a delivery suffers a temporary routing failure, a retry record is created
17561 in Exim's hints database. For addresses whose routing depends only on the
17562 domain, the key for the retry record should not involve the local part, but for
17563 other addresses, both the domain and the local part should be included.
17564 Usually, remote routing is of the former kind, and local routing is of the
17565 latter kind.
17566
17567 This option controls whether the local part is used to form the key for retry
17568 hints for addresses that suffer temporary errors while being handled by this
17569 router. The default value is true for any router that has &%check_local_user%&
17570 set, and false otherwise. Note that this option does not apply to hints keys
17571 for transport delays; they are controlled by a generic transport option of the
17572 same name.
17573
17574 The setting of &%retry_use_local_part%& applies only to the router on which it
17575 appears. If the router generates child addresses, they are routed
17576 independently; this setting does not become attached to them.
17577
17578
17579
17580 .option router_home_directory routers string&!! unset
17581 .cindex "router" "home directory for"
17582 .cindex "home directory" "for router"
17583 .vindex "&$home$&"
17584 This option sets a home directory for use while the router is running. (Compare
17585 &%transport_home_directory%&, which sets a home directory for later
17586 transporting.) In particular, if used on a &(redirect)& router, this option
17587 sets a value for &$home$& while a filter is running. The value is expanded;
17588 forced expansion failure causes the option to be ignored &-- other failures
17589 cause the router to defer.
17590
17591 Expansion of &%router_home_directory%& happens immediately after the
17592 &%check_local_user%& test (if configured), before any further expansions take
17593 place.
17594 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17595 are evaluated.)
17596 While the router is running, &%router_home_directory%& overrides the value of
17597 &$home$& that came from &%check_local_user%&.
17598
17599 When a router accepts an address and assigns it to a local transport (including
17600 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17601 delivery), the home directory setting for the transport is taken from the first
17602 of these values that is set:
17603
17604 .ilist
17605 The &%home_directory%& option on the transport;
17606 .next
17607 The &%transport_home_directory%& option on the router;
17608 .next
17609 The password data if &%check_local_user%& is set on the router;
17610 .next
17611 The &%router_home_directory%& option on the router.
17612 .endlist
17613
17614 In other words, &%router_home_directory%& overrides the password data for the
17615 router, but not for the transport.
17616
17617
17618
17619 .option self routers string freeze
17620 .cindex "MX record" "pointing to local host"
17621 .cindex "local host" "MX pointing to"
17622 This option applies to those routers that use a recipient address to find a
17623 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17624 and &(manualroute)& routers.
17625 Certain configurations of the &(queryprogram)& router can also specify a list
17626 of remote hosts.
17627 Usually such routers are configured to send the message to a remote host via an
17628 &(smtp)& transport. The &%self%& option specifies what happens when the first
17629 host on the list turns out to be the local host.
17630 The way in which Exim checks for the local host is described in section
17631 &<<SECTreclocipadd>>&.
17632
17633 Normally this situation indicates either an error in Exim's configuration (for
17634 example, the router should be configured not to process this domain), or an
17635 error in the DNS (for example, the MX should not point to this host). For this
17636 reason, the default action is to log the incident, defer the address, and
17637 freeze the message. The following alternatives are provided for use in special
17638 cases:
17639
17640 .vlist
17641 .vitem &%defer%&
17642 Delivery of the message is tried again later, but the message is not frozen.
17643
17644 .vitem "&%reroute%&: <&'domain'&>"
17645 The domain is changed to the given domain, and the address is passed back to
17646 be reprocessed by the routers. No rewriting of headers takes place. This
17647 behaviour is essentially a redirection.
17648
17649 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17650 The domain is changed to the given domain, and the address is passed back to be
17651 reprocessed by the routers. Any headers that contain the original domain are
17652 rewritten.
17653
17654 .vitem &%pass%&
17655 .oindex "&%more%&"
17656 .vindex "&$self_hostname$&"
17657 The router passes the address to the next router, or to the router named in the
17658 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17659 subsequent routing and delivery, the variable &$self_hostname$& contains the
17660 name of the local host that the router encountered. This can be used to
17661 distinguish between different cases for hosts with multiple names. The
17662 combination
17663 .code
17664 self = pass
17665 no_more
17666 .endd
17667 ensures that only those addresses that routed to the local host are passed on.
17668 Without &%no_more%&, addresses that were declined for other reasons would also
17669 be passed to the next router.
17670
17671 .vitem &%fail%&
17672 Delivery fails and an error report is generated.
17673
17674 .vitem &%send%&
17675 .cindex "local host" "sending to"
17676 The anomaly is ignored and the address is queued for the transport. This
17677 setting should be used with extreme caution. For an &(smtp)& transport, it
17678 makes sense only in cases where the program that is listening on the SMTP port
17679 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17680 different configuration file that handles the domain in another way.
17681 .endlist
17682
17683
17684
17685 .option senders routers&!? "address list&!!" unset
17686 .cindex "router" "checking senders"
17687 If this option is set, the router is skipped unless the message's sender
17688 address matches something on the list.
17689 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17690 are evaluated.
17691
17692 There are issues concerning verification when the running of routers is
17693 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17694 setting, it sets the sender to the null string. When using the &%-bt%& option
17695 to check a configuration file, it is necessary also to use the &%-f%& option to
17696 set an appropriate sender. For incoming mail, the sender is unset when
17697 verifying the sender, but is available when verifying any recipients. If the
17698 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17699 matters.
17700
17701
17702 .option translate_ip_address routers string&!! unset
17703 .cindex "IP address" "translating"
17704 .cindex "packet radio"
17705 .cindex "router" "IP address translation"
17706 There exist some rare networking situations (for example, packet radio) where
17707 it is helpful to be able to translate IP addresses generated by normal routing
17708 mechanisms into other IP addresses, thus performing a kind of manual IP
17709 routing. This should be done only if the normal IP routing of the TCP/IP stack
17710 is inadequate or broken. Because this is an extremely uncommon requirement, the
17711 code to support this option is not included in the Exim binary unless
17712 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17713
17714 .vindex "&$host_address$&"
17715 The &%translate_ip_address%& string is expanded for every IP address generated
17716 by the router, with the generated address set in &$host_address$&. If the
17717 expansion is forced to fail, no action is taken.
17718 For any other expansion error, delivery of the message is deferred.
17719 If the result of the expansion is an IP address, that replaces the original
17720 address; otherwise the result is assumed to be a host name &-- this is looked
17721 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17722 produce one or more replacement IP addresses. For example, to subvert all IP
17723 addresses in some specific networks, this could be added to a router:
17724 .code
17725 translate_ip_address = \
17726   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17727     {$value}fail}}
17728 .endd
17729 The file would contain lines like
17730 .code
17731 10.2.3.128/26    some.host
17732 10.8.4.34/26     10.44.8.15
17733 .endd
17734 You should not make use of this facility unless you really understand what you
17735 are doing.
17736
17737
17738
17739 .option transport routers string&!! unset
17740 This option specifies the transport to be used when a router accepts an address
17741 and sets it up for delivery. A transport is never needed if a router is used
17742 only for verification. The value of the option is expanded at routing time,
17743 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17744 and result must be the name of one of the configured transports. If it is not,
17745 delivery is deferred.
17746
17747 The &%transport%& option is not used by the &(redirect)& router, but it does
17748 have some private options that set up transports for pipe and file deliveries
17749 (see chapter &<<CHAPredirect>>&).
17750
17751
17752
17753 .option transport_current_directory routers string&!! unset
17754 .cindex "current directory for local transport"
17755 This option associates a current directory with any address that is routed
17756 to a local transport. This can happen either because a transport is
17757 explicitly configured for the router, or because it generates a delivery to a
17758 file or a pipe. During the delivery process (that is, at transport time), this
17759 option string is expanded and is set as the current directory, unless
17760 overridden by a setting on the transport.
17761 If the expansion fails for any reason, including forced failure, an error is
17762 logged, and delivery is deferred.
17763 See chapter &<<CHAPenvironment>>& for details of the local delivery
17764 environment.
17765
17766
17767
17768
17769 .option transport_home_directory routers string&!! "see below"
17770 .cindex "home directory" "for local transport"
17771 This option associates a home directory with any address that is routed to a
17772 local transport. This can happen either because a transport is explicitly
17773 configured for the router, or because it generates a delivery to a file or a
17774 pipe. During the delivery process (that is, at transport time), the option
17775 string is expanded and is set as the home directory, unless overridden by a
17776 setting of &%home_directory%& on the transport.
17777 If the expansion fails for any reason, including forced failure, an error is
17778 logged, and delivery is deferred.
17779
17780 If the transport does not specify a home directory, and
17781 &%transport_home_directory%& is not set for the router, the home directory for
17782 the transport is taken from the password data if &%check_local_user%& is set for
17783 the router. Otherwise it is taken from &%router_home_directory%& if that option
17784 is set; if not, no home directory is set for the transport.
17785
17786 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17787 environment.
17788
17789
17790
17791
17792 .option unseen routers boolean&!! false
17793 .cindex "router" "carrying on after success"
17794 The result of string expansion for this option must be a valid boolean value,
17795 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17796 result causes an error, and delivery is deferred. If the expansion is forced to
17797 fail, the default value for the option (false) is used. Other failures cause
17798 delivery to be deferred.
17799
17800 When this option is set true, routing does not cease if the router accepts the
17801 address. Instead, a copy of the incoming address is passed to the next router,
17802 overriding a false setting of &%more%&. There is little point in setting
17803 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17804 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17805 sometimes true and sometimes false).
17806
17807 .cindex "copy of message (&%unseen%& option)"
17808 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17809 qualifier in filter files. It can be used to cause copies of messages to be
17810 delivered to some other destination, while also carrying out a normal delivery.
17811 In effect, the current address is made into a &"parent"& that has two children
17812 &-- one that is delivered as specified by this router, and a clone that goes on
17813 to be routed further. For this reason, &%unseen%& may not be combined with the
17814 &%one_time%& option in a &(redirect)& router.
17815
17816 &*Warning*&: Header lines added to the address (or specified for removal) by
17817 this router or by previous routers affect the &"unseen"& copy of the message
17818 only. The clone that continues to be processed by further routers starts with
17819 no added headers and none specified for removal. For a &%redirect%& router, if
17820 a generated address is the same as the incoming address, this can lead to
17821 duplicate addresses with different header modifications. Exim does not do
17822 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17823 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17824 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17825 &%redirect%& router may be of help.
17826
17827 Unlike the handling of header modifications, any data that was set by the
17828 &%address_data%& option in the current or previous routers &'is'& passed on to
17829 subsequent routers.
17830
17831
17832 .option user routers string&!! "see below"
17833 .cindex "uid (user id)" "local delivery"
17834 .cindex "local transports" "uid and gid"
17835 .cindex "transport" "local"
17836 .cindex "router" "user for filter processing"
17837 .cindex "filter" "user for processing"
17838 When a router queues an address for a transport, and the transport does not
17839 specify a user, the user given here is used when running the delivery process.
17840 The user may be specified numerically or by name. If expansion fails, the
17841 error is logged and delivery is deferred.
17842 This user is also used by the &(redirect)& router when running a filter file.
17843 The default is unset, except when &%check_local_user%& is set. In this case,
17844 the default is taken from the password information. If the user is specified as
17845 a name, and &%group%& is not set, the group associated with the user is used.
17846 See also &%initgroups%& and &%group%& and the discussion in chapter
17847 &<<CHAPenvironment>>&.
17848
17849
17850
17851 .option verify routers&!? boolean true
17852 Setting this option has the effect of setting &%verify_sender%& and
17853 &%verify_recipient%& to the same value.
17854
17855
17856 .option verify_only routers&!? boolean false
17857 .cindex "EXPN" "with &%verify_only%&"
17858 .oindex "&%-bv%&"
17859 .cindex "router" "used only when verifying"
17860 If this option is set, the router is used only when verifying an address,
17861 delivering in cutthrough mode or
17862 testing with the &%-bv%& option, not when actually doing a delivery, testing
17863 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17864 restricted to verifying only senders or recipients by means of
17865 &%verify_sender%& and &%verify_recipient%&.
17866
17867 &*Warning*&: When the router is being run to verify addresses for an incoming
17868 SMTP message, Exim is not running as root, but under its own uid. If the router
17869 accesses any files, you need to make sure that they are accessible to the Exim
17870 user or group.
17871
17872
17873 .option verify_recipient routers&!? boolean true
17874 If this option is false, the router is skipped when verifying recipient
17875 addresses,
17876 delivering in cutthrough mode
17877 or testing recipient verification using &%-bv%&.
17878 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17879 are evaluated.
17880 See also the &$verify_mode$& variable.
17881
17882
17883 .option verify_sender routers&!? boolean true
17884 If this option is false, the router is skipped when verifying sender addresses
17885 or testing sender verification using &%-bvs%&.
17886 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17887 are evaluated.
17888 See also the &$verify_mode$& variable.
17889 .ecindex IIDgenoprou1
17890 .ecindex IIDgenoprou2
17891
17892
17893
17894
17895
17896
17897 . ////////////////////////////////////////////////////////////////////////////
17898 . ////////////////////////////////////////////////////////////////////////////
17899
17900 .chapter "The accept router" "CHID4"
17901 .cindex "&(accept)& router"
17902 .cindex "routers" "&(accept)&"
17903 The &(accept)& router has no private options of its own. Unless it is being
17904 used purely for verification (see &%verify_only%&) a transport is required to
17905 be defined by the generic &%transport%& option. If the preconditions that are
17906 specified by generic options are met, the router accepts the address and queues
17907 it for the given transport. The most common use of this router is for setting
17908 up deliveries to local mailboxes. For example:
17909 .code
17910 localusers:
17911   driver = accept
17912   domains = mydomain.example
17913   check_local_user
17914   transport = local_delivery
17915 .endd
17916 The &%domains%& condition in this example checks the domain of the address, and
17917 &%check_local_user%& checks that the local part is the login of a local user.
17918 When both preconditions are met, the &(accept)& router runs, and queues the
17919 address for the &(local_delivery)& transport.
17920
17921
17922
17923
17924
17925
17926 . ////////////////////////////////////////////////////////////////////////////
17927 . ////////////////////////////////////////////////////////////////////////////
17928
17929 .chapter "The dnslookup router" "CHAPdnslookup"
17930 .scindex IIDdnsrou1 "&(dnslookup)& router"
17931 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17932 The &(dnslookup)& router looks up the hosts that handle mail for the
17933 recipient's domain in the DNS. A transport must always be set for this router,
17934 unless &%verify_only%& is set.
17935
17936 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17937 SRV records. If none are found, or if SRV support is not configured,
17938 MX records are looked up. If no MX records exist, address records are sought.
17939 However, &%mx_domains%& can be set to disable the direct use of address
17940 records.
17941
17942 MX records of equal priority are sorted by Exim into a random order. Exim then
17943 looks for address records for the host names obtained from MX or SRV records.
17944 When a host has more than one IP address, they are sorted into a random order,
17945 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17946 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17947 generic option, the router declines.
17948
17949 Unless they have the highest priority (lowest MX value), MX records that point
17950 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17951 are discarded, together with any other MX records of equal or lower priority.
17952
17953 .cindex "MX record" "pointing to local host"
17954 .cindex "local host" "MX pointing to"
17955 .oindex "&%self%&" "in &(dnslookup)& router"
17956 If the host pointed to by the highest priority MX record, or looked up as an
17957 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17958 happens is controlled by the generic &%self%& option.
17959
17960
17961 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17962 There have been problems with DNS servers when SRV records are looked up.
17963 Some mis-behaving servers return a DNS error or timeout when a non-existent
17964 SRV record is sought. Similar problems have in the past been reported for
17965 MX records. The global &%dns_again_means_nonexist%& option can help with this
17966 problem, but it is heavy-handed because it is a global option.
17967
17968 For this reason, there are two options, &%srv_fail_domains%& and
17969 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17970 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17971 an attempt to look up an SRV or MX record causes one of these results, and the
17972 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17973 such record"&. In the case of an SRV lookup, this means that the router
17974 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17975 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17976 case routing fails.
17977
17978
17979 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17980 .cindex "&(dnslookup)& router" "declines"
17981 There are a few cases where a &(dnslookup)& router will decline to accept
17982 an address; if such a router is expected to handle "all remaining non-local
17983 domains", then it is important to set &%no_more%&.
17984
17985 Reasons for a &(dnslookup)& router to decline currently include:
17986 .ilist
17987 The domain does not exist in DNS
17988 .next
17989 The domain exists but the MX record's host part is just "."; this is a common
17990 convention (borrowed from SRV) used to indicate that there is no such service
17991 for this domain and to not fall back to trying A/AAAA records.
17992 .next
17993 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17994 .next
17995 MX record points to a non-existent host.
17996 .next
17997 MX record points to an IP address and the main section option
17998 &%allow_mx_to_ip%& is not set.
17999 .next
18000 MX records exist and point to valid hosts, but all hosts resolve only to
18001 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18002 .next
18003 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18004 &%dns_check_names_pattern%& for handling one variant of this)
18005 .next
18006 &%check_secondary_mx%& is set on this router but the local host can
18007 not be found in the MX records (see below)
18008 .endlist
18009
18010
18011
18012
18013 .section "Private options for dnslookup" "SECID118"
18014 .cindex "options" "&(dnslookup)& router"
18015 The private options for the &(dnslookup)& router are as follows:
18016
18017 .option check_secondary_mx dnslookup boolean false
18018 .cindex "MX record" "checking for secondary"
18019 If this option is set, the router declines unless the local host is found in
18020 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18021 process domains for which the local host is a secondary mail exchanger
18022 differently to other domains. The way in which Exim decides whether a host is
18023 the local host is described in section &<<SECTreclocipadd>>&.
18024
18025
18026 .option check_srv dnslookup string&!! unset
18027 .cindex "SRV record" "enabling use of"
18028 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18029 addition to MX and address records. The support is disabled by default. To
18030 enable SRV support, set the &%check_srv%& option to the name of the service
18031 required. For example,
18032 .code
18033 check_srv = smtp
18034 .endd
18035 looks for SRV records that refer to the normal smtp service. The option is
18036 expanded, so the service name can vary from message to message or address
18037 to address. This might be helpful if SRV records are being used for a
18038 submission service. If the expansion is forced to fail, the &%check_srv%&
18039 option is ignored, and the router proceeds to look for MX records in the
18040 normal way.
18041
18042 When the expansion succeeds, the router searches first for SRV records for
18043 the given service (it assumes TCP protocol). A single SRV record with a
18044 host name that consists of just a single dot indicates &"no such service for
18045 this domain"&; if this is encountered, the router declines. If other kinds of
18046 SRV record are found, they are used to construct a host list for delivery
18047 according to the rules of RFC 2782. MX records are not sought in this case.
18048
18049 When no SRV records are found, MX records (and address records) are sought in
18050 the traditional way. In other words, SRV records take precedence over MX
18051 records, just as MX records take precedence over address records. Note that
18052 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18053 defined it. It is apparently believed that MX records are sufficient for email
18054 and that SRV records should not be used for this purpose. However, SRV records
18055 have an additional &"weight"& feature which some people might find useful when
18056 trying to split an SMTP load between hosts of different power.
18057
18058 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18059 when there is a DNS lookup error.
18060
18061
18062
18063 .option dnssec_request_domains dnslookup "domain list&!!" unset
18064 .cindex "MX record" "security"
18065 .cindex "DNSSEC" "MX lookup"
18066 .cindex "security" "MX lookup"
18067 .cindex "DNS" "DNSSEC"
18068 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18069 the dnssec request bit set.
18070 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18071
18072
18073
18074 .option dnssec_require_domains dnslookup "domain list&!!" unset
18075 .cindex "MX record" "security"
18076 .cindex "DNSSEC" "MX lookup"
18077 .cindex "security" "MX lookup"
18078 .cindex "DNS" "DNSSEC"
18079 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18080 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18081 (AD bit) set wil be ignored and logged as a host-lookup failure.
18082 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18083
18084
18085
18086 .option mx_domains dnslookup "domain list&!!" unset
18087 .cindex "MX record" "required to exist"
18088 .cindex "SRV record" "required to exist"
18089 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18090 record in order to be recognized. (The name of this option could be improved.)
18091 For example, if all the mail hosts in &'fict.example'& are known to have MX
18092 records, except for those in &'discworld.fict.example'&, you could use this
18093 setting:
18094 .code
18095 mx_domains = ! *.discworld.fict.example : *.fict.example
18096 .endd
18097 This specifies that messages addressed to a domain that matches the list but
18098 has no MX record should be bounced immediately instead of being routed using
18099 the address record.
18100
18101
18102 .option mx_fail_domains dnslookup "domain list&!!" unset
18103 If the DNS lookup for MX records for one of the domains in this list causes a
18104 DNS lookup error, Exim behaves as if no MX records were found. See section
18105 &<<SECTprowitdnsloo>>& for more discussion.
18106
18107
18108
18109
18110 .option qualify_single dnslookup boolean true
18111 .cindex "DNS" "resolver options"
18112 .cindex "DNS" "qualifying single-component names"
18113 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18114 lookups. Typically, but not standardly, this causes the resolver to qualify
18115 single-component names with the default domain. For example, on a machine
18116 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18117 &'thesaurus.ref.example'& inside the resolver. For details of what your
18118 resolver actually does, consult your man pages for &'resolver'& and
18119 &'resolv.conf'&.
18120
18121
18122
18123 .option rewrite_headers dnslookup boolean true
18124 .cindex "rewriting" "header lines"
18125 .cindex "header lines" "rewriting"
18126 If the domain name in the address that is being processed is not fully
18127 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18128 an address is specified as &'dormouse@teaparty'&, the domain might be
18129 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18130 occur as a result of setting the &%widen_domains%& option. If
18131 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18132 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18133 header lines of the message are rewritten with the full domain name.
18134
18135 This option should be turned off only when it is known that no message is
18136 ever going to be sent outside an environment where the abbreviation makes
18137 sense.
18138
18139 When an MX record is looked up in the DNS and matches a wildcard record, name
18140 servers normally return a record containing the name that has been looked up,
18141 making it impossible to detect whether a wildcard was present or not. However,
18142 some name servers have recently been seen to return the wildcard entry. If the
18143 name returned by a DNS lookup begins with an asterisk, it is not used for
18144 header rewriting.
18145
18146
18147 .option same_domain_copy_routing dnslookup boolean false
18148 .cindex "address" "copying routing"
18149 Addresses with the same domain are normally routed by the &(dnslookup)& router
18150 to the same list of hosts. However, this cannot be presumed, because the router
18151 options and preconditions may refer to the local part of the address. By
18152 default, therefore, Exim routes each address in a message independently. DNS
18153 servers run caches, so repeated DNS lookups are not normally expensive, and in
18154 any case, personal messages rarely have more than a few recipients.
18155
18156 If you are running mailing lists with large numbers of subscribers at the same
18157 domain, and you are using a &(dnslookup)& router which is independent of the
18158 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18159 lookups for identical domains in one message. In this case, when &(dnslookup)&
18160 routes an address to a remote transport, any other unrouted addresses in the
18161 message that have the same domain are automatically given the same routing
18162 without processing them independently,
18163 provided the following conditions are met:
18164
18165 .ilist
18166 No router that processed the address specified &%headers_add%& or
18167 &%headers_remove%&.
18168 .next
18169 The router did not change the address in any way, for example, by &"widening"&
18170 the domain.
18171 .endlist
18172
18173
18174
18175
18176 .option search_parents dnslookup boolean false
18177 .cindex "DNS" "resolver options"
18178 When this option is true, the resolver option RES_DNSRCH is set for DNS
18179 lookups. This is different from the &%qualify_single%& option in that it
18180 applies to domains containing dots. Typically, but not standardly, it causes
18181 the resolver to search for the name in the current domain and in parent
18182 domains. For example, on a machine in the &'fict.example'& domain, if looking
18183 up &'teaparty.wonderland'& failed, the resolver would try
18184 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18185 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18186
18187 Setting this option true can cause problems in domains that have a wildcard MX
18188 record, because any domain that does not have its own MX record matches the
18189 local wildcard.
18190
18191
18192
18193 .option srv_fail_domains dnslookup "domain list&!!" unset
18194 If the DNS lookup for SRV records for one of the domains in this list causes a
18195 DNS lookup error, Exim behaves as if no SRV records were found. See section
18196 &<<SECTprowitdnsloo>>& for more discussion.
18197
18198
18199
18200
18201 .option widen_domains dnslookup "string list" unset
18202 .cindex "domain" "partial; widening"
18203 If a DNS lookup fails and this option is set, each of its strings in turn is
18204 added onto the end of the domain, and the lookup is tried again. For example,
18205 if
18206 .code
18207 widen_domains = fict.example:ref.example
18208 .endd
18209 is set and a lookup of &'klingon.dictionary'& fails,
18210 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18211 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18212 and &%search_parents%& options can cause some widening to be undertaken inside
18213 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18214 when verifying, unless &%rewrite_headers%& is false (not the default).
18215
18216
18217 .section "Effect of qualify_single and search_parents" "SECID119"
18218 When a domain from an envelope recipient is changed by the resolver as a result
18219 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18220 corresponding address in the message's header lines unless &%rewrite_headers%&
18221 is set false. Exim then re-routes the address, using the full domain.
18222
18223 These two options affect only the DNS lookup that takes place inside the router
18224 for the domain of the address that is being routed. They do not affect lookups
18225 such as that implied by
18226 .code
18227 domains = @mx_any
18228 .endd
18229 that may happen while processing a router precondition before the router is
18230 entered. No widening ever takes place for these lookups.
18231 .ecindex IIDdnsrou1
18232 .ecindex IIDdnsrou2
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242 . ////////////////////////////////////////////////////////////////////////////
18243 . ////////////////////////////////////////////////////////////////////////////
18244
18245 .chapter "The ipliteral router" "CHID5"
18246 .cindex "&(ipliteral)& router"
18247 .cindex "domain literal" "routing"
18248 .cindex "routers" "&(ipliteral)&"
18249 This router has no private options. Unless it is being used purely for
18250 verification (see &%verify_only%&) a transport is required to be defined by the
18251 generic &%transport%& option. The router accepts the address if its domain part
18252 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18253 router handles the address
18254 .code
18255 root@[192.168.1.1]
18256 .endd
18257 by setting up delivery to the host with that IP address. IPv4 domain literals
18258 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18259 are similar, but the address is preceded by &`ipv6:`&. For example:
18260 .code
18261 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18262 .endd
18263 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18264 grounds that sooner or later somebody will try it.
18265
18266 .oindex "&%self%&" "in &(ipliteral)& router"
18267 If the IP address matches something in &%ignore_target_hosts%&, the router
18268 declines. If an IP literal turns out to refer to the local host, the generic
18269 &%self%& option determines what happens.
18270
18271 The RFCs require support for domain literals; however, their use is
18272 controversial in today's Internet. If you want to use this router, you must
18273 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18274 Exim will not recognize the domain literal syntax in addresses.
18275
18276
18277
18278 . ////////////////////////////////////////////////////////////////////////////
18279 . ////////////////////////////////////////////////////////////////////////////
18280
18281 .chapter "The iplookup router" "CHID6"
18282 .cindex "&(iplookup)& router"
18283 .cindex "routers" "&(iplookup)&"
18284 The &(iplookup)& router was written to fulfil a specific requirement in
18285 Cambridge University (which in fact no longer exists). For this reason, it is
18286 not included in the binary of Exim by default. If you want to include it, you
18287 must set
18288 .code
18289 ROUTER_IPLOOKUP=yes
18290 .endd
18291 in your &_Local/Makefile_& configuration file.
18292
18293 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18294 connection to one or more specific hosts. The host can then return the same or
18295 a different address &-- in effect rewriting the recipient address in the
18296 message's envelope. The new address is then passed on to subsequent routers. If
18297 this process fails, the address can be passed on to other routers, or delivery
18298 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18299 must not be specified for it.
18300
18301 .cindex "options" "&(iplookup)& router"
18302 .option hosts iplookup string unset
18303 This option must be supplied. Its value is a colon-separated list of host
18304 names. The hosts are looked up using &[gethostbyname()]&
18305 (or &[getipnodebyname()]& when available)
18306 and are tried in order until one responds to the query. If none respond, what
18307 happens is controlled by &%optional%&.
18308
18309
18310 .option optional iplookup boolean false
18311 If &%optional%& is true, if no response is obtained from any host, the address
18312 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18313 delivery to the address is deferred.
18314
18315
18316 .option port iplookup integer 0
18317 .cindex "port" "&(iplookup)& router"
18318 This option must be supplied. It specifies the port number for the TCP or UDP
18319 call.
18320
18321
18322 .option protocol iplookup string udp
18323 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18324 protocols is to be used.
18325
18326
18327 .option query iplookup string&!! "see below"
18328 This defines the content of the query that is sent to the remote hosts. The
18329 default value is:
18330 .code
18331 $local_part@$domain $local_part@$domain
18332 .endd
18333 The repetition serves as a way of checking that a response is to the correct
18334 query in the default case (see &%response_pattern%& below).
18335
18336
18337 .option reroute iplookup string&!! unset
18338 If this option is not set, the rerouted address is precisely the byte string
18339 returned by the remote host, up to the first white space, if any. If set, the
18340 string is expanded to form the rerouted address. It can include parts matched
18341 in the response by &%response_pattern%& by means of numeric variables such as
18342 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18343 whether or not a pattern is in use. In all cases, the rerouted address must end
18344 up in the form &'local_part@domain'&.
18345
18346
18347 .option response_pattern iplookup string unset
18348 This option can be set to a regular expression that is applied to the string
18349 returned from the remote host. If the pattern does not match the response, the
18350 router declines. If &%response_pattern%& is not set, no checking of the
18351 response is done, unless the query was defaulted, in which case there is a
18352 check that the text returned after the first white space is the original
18353 address. This checks that the answer that has been received is in response to
18354 the correct question. For example, if the response is just a new domain, the
18355 following could be used:
18356 .code
18357 response_pattern = ^([^@]+)$
18358 reroute = $local_part@$1
18359 .endd
18360
18361 .option timeout iplookup time 5s
18362 This specifies the amount of time to wait for a response from the remote
18363 machine. The same timeout is used for the &[connect()]& function for a TCP
18364 call. It does not apply to UDP.
18365
18366
18367
18368
18369 . ////////////////////////////////////////////////////////////////////////////
18370 . ////////////////////////////////////////////////////////////////////////////
18371
18372 .chapter "The manualroute router" "CHID7"
18373 .scindex IIDmanrou1 "&(manualroute)& router"
18374 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18375 .cindex "domain" "manually routing"
18376 The &(manualroute)& router is so-called because it provides a way of manually
18377 routing an address according to its domain. It is mainly used when you want to
18378 route addresses to remote hosts according to your own rules, bypassing the
18379 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18380 route to local transports, a facility that may be useful if you want to save
18381 messages for dial-in hosts in local files.
18382
18383 The &(manualroute)& router compares a list of domain patterns with the domain
18384 it is trying to route. If there is no match, the router declines. Each pattern
18385 has associated with it a list of hosts and some other optional data, which may
18386 include a transport. The combination of a pattern and its data is called a
18387 &"routing rule"&. For patterns that do not have an associated transport, the
18388 generic &%transport%& option must specify a transport, unless the router is
18389 being used purely for verification (see &%verify_only%&).
18390
18391 .vindex "&$host$&"
18392 In the case of verification, matching the domain pattern is sufficient for the
18393 router to accept the address. When actually routing an address for delivery,
18394 an address that matches a domain pattern is queued for the associated
18395 transport. If the transport is not a local one, a host list must be associated
18396 with the pattern; IP addresses are looked up for the hosts, and these are
18397 passed to the transport along with the mail address. For local transports, a
18398 host list is optional. If it is present, it is passed in &$host$& as a single
18399 text string.
18400
18401 The list of routing rules can be provided as an inline string in
18402 &%route_list%&, or the data can be obtained by looking up the domain in a file
18403 or database by setting &%route_data%&. Only one of these settings may appear in
18404 any one instance of &(manualroute)&. The format of routing rules is described
18405 below, following the list of private options.
18406
18407
18408 .section "Private options for manualroute" "SECTprioptman"
18409
18410 .cindex "options" "&(manualroute)& router"
18411 The private options for the &(manualroute)& router are as follows:
18412
18413 .option host_all_ignored manualroute string defer
18414 See &%host_find_failed%&.
18415
18416 .option host_find_failed manualroute string freeze
18417 This option controls what happens when &(manualroute)& tries to find an IP
18418 address for a host, and the host does not exist. The option can be set to one
18419 of the following values:
18420 .code
18421 decline
18422 defer
18423 fail
18424 freeze
18425 ignore
18426 pass
18427 .endd
18428 The default (&"freeze"&) assumes that this state is a serious configuration
18429 error. The difference between &"pass"& and &"decline"& is that the former
18430 forces the address to be passed to the next router (or the router defined by
18431 &%pass_router%&),
18432 .oindex "&%more%&"
18433 overriding &%no_more%&, whereas the latter passes the address to the next
18434 router only if &%more%& is true.
18435
18436 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18437 cannot be found. If all the hosts in the list are ignored, the behaviour is
18438 controlled by the &%host_all_ignored%& option. This takes the same values
18439 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18440
18441 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18442 state; if a host lookup gets a temporary error, delivery is deferred unless the
18443 generic &%pass_on_timeout%& option is set.
18444
18445
18446 .option hosts_randomize manualroute boolean false
18447 .cindex "randomized host list"
18448 .cindex "host" "list of; randomized"
18449 If this option is set, the order of the items in a host list in a routing rule
18450 is randomized each time the list is used, unless an option in the routing rule
18451 overrides (see below). Randomizing the order of a host list can be used to do
18452 crude load sharing. However, if more than one mail address is routed by the
18453 same router to the same host list, the host lists are considered to be the same
18454 (even though they may be randomized into different orders) for the purpose of
18455 deciding whether to batch the deliveries into a single SMTP transaction.
18456
18457 When &%hosts_randomize%& is true, a host list may be split
18458 into groups whose order is separately randomized. This makes it possible to
18459 set up MX-like behaviour. The boundaries between groups are indicated by an
18460 item that is just &`+`& in the host list. For example:
18461 .code
18462 route_list = * host1:host2:host3:+:host4:host5
18463 .endd
18464 The order of the first three hosts and the order of the last two hosts is
18465 randomized for each use, but the first three always end up before the last two.
18466 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18467 randomized host list is passed to an &(smtp)& transport that also has
18468 &%hosts_randomize set%&, the list is not re-randomized.
18469
18470
18471 .option route_data manualroute string&!! unset
18472 If this option is set, it must expand to yield the data part of a routing rule.
18473 Typically, the expansion string includes a lookup based on the domain. For
18474 example:
18475 .code
18476 route_data = ${lookup{$domain}dbm{/etc/routes}}
18477 .endd
18478 If the expansion is forced to fail, or the result is an empty string, the
18479 router declines. Other kinds of expansion failure cause delivery to be
18480 deferred.
18481
18482
18483 .option route_list manualroute "string list" unset
18484 This string is a list of routing rules, in the form defined below. Note that,
18485 unlike most string lists, the items are separated by semicolons. This is so
18486 that they may contain colon-separated host lists.
18487
18488
18489 .option same_domain_copy_routing manualroute boolean false
18490 .cindex "address" "copying routing"
18491 Addresses with the same domain are normally routed by the &(manualroute)&
18492 router to the same list of hosts. However, this cannot be presumed, because the
18493 router options and preconditions may refer to the local part of the address. By
18494 default, therefore, Exim routes each address in a message independently. DNS
18495 servers run caches, so repeated DNS lookups are not normally expensive, and in
18496 any case, personal messages rarely have more than a few recipients.
18497
18498 If you are running mailing lists with large numbers of subscribers at the same
18499 domain, and you are using a &(manualroute)& router which is independent of the
18500 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18501 lookups for identical domains in one message. In this case, when
18502 &(manualroute)& routes an address to a remote transport, any other unrouted
18503 addresses in the message that have the same domain are automatically given the
18504 same routing without processing them independently. However, this is only done
18505 if &%headers_add%& and &%headers_remove%& are unset.
18506
18507
18508
18509
18510 .section "Routing rules in route_list" "SECID120"
18511 The value of &%route_list%& is a string consisting of a sequence of routing
18512 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18513 entered as two semicolons. Alternatively, the list separator can be changed as
18514 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18515 Empty rules are ignored. The format of each rule is
18516 .display
18517 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18518 .endd
18519 The following example contains two rules, each with a simple domain pattern and
18520 no options:
18521 .code
18522 route_list = \
18523   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18524   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18525 .endd
18526 The three parts of a rule are separated by white space. The pattern and the
18527 list of hosts can be enclosed in quotes if necessary, and if they are, the
18528 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18529 single domain pattern, which is the only mandatory item in the rule. The
18530 pattern is in the same format as one item in a domain list (see section
18531 &<<SECTdomainlist>>&),
18532 except that it may not be the name of an interpolated file.
18533 That is, it may be wildcarded, or a regular expression, or a file or database
18534 lookup (with semicolons doubled, because of the use of semicolon as a separator
18535 in a &%route_list%&).
18536
18537 The rules in &%route_list%& are searched in order until one of the patterns
18538 matches the domain that is being routed. The list of hosts and then options are
18539 then used as described below. If there is no match, the router declines. When
18540 &%route_list%& is set, &%route_data%& must not be set.
18541
18542
18543
18544 .section "Routing rules in route_data" "SECID121"
18545 The use of &%route_list%& is convenient when there are only a small number of
18546 routing rules. For larger numbers, it is easier to use a file or database to
18547 hold the routing information, and use the &%route_data%& option instead.
18548 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18549 Most commonly, &%route_data%& is set as a string that contains an
18550 expansion lookup. For example, suppose we place two routing rules in a file
18551 like this:
18552 .code
18553 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18554 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18555 .endd
18556 This data can be accessed by setting
18557 .code
18558 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18559 .endd
18560 Failure of the lookup results in an empty string, causing the router to
18561 decline. However, you do not have to use a lookup in &%route_data%&. The only
18562 requirement is that the result of expanding the string is a list of hosts,
18563 possibly followed by options, separated by white space. The list of hosts must
18564 be enclosed in quotes if it contains white space.
18565
18566
18567
18568
18569 .section "Format of the list of hosts" "SECID122"
18570 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18571 always separately expanded before use. If the expansion fails, the router
18572 declines. The result of the expansion must be a colon-separated list of names
18573 and/or IP addresses, optionally also including ports. The format of each item
18574 in the list is described in the next section. The list separator can be changed
18575 as described in section &<<SECTlistconstruct>>&.
18576
18577 If the list of hosts was obtained from a &%route_list%& item, the following
18578 variables are set during its expansion:
18579
18580 .ilist
18581 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18582 If the domain was matched against a regular expression, the numeric variables
18583 &$1$&, &$2$&, etc. may be set. For example:
18584 .code
18585 route_list = ^domain(\d+)   host-$1.text.example
18586 .endd
18587 .next
18588 &$0$& is always set to the entire domain.
18589 .next
18590 &$1$& is also set when partial matching is done in a file lookup.
18591
18592 .next
18593 .vindex "&$value$&"
18594 If the pattern that matched the domain was a lookup item, the data that was
18595 looked up is available in the expansion variable &$value$&. For example:
18596 .code
18597 route_list = lsearch;;/some/file.routes  $value
18598 .endd
18599 .endlist
18600
18601 Note the doubling of the semicolon in the pattern that is necessary because
18602 semicolon is the default route list separator.
18603
18604
18605
18606 .section "Format of one host item" "SECTformatonehostitem"
18607 Each item in the list of hosts is either a host name or an IP address,
18608 optionally with an attached port number. When no port is given, an IP address
18609 is not enclosed in brackets. When a port is specified, it overrides the port
18610 specification on the transport. The port is separated from the name or address
18611 by a colon. This leads to some complications:
18612
18613 .ilist
18614 Because colon is the default separator for the list of hosts, either
18615 the colon that specifies a port must be doubled, or the list separator must
18616 be changed. The following two examples have the same effect:
18617 .code
18618 route_list = * "host1.tld::1225 : host2.tld::1226"
18619 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18620 .endd
18621 .next
18622 When IPv6 addresses are involved, it gets worse, because they contain
18623 colons of their own. To make this case easier, it is permitted to
18624 enclose an IP address (either v4 or v6) in square brackets if a port
18625 number follows. For example:
18626 .code
18627 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18628 .endd
18629 .endlist
18630
18631 .section "How the list of hosts is used" "SECThostshowused"
18632 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18633 the hosts is tried, in the order specified, when carrying out the SMTP
18634 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18635 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18636 transport.
18637
18638 Hosts may be listed by name or by IP address. An unadorned name in the list of
18639 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18640 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18641 records in the DNS. For example:
18642 .code
18643 route_list = *  x.y.z:p.q.r/MX:e.f.g
18644 .endd
18645 If this feature is used with a port specifier, the port must come last. For
18646 example:
18647 .code
18648 route_list = *  dom1.tld/mx::1225
18649 .endd
18650 If the &%hosts_randomize%& option is set, the order of the items in the list is
18651 randomized before any lookups are done. Exim then scans the list; for any name
18652 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18653 be an interface on the local host and the item is not the first in the list,
18654 Exim discards it and any subsequent items. If it is the first item, what
18655 happens is controlled by the
18656 .oindex "&%self%&" "in &(manualroute)& router"
18657 &%self%& option of the router.
18658
18659 A name on the list that is followed by &`/MX`& is replaced with the list of
18660 hosts obtained by looking up MX records for the name. This is always a DNS
18661 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18662 below) are not relevant here. The order of these hosts is determined by the
18663 preference values in the MX records, according to the usual rules. Because
18664 randomizing happens before the MX lookup, it does not affect the order that is
18665 defined by MX preferences.
18666
18667 If the local host is present in the sublist obtained from MX records, but is
18668 not the most preferred host in that list, it and any equally or less
18669 preferred hosts are removed before the sublist is inserted into the main list.
18670
18671 If the local host is the most preferred host in the MX list, what happens
18672 depends on where in the original list of hosts the &`/MX`& item appears. If it
18673 is not the first item (that is, there are previous hosts in the main list),
18674 Exim discards this name and any subsequent items in the main list.
18675
18676 If the MX item is first in the list of hosts, and the local host is the
18677 most preferred host, what happens is controlled by the &%self%& option of the
18678 router.
18679
18680 DNS failures when lookup up the MX records are treated in the same way as DNS
18681 failures when looking up IP addresses: &%pass_on_timeout%& and
18682 &%host_find_failed%& are used when relevant.
18683
18684 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18685 whether obtained from an MX lookup or not.
18686
18687
18688
18689 .section "How the options are used" "SECThowoptused"
18690 The options are a sequence of words; in practice no more than three are ever
18691 present. One of the words can be the name of a transport; this overrides the
18692 &%transport%& option on the router for this particular routing rule only. The
18693 other words (if present) control randomization of the list of hosts on a
18694 per-rule basis, and how the IP addresses of the hosts are to be found when
18695 routing to a remote transport. These options are as follows:
18696
18697 .ilist
18698 &%randomize%&: randomize the order of the hosts in this list, overriding the
18699 setting of &%hosts_randomize%& for this routing rule only.
18700 .next
18701 &%no_randomize%&: do not randomize the order of the hosts in this list,
18702 overriding the setting of &%hosts_randomize%& for this routing rule only.
18703 .next
18704 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18705 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18706 also look in &_/etc/hosts_& or other sources of information.
18707 .next
18708 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18709 no address records are found. If there is a temporary DNS error (such as a
18710 timeout), delivery is deferred.
18711 .endlist
18712
18713 For example:
18714 .code
18715 route_list = domain1  host1:host2:host3  randomize bydns;\
18716              domain2  host4:host5
18717 .endd
18718 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18719 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18720 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18721 or &[gethostbyname()]&, and the result of the lookup is the result of that
18722 call.
18723
18724 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18725 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18726 instead of TRY_AGAIN. That is why the default action is to try a DNS
18727 lookup first. Only if that gives a definite &"no such host"& is the local
18728 function called.
18729
18730
18731
18732 If no IP address for a host can be found, what happens is controlled by the
18733 &%host_find_failed%& option.
18734
18735 .vindex "&$host$&"
18736 When an address is routed to a local transport, IP addresses are not looked up.
18737 The host list is passed to the transport in the &$host$& variable.
18738
18739
18740
18741 .section "Manualroute examples" "SECID123"
18742 In some of the examples that follow, the presence of the &%remote_smtp%&
18743 transport, as defined in the default configuration file, is assumed:
18744
18745 .ilist
18746 .cindex "smart host" "example router"
18747 The &(manualroute)& router can be used to forward all external mail to a
18748 &'smart host'&. If you have set up, in the main part of the configuration, a
18749 named domain list that contains your local domains, for example:
18750 .code
18751 domainlist local_domains = my.domain.example
18752 .endd
18753 You can arrange for all other domains to be routed to a smart host by making
18754 your first router something like this:
18755 .code
18756 smart_route:
18757   driver = manualroute
18758   domains = !+local_domains
18759   transport = remote_smtp
18760   route_list = * smarthost.ref.example
18761 .endd
18762 This causes all non-local addresses to be sent to the single host
18763 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18764 they are tried in order
18765 (but you can use &%hosts_randomize%& to vary the order each time).
18766 Another way of configuring the same thing is this:
18767 .code
18768 smart_route:
18769   driver = manualroute
18770   transport = remote_smtp
18771   route_list = !+local_domains  smarthost.ref.example
18772 .endd
18773 There is no difference in behaviour between these two routers as they stand.
18774 However, they behave differently if &%no_more%& is added to them. In the first
18775 example, the router is skipped if the domain does not match the &%domains%&
18776 precondition; the following router is always tried. If the router runs, it
18777 always matches the domain and so can never decline. Therefore, &%no_more%&
18778 would have no effect. In the second case, the router is never skipped; it
18779 always runs. However, if it doesn't match the domain, it declines. In this case
18780 &%no_more%& would prevent subsequent routers from running.
18781
18782 .next
18783 .cindex "mail hub example"
18784 A &'mail hub'& is a host which receives mail for a number of domains via MX
18785 records in the DNS and delivers it via its own private routing mechanism. Often
18786 the final destinations are behind a firewall, with the mail hub being the one
18787 machine that can connect to machines both inside and outside the firewall. The
18788 &(manualroute)& router is usually used on a mail hub to route incoming messages
18789 to the correct hosts. For a small number of domains, the routing can be inline,
18790 using the &%route_list%& option, but for a larger number a file or database
18791 lookup is easier to manage.
18792
18793 If the domain names are in fact the names of the machines to which the mail is
18794 to be sent by the mail hub, the configuration can be quite simple. For
18795 example:
18796 .code
18797 hub_route:
18798   driver = manualroute
18799   transport = remote_smtp
18800   route_list = *.rhodes.tvs.example  $domain
18801 .endd
18802 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18803 whose names are the same as the mail domains. A similar approach can be taken
18804 if the host name can be obtained from the domain name by a string manipulation
18805 that the expansion facilities can handle. Otherwise, a lookup based on the
18806 domain can be used to find the host:
18807 .code
18808 through_firewall:
18809   driver = manualroute
18810   transport = remote_smtp
18811   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18812 .endd
18813 The result of the lookup must be the name or IP address of the host (or
18814 hosts) to which the address is to be routed. If the lookup fails, the route
18815 data is empty, causing the router to decline. The address then passes to the
18816 next router.
18817
18818 .next
18819 .cindex "batched SMTP output example"
18820 .cindex "SMTP" "batched outgoing; example"
18821 You can use &(manualroute)& to deliver messages to pipes or files in batched
18822 SMTP format for onward transportation by some other means. This is one way of
18823 storing mail for a dial-up host when it is not connected. The route list entry
18824 can be as simple as a single domain name in a configuration like this:
18825 .code
18826 save_in_file:
18827   driver = manualroute
18828   transport = batchsmtp_appendfile
18829   route_list = saved.domain.example
18830 .endd
18831 though often a pattern is used to pick up more than one domain. If there are
18832 several domains or groups of domains with different transport requirements,
18833 different transports can be listed in the routing information:
18834 .code
18835 save_in_file:
18836   driver = manualroute
18837   route_list = \
18838     *.saved.domain1.example  $domain  batch_appendfile; \
18839     *.saved.domain2.example  \
18840       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18841       batch_pipe
18842 .endd
18843 .vindex "&$domain$&"
18844 .vindex "&$host$&"
18845 The first of these just passes the domain in the &$host$& variable, which
18846 doesn't achieve much (since it is also in &$domain$&), but the second does a
18847 file lookup to find a value to pass, causing the router to decline to handle
18848 the address if the lookup fails.
18849
18850 .next
18851 .cindex "UUCP" "example of router for"
18852 Routing mail directly to UUCP software is a specific case of the use of
18853 &(manualroute)& in a gateway to another mail environment. This is an example of
18854 one way it can be done:
18855 .code
18856 # Transport
18857 uucp:
18858   driver = pipe
18859   user = nobody
18860   command = /usr/local/bin/uux -r - \
18861     ${substr_-5:$host}!rmail ${local_part}
18862   return_fail_output = true
18863
18864 # Router
18865 uucphost:
18866   transport = uucp
18867   driver = manualroute
18868   route_data = \
18869     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18870 .endd
18871 The file &_/usr/local/exim/uucphosts_& contains entries like
18872 .code
18873 darksite.ethereal.example:           darksite.UUCP
18874 .endd
18875 It can be set up more simply without adding and removing &".UUCP"& but this way
18876 makes clear the distinction between the domain name
18877 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18878 .endlist
18879 .ecindex IIDmanrou1
18880 .ecindex IIDmanrou2
18881
18882
18883
18884
18885
18886
18887
18888
18889 . ////////////////////////////////////////////////////////////////////////////
18890 . ////////////////////////////////////////////////////////////////////////////
18891
18892 .chapter "The queryprogram router" "CHAPdriverlast"
18893 .scindex IIDquerou1 "&(queryprogram)& router"
18894 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18895 .cindex "routing" "by external program"
18896 The &(queryprogram)& router routes an address by running an external command
18897 and acting on its output. This is an expensive way to route, and is intended
18898 mainly for use in lightly-loaded systems, or for performing experiments.
18899 However, if it is possible to use the precondition options (&%domains%&,
18900 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18901 be used in special cases, even on a busy host. There are the following private
18902 options:
18903 .cindex "options" "&(queryprogram)& router"
18904
18905 .option command queryprogram string&!! unset
18906 This option must be set. It specifies the command that is to be run. The
18907 command is split up into a command name and arguments, and then each is
18908 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18909 &<<CHAPpipetransport>>&).
18910
18911
18912 .option command_group queryprogram string unset
18913 .cindex "gid (group id)" "in &(queryprogram)& router"
18914 This option specifies a gid to be set when running the command while routing an
18915 address for deliver. It must be set if &%command_user%& specifies a numerical
18916 uid. If it begins with a digit, it is interpreted as the numerical value of the
18917 gid. Otherwise it is looked up using &[getgrnam()]&.
18918
18919
18920 .option command_user queryprogram string unset
18921 .cindex "uid (user id)" "for &(queryprogram)&"
18922 This option must be set. It specifies the uid which is set when running the
18923 command while routing an address for delivery. If the value begins with a digit,
18924 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18925 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18926 not set, a value for the gid also.
18927
18928 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18929 root, which it does during a normal delivery in a conventional configuration.
18930 However, when an address is being verified during message reception, Exim is
18931 usually running as the Exim user, not as root. If the &(queryprogram)& router
18932 is called from a non-root process, Exim cannot change uid or gid before running
18933 the command. In this circumstance the command runs under the current uid and
18934 gid.
18935
18936
18937 .option current_directory queryprogram string /
18938 This option specifies an absolute path which is made the current directory
18939 before running the command.
18940
18941
18942 .option timeout queryprogram time 1h
18943 If the command does not complete within the timeout period, its process group
18944 is killed and the message is frozen. A value of zero time specifies no
18945 timeout.
18946
18947
18948 The standard output of the command is connected to a pipe, which is read when
18949 the command terminates. It should consist of a single line of output,
18950 containing up to five fields, separated by white space. The maximum length of
18951 the line is 1023 characters. Longer lines are silently truncated. The first
18952 field is one of the following words (case-insensitive):
18953
18954 .ilist
18955 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18956 below).
18957 .next
18958 &'Decline'&: the router declines; pass the address to the next router, unless
18959 &%no_more%& is set.
18960 .next
18961 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18962 subsequent text on the line is an error message. If the router is run as part
18963 of address verification during an incoming SMTP message, the message is
18964 included in the SMTP response.
18965 .next
18966 &'Defer'&: routing could not be completed at this time; try again later. Any
18967 subsequent text on the line is an error message which is logged. It is not
18968 included in any SMTP response.
18969 .next
18970 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18971 .next
18972 &'Pass'&: pass the address to the next router (or the router specified by
18973 &%pass_router%&), overriding &%no_more%&.
18974 .next
18975 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18976 new addresses, which are routed independently, starting with the first router,
18977 or the router specified by &%redirect_router%&, if set.
18978 .endlist
18979
18980 When the first word is &'accept'&, the remainder of the line consists of a
18981 number of keyed data values, as follows (split into two lines here, to fit on
18982 the page):
18983 .code
18984 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18985 LOOKUP=byname|bydns DATA=<text>
18986 .endd
18987 The data items can be given in any order, and all are optional. If no transport
18988 is included, the transport specified by the generic &%transport%& option is
18989 used. The list of hosts and the lookup type are needed only if the transport is
18990 an &(smtp)& transport that does not itself supply a list of hosts.
18991
18992 The format of the list of hosts is the same as for the &(manualroute)& router.
18993 As well as host names and IP addresses with optional port numbers, as described
18994 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18995 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18996 (see section &<<SECThostshowused>>&).
18997
18998 If the lookup type is not specified, Exim behaves as follows when trying to
18999 find an IP address for each host: First, a DNS lookup is done. If this yields
19000 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19001 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19002 result of the lookup is the result of that call.
19003
19004 .vindex "&$address_data$&"
19005 If the DATA field is set, its value is placed in the &$address_data$&
19006 variable. For example, this return line
19007 .code
19008 accept hosts=x1.y.example:x2.y.example data="rule1"
19009 .endd
19010 routes the address to the default transport, passing a list of two hosts. When
19011 the transport runs, the string &"rule1"& is in &$address_data$&.
19012 .ecindex IIDquerou1
19013 .ecindex IIDquerou2
19014
19015
19016
19017
19018 . ////////////////////////////////////////////////////////////////////////////
19019 . ////////////////////////////////////////////////////////////////////////////
19020
19021 .chapter "The redirect router" "CHAPredirect"
19022 .scindex IIDredrou1 "&(redirect)& router"
19023 .scindex IIDredrou2 "routers" "&(redirect)&"
19024 .cindex "alias file" "in a &(redirect)& router"
19025 .cindex "address redirection" "&(redirect)& router"
19026 The &(redirect)& router handles several kinds of address redirection. Its most
19027 common uses are for resolving local part aliases from a central alias file
19028 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19029 files, but it has many other potential uses. The incoming address can be
19030 redirected in several different ways:
19031
19032 .ilist
19033 It can be replaced by one or more new addresses which are themselves routed
19034 independently.
19035 .next
19036 It can be routed to be delivered to a given file or directory.
19037 .next
19038 It can be routed to be delivered to a specified pipe command.
19039 .next
19040 It can cause an automatic reply to be generated.
19041 .next
19042 It can be forced to fail, optionally with a custom error message.
19043 .next
19044 It can be temporarily deferred, optionally with a custom message.
19045 .next
19046 It can be discarded.
19047 .endlist
19048
19049 The generic &%transport%& option must not be set for &(redirect)& routers.
19050 However, there are some private options which define transports for delivery to
19051 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19052 &%pipe_transport%& and &%reply_transport%& descriptions below.
19053
19054 .new
19055 If success DSNs have been requested
19056 .cindex "DSN" "success"
19057 .cindex "Delivery Status Notification" "success"
19058 redirection triggers one and the DSN options are not passed any further.
19059 .wen
19060
19061
19062
19063 .section "Redirection data" "SECID124"
19064 The router operates by interpreting a text string which it obtains either by
19065 expanding the contents of the &%data%& option, or by reading the entire
19066 contents of a file whose name is given in the &%file%& option. These two
19067 options are mutually exclusive. The first is commonly used for handling system
19068 aliases, in a configuration like this:
19069 .code
19070 system_aliases:
19071   driver = redirect
19072   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19073 .endd
19074 If the lookup fails, the expanded string in this example is empty. When the
19075 expansion of &%data%& results in an empty string, the router declines. A forced
19076 expansion failure also causes the router to decline; other expansion failures
19077 cause delivery to be deferred.
19078
19079 A configuration using &%file%& is commonly used for handling users'
19080 &_.forward_& files, like this:
19081 .code
19082 userforward:
19083   driver = redirect
19084   check_local_user
19085   file = $home/.forward
19086   no_verify
19087 .endd
19088 If the file does not exist, or causes no action to be taken (for example, it is
19089 empty or consists only of comments), the router declines. &*Warning*&: This
19090 is not the case when the file contains syntactically valid items that happen to
19091 yield empty addresses, for example, items containing only RFC 2822 address
19092 comments.
19093
19094
19095
19096 .section "Forward files and address verification" "SECID125"
19097 .cindex "address redirection" "while verifying"
19098 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19099 &_.forward_& files, as in the example above. There are two reasons for this:
19100
19101 .ilist
19102 When Exim is receiving an incoming SMTP message from a remote host, it is
19103 running under the Exim uid, not as root. Exim is unable to change uid to read
19104 the file as the user, and it may not be able to read it as the Exim user. So in
19105 practice the router may not be able to operate.
19106 .next
19107 However, even when the router can operate, the existence of a &_.forward_& file
19108 is unimportant when verifying an address. What should be checked is whether the
19109 local part is a valid user name or not. Cutting out the redirection processing
19110 saves some resources.
19111 .endlist
19112
19113
19114
19115
19116
19117
19118 .section "Interpreting redirection data" "SECID126"
19119 .cindex "Sieve filter" "specifying in redirection data"
19120 .cindex "filter" "specifying in redirection data"
19121 The contents of the data string, whether obtained from &%data%& or &%file%&,
19122 can be interpreted in two different ways:
19123
19124 .ilist
19125 If the &%allow_filter%& option is set true, and the data begins with the text
19126 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19127 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19128 respectively. Details of the syntax and semantics of filter files are described
19129 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19130 document is intended for use by end users.
19131 .next
19132 Otherwise, the data must be a comma-separated list of redirection items, as
19133 described in the next section.
19134 .endlist
19135
19136 When a message is redirected to a file (a &"mail folder"&), the file name given
19137 in a non-filter redirection list must always be an absolute path. A filter may
19138 generate a relative path &-- how this is handled depends on the transport's
19139 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19140 for the &(appendfile)& transport.
19141
19142
19143
19144 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19145 .cindex "address redirection" "non-filter list items"
19146 When the redirection data is not an Exim or Sieve filter, for example, if it
19147 comes from a conventional alias or forward file, it consists of a list of
19148 addresses, file names, pipe commands, or certain special items (see section
19149 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19150 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19151 depending on their default values. The items in the list are separated by
19152 commas or newlines.
19153 If a comma is required in an item, the entire item must be enclosed in double
19154 quotes.
19155
19156 Lines starting with a # character are comments, and are ignored, and # may
19157 also appear following a comma, in which case everything between the # and the
19158 next newline character is ignored.
19159
19160 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19161 double quotes are retained because some forms of mail address require their use
19162 (but never to enclose the entire address). In the following description,
19163 &"item"& refers to what remains after any surrounding double quotes have been
19164 removed.
19165
19166 .vindex "&$local_part$&"
19167 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19168 and the expansion contains a reference to &$local_part$&, you should make use
19169 of the &%quote_local_part%& expansion operator, in case the local part contains
19170 special characters. For example, to redirect all mail for the domain
19171 &'obsolete.example'&, retaining the existing local part, you could use this
19172 setting:
19173 .code
19174 data = ${quote_local_part:$local_part}@newdomain.example
19175 .endd
19176
19177
19178 .section "Redirecting to a local mailbox" "SECTredlocmai"
19179 .cindex "routing" "loops in"
19180 .cindex "loop" "while routing, avoidance of"
19181 .cindex "address redirection" "to local mailbox"
19182 A redirection item may safely be the same as the address currently under
19183 consideration. This does not cause a routing loop, because a router is
19184 automatically skipped if any ancestor of the address that is being processed
19185 is the same as the current address and was processed by the current router.
19186 Such an address is therefore passed to the following routers, so it is handled
19187 as if there were no redirection. When making this loop-avoidance test, the
19188 complete local part, including any prefix or suffix, is used.
19189
19190 .cindex "address redirection" "local part without domain"
19191 Specifying the same local part without a domain is a common usage in personal
19192 filter files when the user wants to have messages delivered to the local
19193 mailbox and also forwarded elsewhere. For example, the user whose login is
19194 &'cleo'& might have a &_.forward_& file containing this:
19195 .code
19196 cleo, cleopatra@egypt.example
19197 .endd
19198 .cindex "backslash in alias file"
19199 .cindex "alias file" "backslash in"
19200 For compatibility with other MTAs, such unqualified local parts may be
19201 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19202 it does make a difference if more than one domain is being handled
19203 synonymously.
19204
19205 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19206 2822 address that does not include a domain, the item is qualified using the
19207 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19208 addresses are qualified using the value in &%qualify_recipient%&, but you can
19209 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19210
19211 Care must be taken if there are alias names for local users.
19212 Consider an MTA handling a single local domain where the system alias file
19213 contains:
19214 .code
19215 Sam.Reman: spqr
19216 .endd
19217 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19218 messages in the local mailbox, and also forward copies elsewhere. He creates
19219 this forward file:
19220 .code
19221 Sam.Reman, spqr@reme.elsewhere.example
19222 .endd
19223 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19224 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19225 second time round, because it has previously routed it,
19226 and the following routers presumably cannot handle the alias. The forward file
19227 should really contain
19228 .code
19229 spqr, spqr@reme.elsewhere.example
19230 .endd
19231 but because this is such a common error, the &%check_ancestor%& option (see
19232 below) exists to provide a way to get round it. This is normally set on a
19233 &(redirect)& router that is handling users' &_.forward_& files.
19234
19235
19236
19237 .section "Special items in redirection lists" "SECTspecitredli"
19238 In addition to addresses, the following types of item may appear in redirection
19239 lists (that is, in non-filter redirection data):
19240
19241 .ilist
19242 .cindex "pipe" "in redirection list"
19243 .cindex "address redirection" "to pipe"
19244 An item is treated as a pipe command if it begins with &"|"& and does not parse
19245 as a valid RFC 2822 address that includes a domain. A transport for running the
19246 command must be specified by the &%pipe_transport%& option.
19247 Normally, either the router or the transport specifies a user and a group under
19248 which to run the delivery. The default is to use the Exim user and group.
19249
19250 Single or double quotes can be used for enclosing the individual arguments of
19251 the pipe command; no interpretation of escapes is done for single quotes. If
19252 the command contains a comma character, it is necessary to put the whole item
19253 in double quotes, for example:
19254 .code
19255 "|/some/command ready,steady,go"
19256 .endd
19257 since items in redirection lists are terminated by commas. Do not, however,
19258 quote just the command. An item such as
19259 .code
19260 |"/some/command ready,steady,go"
19261 .endd
19262 is interpreted as a pipe with a rather strange command name, and no arguments.
19263
19264 Note that the above example assumes that the text comes from a lookup source
19265 of some sort, so that the quotes are part of the data.  If composing a
19266 redirect router with a &%data%& option directly specifying this command, the
19267 quotes will be used by the configuration parser to define the extent of one
19268 string, but will not be passed down into the redirect router itself.  There
19269 are two main approaches to get around this: escape quotes to be part of the
19270 data itself, or avoid using this mechanism and instead create a custom
19271 transport with the &%command%& option set and reference that transport from
19272 an &%accept%& router.
19273
19274 .next
19275 .cindex "file" "in redirection list"
19276 .cindex "address redirection" "to file"
19277 An item is interpreted as a path name if it begins with &"/"& and does not
19278 parse as a valid RFC 2822 address that includes a domain. For example,
19279 .code
19280 /home/world/minbari
19281 .endd
19282 is treated as a file name, but
19283 .code
19284 /s=molari/o=babylon/@x400gate.way
19285 .endd
19286 is treated as an address. For a file name, a transport must be specified using
19287 the &%file_transport%& option. However, if the generated path name ends with a
19288 forward slash character, it is interpreted as a directory name rather than a
19289 file name, and &%directory_transport%& is used instead.
19290
19291 Normally, either the router or the transport specifies a user and a group under
19292 which to run the delivery. The default is to use the Exim user and group.
19293
19294 .cindex "&_/dev/null_&"
19295 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19296 bypassed at a high level, and the log entry shows &"**bypassed**"&
19297 instead of a transport name. In this case the user and group are not used.
19298
19299 .next
19300 .cindex "included address list"
19301 .cindex "address redirection" "included external list"
19302 If an item is of the form
19303 .code
19304 :include:<path name>
19305 .endd
19306 a list of further items is taken from the given file and included at that
19307 point. &*Note*&: Such a file can not be a filter file; it is just an
19308 out-of-line addition to the list. The items in the included list are separated
19309 by commas or newlines and are not subject to expansion. If this is the first
19310 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19311 the alias name. This example is incorrect:
19312 .code
19313 list1    :include:/opt/lists/list1
19314 .endd
19315 It must be given as
19316 .code
19317 list1:   :include:/opt/lists/list1
19318 .endd
19319 .next
19320 .cindex "address redirection" "to black hole"
19321 Sometimes you want to throw away mail to a particular local part. Making the
19322 &%data%& option expand to an empty string does not work, because that causes
19323 the router to decline. Instead, the alias item
19324 .cindex "black hole"
19325 .cindex "abandoning mail"
19326 &':blackhole:'& can be used. It does what its name implies. No delivery is
19327 done, and no error message is generated. This has the same effect as specifing
19328 &_/dev/null_& as a destination, but it can be independently disabled.
19329
19330 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19331 delivery is done for the original local part, even if other redirection items
19332 are present. If you are generating a multi-item list (for example, by reading a
19333 database) and need the ability to provide a no-op item, you must use
19334 &_/dev/null_&.
19335
19336 .next
19337 .cindex "delivery" "forcing failure"
19338 .cindex "delivery" "forcing deferral"
19339 .cindex "failing delivery" "forcing"
19340 .cindex "deferred delivery, forcing"
19341 .cindex "customizing" "failure message"
19342 An attempt to deliver a particular address can be deferred or forced to fail by
19343 redirection items of the form
19344 .code
19345 :defer:
19346 :fail:
19347 .endd
19348 respectively. When a redirection list contains such an item, it applies
19349 to the entire redirection; any other items in the list are ignored. Any
19350 text following &':fail:'& or &':defer:'& is placed in the error text
19351 associated with the failure. For example, an alias file might contain:
19352 .code
19353 X.Employee:  :fail: Gone away, no forwarding address
19354 .endd
19355 In the case of an address that is being verified from an ACL or as the subject
19356 of a
19357 .cindex "VRFY" "error text, display of"
19358 VRFY command, the text is included in the SMTP error response by
19359 default.
19360 .cindex "EXPN" "error text, display of"
19361 The text is not included in the response to an EXPN command. In non-SMTP cases
19362 the text is included in the error message that Exim generates.
19363
19364 .cindex "SMTP" "error codes"
19365 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19366 &':fail:'&. However, if the message starts with three digits followed by a
19367 space, optionally followed by an extended code of the form &'n.n.n'&, also
19368 followed by a space, and the very first digit is the same as the default error
19369 code, the code from the message is used instead. If the very first digit is
19370 incorrect, a panic error is logged, and the default code is used. You can
19371 suppress the use of the supplied code in a redirect router by setting the
19372 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19373 ignored.
19374
19375 .vindex "&$acl_verify_message$&"
19376 In an ACL, an explicitly provided message overrides the default, but the
19377 default message is available in the variable &$acl_verify_message$& and can
19378 therefore be included in a custom message if this is desired.
19379
19380 Normally the error text is the rest of the redirection list &-- a comma does
19381 not terminate it &-- but a newline does act as a terminator. Newlines are not
19382 normally present in alias expansions. In &(lsearch)& lookups they are removed
19383 as part of the continuation process, but they may exist in other kinds of
19384 lookup and in &':include:'& files.
19385
19386 During routing for message delivery (as opposed to verification), a redirection
19387 containing &':fail:'& causes an immediate failure of the incoming address,
19388 whereas &':defer:'& causes the message to remain on the queue so that a
19389 subsequent delivery attempt can happen at a later time. If an address is
19390 deferred for too long, it will ultimately fail, because the normal retry
19391 rules still apply.
19392
19393 .next
19394 .cindex "alias file" "exception to default"
19395 Sometimes it is useful to use a single-key search type with a default (see
19396 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19397 for exceptions to the default. These can be handled by aliasing them to
19398 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19399 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19400 results in an empty redirection list has the same effect.
19401 .endlist
19402
19403
19404 .section "Duplicate addresses" "SECTdupaddr"
19405 .cindex "duplicate addresses"
19406 .cindex "address duplicate, discarding"
19407 .cindex "pipe" "duplicated"
19408 Exim removes duplicate addresses from the list to which it is delivering, so as
19409 to deliver just one copy to each address. This does not apply to deliveries
19410 routed to pipes by different immediate parent addresses, but an indirect
19411 aliasing scheme of the type
19412 .code
19413 pipe:       |/some/command $local_part
19414 localpart1: pipe
19415 localpart2: pipe
19416 .endd
19417 does not work with a message that is addressed to both local parts, because
19418 when the second is aliased to the intermediate local part &"pipe"& it gets
19419 discarded as being the same as a previously handled address. However, a scheme
19420 such as
19421 .code
19422 localpart1: |/some/command $local_part
19423 localpart2: |/some/command $local_part
19424 .endd
19425 does result in two different pipe deliveries, because the immediate parents of
19426 the pipes are distinct.
19427
19428
19429
19430 .section "Repeated redirection expansion" "SECID128"
19431 .cindex "repeated redirection expansion"
19432 .cindex "address redirection" "repeated for each delivery attempt"
19433 When a message cannot be delivered to all of its recipients immediately,
19434 leading to two or more delivery attempts, redirection expansion is carried out
19435 afresh each time for those addresses whose children were not all previously
19436 delivered. If redirection is being used as a mailing list, this can lead to new
19437 members of the list receiving copies of old messages. The &%one_time%& option
19438 can be used to avoid this.
19439
19440
19441 .section "Errors in redirection lists" "SECID129"
19442 .cindex "address redirection" "errors"
19443 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19444 error is skipped, and an entry is written to the main log. This may be useful
19445 for mailing lists that are automatically managed. Otherwise, if an error is
19446 detected while generating the list of new addresses, the original address is
19447 deferred. See also &%syntax_errors_to%&.
19448
19449
19450
19451 .section "Private options for the redirect router" "SECID130"
19452
19453 .cindex "options" "&(redirect)& router"
19454 The private options for the &(redirect)& router are as follows:
19455
19456
19457 .option allow_defer redirect boolean false
19458 Setting this option allows the use of &':defer:'& in non-filter redirection
19459 data, or the &%defer%& command in an Exim filter file.
19460
19461
19462 .option allow_fail redirect boolean false
19463 .cindex "failing delivery" "from filter"
19464 If this option is true, the &':fail:'& item can be used in a redirection list,
19465 and the &%fail%& command may be used in an Exim filter file.
19466
19467
19468 .option allow_filter redirect boolean false
19469 .cindex "filter" "enabling use of"
19470 .cindex "Sieve filter" "enabling use of"
19471 Setting this option allows Exim to interpret redirection data that starts with
19472 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19473 are some features of Exim filter files that some administrators may wish to
19474 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19475
19476 It is also possible to lock out Exim filters or Sieve filters while allowing
19477 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19478
19479
19480 The filter is run using the uid and gid set by the generic &%user%& and
19481 &%group%& options. These take their defaults from the password data if
19482 &%check_local_user%& is set, so in the normal case of users' personal filter
19483 files, the filter is run as the relevant user. When &%allow_filter%& is set
19484 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19485
19486
19487
19488 .option allow_freeze redirect boolean false
19489 .cindex "freezing messages" "allowing in filter"
19490 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19491 This command is more normally encountered in system filters, and is disabled by
19492 default for redirection filters because it isn't something you usually want to
19493 let ordinary users do.
19494
19495
19496
19497 .option check_ancestor redirect boolean false
19498 This option is concerned with handling generated addresses that are the same
19499 as some address in the list of redirection ancestors of the current address.
19500 Although it is turned off by default in the code, it is set in the default
19501 configuration file for handling users' &_.forward_& files. It is recommended
19502 for this use of the &(redirect)& router.
19503
19504 When &%check_ancestor%& is set, if a generated address (including the domain)
19505 is the same as any ancestor of the current address, it is replaced by a copy of
19506 the current address. This helps in the case where local part A is aliased to B,
19507 and B has a &_.forward_& file pointing back to A. For example, within a single
19508 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19509 &_&~jb/.forward_& contains:
19510 .code
19511 \Joe.Bloggs, <other item(s)>
19512 .endd
19513 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19514 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19515 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19516 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19517 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19518 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19519 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19520 original address. See also the &%repeat_use%& option below.
19521
19522
19523 .option check_group redirect boolean "see below"
19524 When the &%file%& option is used, the group owner of the file is checked only
19525 when this option is set. The permitted groups are those listed in the
19526 &%owngroups%& option, together with the user's default group if
19527 &%check_local_user%& is set. If the file has the wrong group, routing is
19528 deferred. The default setting for this option is true if &%check_local_user%&
19529 is set and the &%modemask%& option permits the group write bit, or if the
19530 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19531
19532
19533
19534 .option check_owner redirect boolean "see below"
19535 When the &%file%& option is used, the owner of the file is checked only when
19536 this option is set. If &%check_local_user%& is set, the local user is
19537 permitted; otherwise the owner must be one of those listed in the &%owners%&
19538 option. The default value for this option is true if &%check_local_user%& or
19539 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19540
19541
19542 .option data redirect string&!! unset
19543 This option is mutually exclusive with &%file%&. One or other of them must be
19544 set, but not both. The contents of &%data%& are expanded, and then used as the
19545 list of forwarding items, or as a set of filtering instructions. If the
19546 expansion is forced to fail, or the result is an empty string or a string that
19547 has no effect (consists entirely of comments), the router declines.
19548
19549 When filtering instructions are used, the string must begin with &"#Exim
19550 filter"&, and all comments in the string, including this initial one, must be
19551 terminated with newline characters. For example:
19552 .code
19553 data = #Exim filter\n\
19554        if $h_to: contains Exim then save $home/mail/exim endif
19555 .endd
19556 If you are reading the data from a database where newlines cannot be included,
19557 you can use the &${sg}$& expansion item to turn the escape string of your
19558 choice into a newline.
19559
19560
19561 .option directory_transport redirect string&!! unset
19562 A &(redirect)& router sets up a direct delivery to a directory when a path name
19563 ending with a slash is specified as a new &"address"&. The transport used is
19564 specified by this option, which, after expansion, must be the name of a
19565 configured transport. This should normally be an &(appendfile)& transport.
19566
19567
19568 .option file redirect string&!! unset
19569 This option specifies the name of a file that contains the redirection data. It
19570 is mutually exclusive with the &%data%& option. The string is expanded before
19571 use; if the expansion is forced to fail, the router declines. Other expansion
19572 failures cause delivery to be deferred. The result of a successful expansion
19573 must be an absolute path. The entire file is read and used as the redirection
19574 data. If the data is an empty string or a string that has no effect (consists
19575 entirely of comments), the router declines.
19576
19577 .cindex "NFS" "checking for file existence"
19578 If the attempt to open the file fails with a &"does not exist"& error, Exim
19579 runs a check on the containing directory,
19580 unless &%ignore_enotdir%& is true (see below).
19581 If the directory does not appear to exist, delivery is deferred. This can
19582 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19583 is a mount problem. If the containing directory does exist, but the file does
19584 not, the router declines.
19585
19586
19587 .option file_transport redirect string&!! unset
19588 .vindex "&$address_file$&"
19589 A &(redirect)& router sets up a direct delivery to a file when a path name not
19590 ending in a slash is specified as a new &"address"&. The transport used is
19591 specified by this option, which, after expansion, must be the name of a
19592 configured transport. This should normally be an &(appendfile)& transport. When
19593 it is running, the file name is in &$address_file$&.
19594
19595
19596 .option filter_prepend_home redirect boolean true
19597 When this option is true, if a &(save)& command in an Exim filter specifies a
19598 relative path, and &$home$& is defined, it is automatically prepended to the
19599 relative path. If this option is set false, this action does not happen. The
19600 relative path is then passed to the transport unmodified.
19601
19602
19603 .option forbid_blackhole redirect boolean false
19604 If this option is true, the &':blackhole:'& item may not appear in a
19605 redirection list.
19606
19607
19608 .option forbid_exim_filter redirect boolean false
19609 If this option is set true, only Sieve filters are permitted when
19610 &%allow_filter%& is true.
19611
19612
19613
19614
19615 .option forbid_file redirect boolean false
19616 .cindex "delivery" "to file; forbidding"
19617 .cindex "Sieve filter" "forbidding delivery to a file"
19618 .cindex "Sieve filter" "&""keep""& facility; disabling"
19619 If this option is true, this router may not generate a new address that
19620 specifies delivery to a local file or directory, either from a filter or from a
19621 conventional forward file. This option is forced to be true if &%one_time%& is
19622 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19623 locks out the Sieve's &"keep"& facility.
19624
19625
19626 .option forbid_filter_dlfunc redirect boolean false
19627 .cindex "filter" "locking out certain features"
19628 If this option is true, string expansions in Exim filters are not allowed to
19629 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19630 functions.
19631
19632 .option forbid_filter_existstest redirect boolean false
19633 .cindex "expansion" "statting a file"
19634 If this option is true, string expansions in Exim filters are not allowed to
19635 make use of the &%exists%& condition or the &%stat%& expansion item.
19636
19637 .option forbid_filter_logwrite redirect boolean false
19638 If this option is true, use of the logging facility in Exim filters is not
19639 permitted. Logging is in any case available only if the filter is being run
19640 under some unprivileged uid (which is normally the case for ordinary users'
19641 &_.forward_& files).
19642
19643
19644 .option forbid_filter_lookup redirect boolean false
19645 If this option is true, string expansions in Exim filter files are not allowed
19646 to make use of &%lookup%& items.
19647
19648
19649 .option forbid_filter_perl redirect boolean false
19650 This option has an effect only if Exim is built with embedded Perl support. If
19651 it is true, string expansions in Exim filter files are not allowed to make use
19652 of the embedded Perl support.
19653
19654
19655 .option forbid_filter_readfile redirect boolean false
19656 If this option is true, string expansions in Exim filter files are not allowed
19657 to make use of &%readfile%& items.
19658
19659
19660 .option forbid_filter_readsocket redirect boolean false
19661 If this option is true, string expansions in Exim filter files are not allowed
19662 to make use of &%readsocket%& items.
19663
19664
19665 .option forbid_filter_reply redirect boolean false
19666 If this option is true, this router may not generate an automatic reply
19667 message. Automatic replies can be generated only from Exim or Sieve filter
19668 files, not from traditional forward files. This option is forced to be true if
19669 &%one_time%& is set.
19670
19671
19672 .option forbid_filter_run redirect boolean false
19673 If this option is true, string expansions in Exim filter files are not allowed
19674 to make use of &%run%& items.
19675
19676
19677 .option forbid_include redirect boolean false
19678 If this option is true, items of the form
19679 .code
19680 :include:<path name>
19681 .endd
19682 are not permitted in non-filter redirection lists.
19683
19684
19685 .option forbid_pipe redirect boolean false
19686 .cindex "delivery" "to pipe; forbidding"
19687 If this option is true, this router may not generate a new address which
19688 specifies delivery to a pipe, either from an Exim filter or from a conventional
19689 forward file. This option is forced to be true if &%one_time%& is set.
19690
19691
19692 .option forbid_sieve_filter redirect boolean false
19693 If this option is set true, only Exim filters are permitted when
19694 &%allow_filter%& is true.
19695
19696
19697 .cindex "SMTP" "error codes"
19698 .option forbid_smtp_code redirect boolean false
19699 If this option is set true, any SMTP error codes that are present at the start
19700 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19701 the default codes (451 and 550, respectively) are always used.
19702
19703
19704
19705
19706 .option hide_child_in_errmsg redirect boolean false
19707 .cindex "bounce message" "redirection details; suppressing"
19708 If this option is true, it prevents Exim from quoting a child address if it
19709 generates a bounce or delay message for it. Instead it says &"an address
19710 generated from <&'the top level address'&>"&. Of course, this applies only to
19711 bounces generated locally. If a message is forwarded to another host, &'its'&
19712 bounce may well quote the generated address.
19713
19714
19715 .option ignore_eacces redirect boolean false
19716 .cindex "EACCES"
19717 If this option is set and an attempt to open a redirection file yields the
19718 EACCES error (permission denied), the &(redirect)& router behaves as if the
19719 file did not exist.
19720
19721
19722 .option ignore_enotdir redirect boolean false
19723 .cindex "ENOTDIR"
19724 If this option is set and an attempt to open a redirection file yields the
19725 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19726 router behaves as if the file did not exist.
19727
19728 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19729 router that has the &%file%& option set discovers that the file does not exist
19730 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19731 against unmounted NFS directories. If the parent can not be statted, delivery
19732 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19733 is set, because that option tells Exim to ignore &"something on the path is not
19734 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19735 that some operating systems give ENOENT where others give ENOTDIR.
19736
19737
19738
19739 .option include_directory redirect string unset
19740 If this option is set, the path names of any &':include:'& items in a
19741 redirection list must start with this directory.
19742
19743
19744 .option modemask redirect "octal integer" 022
19745 This specifies mode bits which must not be set for a file specified by the
19746 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19747
19748
19749 .option one_time redirect boolean false
19750 .cindex "one-time aliasing/forwarding expansion"
19751 .cindex "alias file" "one-time expansion"
19752 .cindex "forward file" "one-time expansion"
19753 .cindex "mailing lists" "one-time expansion"
19754 .cindex "address redirection" "one-time expansion"
19755 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19756 files each time it tries to deliver a message causes a problem when one or more
19757 of the generated addresses fails be delivered at the first attempt. The problem
19758 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19759 but of what happens when the redirection list changes during the time that the
19760 message is on Exim's queue. This is particularly true in the case of mailing
19761 lists, where new subscribers might receive copies of messages that were posted
19762 before they subscribed.
19763
19764 If &%one_time%& is set and any addresses generated by the router fail to
19765 deliver at the first attempt, the failing addresses are added to the message as
19766 &"top level"& addresses, and the parent address that generated them is marked
19767 &"delivered"&. Thus, redirection does not happen again at the next delivery
19768 attempt.
19769
19770 &*Warning 1*&: Any header line addition or removal that is specified by this
19771 router would be lost if delivery did not succeed at the first attempt. For this
19772 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19773 permitted when &%one_time%& is set.
19774
19775 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19776 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19777 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19778
19779 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19780 &%one_time%&.
19781
19782 The original top-level address is remembered with each of the generated
19783 addresses, and is output in any log messages. However, any intermediate parent
19784 addresses are not recorded. This makes a difference to the log only if
19785 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19786 typically be used for mailing lists, where there is normally just one level of
19787 expansion.
19788
19789
19790 .option owners redirect "string list" unset
19791 .cindex "ownership" "alias file"
19792 .cindex "ownership" "forward file"
19793 .cindex "alias file" "ownership"
19794 .cindex "forward file" "ownership"
19795 This specifies a list of permitted owners for the file specified by &%file%&.
19796 This list is in addition to the local user when &%check_local_user%& is set.
19797 See &%check_owner%& above.
19798
19799
19800 .option owngroups redirect "string list" unset
19801 This specifies a list of permitted groups for the file specified by &%file%&.
19802 The list is in addition to the local user's primary group when
19803 &%check_local_user%& is set. See &%check_group%& above.
19804
19805
19806 .option pipe_transport redirect string&!! unset
19807 .vindex "&$address_pipe$&"
19808 A &(redirect)& router sets up a direct delivery to a pipe when a string
19809 starting with a vertical bar character is specified as a new &"address"&. The
19810 transport used is specified by this option, which, after expansion, must be the
19811 name of a configured transport. This should normally be a &(pipe)& transport.
19812 When the transport is run, the pipe command is in &$address_pipe$&.
19813
19814
19815 .option qualify_domain redirect string&!! unset
19816 .vindex "&$qualify_recipient$&"
19817 If this option is set, and an unqualified address (one without a domain) is
19818 generated, and that address would normally be qualified by the global setting
19819 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19820 expanding this string. If the expansion fails, the router declines. If you want
19821 to revert to the default, you can have the expansion generate
19822 &$qualify_recipient$&.
19823
19824 This option applies to all unqualified addresses generated by Exim filters,
19825 but for traditional &_.forward_& files, it applies only to addresses that are
19826 not preceded by a backslash. Sieve filters cannot generate unqualified
19827 addresses.
19828
19829 .option qualify_preserve_domain redirect boolean false
19830 .cindex "domain" "in redirection; preserving"
19831 .cindex "preserving domain in redirection"
19832 .cindex "address redirection" "domain; preserving"
19833 If this option is set, the router's local &%qualify_domain%& option must not be
19834 set (a configuration error occurs if it is). If an unqualified address (one
19835 without a domain) is generated, it is qualified with the domain of the parent
19836 address (the immediately preceding ancestor) instead of the global
19837 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19838 this applies whether or not the address is preceded by a backslash.
19839
19840
19841 .option repeat_use redirect boolean true
19842 If this option is set false, the router is skipped for a child address that has
19843 any ancestor that was routed by this router. This test happens before any of
19844 the other preconditions are tested. Exim's default anti-looping rules skip
19845 only when the ancestor is the same as the current address. See also
19846 &%check_ancestor%& above and the generic &%redirect_router%& option.
19847
19848
19849 .option reply_transport redirect string&!! unset
19850 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19851 &%vacation%& command is used in a filter file. The transport used is specified
19852 by this option, which, after expansion, must be the name of a configured
19853 transport. This should normally be an &(autoreply)& transport. Other transports
19854 are unlikely to do anything sensible or useful.
19855
19856
19857 .option rewrite redirect boolean true
19858 .cindex "address redirection" "disabling rewriting"
19859 If this option is set false, addresses generated by the router are not
19860 subject to address rewriting. Otherwise, they are treated like new addresses
19861 and are rewritten according to the global rewriting rules.
19862
19863
19864 .option sieve_subaddress redirect string&!! unset
19865 The value of this option is passed to a Sieve filter to specify the
19866 :subaddress part of an address.
19867
19868 .option sieve_useraddress redirect string&!! unset
19869 The value of this option is passed to a Sieve filter to specify the :user part
19870 of an address. However, if it is unset, the entire original local part
19871 (including any prefix or suffix) is used for :user.
19872
19873
19874 .option sieve_vacation_directory redirect string&!! unset
19875 .cindex "Sieve filter" "vacation directory"
19876 To enable the &"vacation"& extension for Sieve filters, you must set
19877 &%sieve_vacation_directory%& to the directory where vacation databases are held
19878 (do not put anything else in that directory), and ensure that the
19879 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19880 needs their own directory; Exim will create it if necessary.
19881
19882
19883
19884 .option skip_syntax_errors redirect boolean false
19885 .cindex "forward file" "broken"
19886 .cindex "address redirection" "broken files"
19887 .cindex "alias file" "broken"
19888 .cindex "broken alias or forward files"
19889 .cindex "ignoring faulty addresses"
19890 .cindex "skipping faulty addresses"
19891 .cindex "error" "skipping bad syntax"
19892 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19893 non-filter redirection data are skipped, and each failing address is logged. If
19894 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19895 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19896 are expanded and placed at the head of the error message generated by
19897 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19898 be the same address as the generic &%errors_to%& option. The
19899 &%skip_syntax_errors%& option is often used when handling mailing lists.
19900
19901 If all the addresses in a redirection list are skipped because of syntax
19902 errors, the router declines to handle the original address, and it is passed to
19903 the following routers.
19904
19905 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19906 error in the filter causes filtering to be abandoned without any action being
19907 taken. The incident is logged, and the router declines to handle the address,
19908 so it is passed to the following routers.
19909
19910 .cindex "Sieve filter" "syntax errors in"
19911 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19912 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19913 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19914
19915 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19916 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19917 option, used with an address that does not get redirected, can be used to
19918 notify users of these errors, by means of a router like this:
19919 .code
19920 userforward:
19921   driver = redirect
19922   allow_filter
19923   check_local_user
19924   file = $home/.forward
19925   file_transport = address_file
19926   pipe_transport = address_pipe
19927   reply_transport = address_reply
19928   no_verify
19929   skip_syntax_errors
19930   syntax_errors_to = real-$local_part@$domain
19931   syntax_errors_text = \
19932    This is an automatically generated message. An error has\n\
19933    been found in your .forward file. Details of the error are\n\
19934    reported below. While this error persists, you will receive\n\
19935    a copy of this message for every message that is addressed\n\
19936    to you. If your .forward file is a filter file, or if it is\n\
19937    a non-filter file containing no valid forwarding addresses,\n\
19938    a copy of each incoming message will be put in your normal\n\
19939    mailbox. If a non-filter file contains at least one valid\n\
19940    forwarding address, forwarding to the valid addresses will\n\
19941    happen, and those will be the only deliveries that occur.
19942 .endd
19943 You also need a router to ensure that local addresses that are prefixed by
19944 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19945 put this immediately before the &(userforward)& router:
19946 .code
19947 real_localuser:
19948   driver = accept
19949   check_local_user
19950   local_part_prefix = real-
19951   transport = local_delivery
19952 .endd
19953 For security, it would probably be a good idea to restrict the use of this
19954 router to locally-generated messages, using a condition such as this:
19955 .code
19956   condition = ${if match {$sender_host_address}\
19957                          {\N^(|127\.0\.0\.1)$\N}}
19958 .endd
19959
19960
19961 .option syntax_errors_text redirect string&!! unset
19962 See &%skip_syntax_errors%& above.
19963
19964
19965 .option syntax_errors_to redirect string unset
19966 See &%skip_syntax_errors%& above.
19967 .ecindex IIDredrou1
19968 .ecindex IIDredrou2
19969
19970
19971
19972
19973
19974
19975 . ////////////////////////////////////////////////////////////////////////////
19976 . ////////////////////////////////////////////////////////////////////////////
19977
19978 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19979          "Environment for local transports"
19980 .scindex IIDenvlotra1 "local transports" "environment for"
19981 .scindex IIDenvlotra2 "environment for local transports"
19982 .scindex IIDenvlotra3 "transport" "local; environment for"
19983 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19984 transport can be thought of as similar to a pipe.) Exim always runs transports
19985 in subprocesses, under specified uids and gids. Typical deliveries to local
19986 mailboxes run under the uid and gid of the local user.
19987
19988 Exim also sets a specific current directory while running the transport; for
19989 some transports a home directory setting is also relevant. The &(pipe)&
19990 transport is the only one that sets up environment variables; see section
19991 &<<SECTpipeenv>>& for details.
19992
19993 The values used for the uid, gid, and the directories may come from several
19994 different places. In many cases, the router that handles the address associates
19995 settings with that address as a result of its &%check_local_user%&, &%group%&,
19996 or &%user%& options. However, values may also be given in the transport's own
19997 configuration, and these override anything that comes from the router.
19998
19999
20000
20001 .section "Concurrent deliveries" "SECID131"
20002 .cindex "concurrent deliveries"
20003 .cindex "simultaneous deliveries"
20004 If two different messages for the same local recipient arrive more or less
20005 simultaneously, the two delivery processes are likely to run concurrently. When
20006 the &(appendfile)& transport is used to write to a file, Exim applies locking
20007 rules to stop concurrent processes from writing to the same file at the same
20008 time.
20009
20010 However, when you use a &(pipe)& transport, it is up to you to arrange any
20011 locking that is needed. Here is a silly example:
20012 .code
20013 my_transport:
20014   driver = pipe
20015   command = /bin/sh -c 'cat >>/some/file'
20016 .endd
20017 This is supposed to write the message at the end of the file. However, if two
20018 messages arrive at the same time, the file will be scrambled. You can use the
20019 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20020 file using the same algorithm that Exim itself uses.
20021
20022
20023
20024
20025 .section "Uids and gids" "SECTenvuidgid"
20026 .cindex "local transports" "uid and gid"
20027 .cindex "transport" "local; uid and gid"
20028 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20029 overrides any group that the router set in the address, even if &%user%& is not
20030 set for the transport. This makes it possible, for example, to run local mail
20031 delivery under the uid of the recipient (set by the router), but in a special
20032 group (set by the transport). For example:
20033 .code
20034 # Routers ...
20035 # User/group are set by check_local_user in this router
20036 local_users:
20037   driver = accept
20038   check_local_user
20039   transport = group_delivery
20040
20041 # Transports ...
20042 # This transport overrides the group
20043 group_delivery:
20044   driver = appendfile
20045   file = /var/spool/mail/$local_part
20046   group = mail
20047 .endd
20048 If &%user%& is set for a transport, its value overrides what is set in the
20049 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20050 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20051 set.
20052
20053 .oindex "&%initgroups%&"
20054 When the uid is taken from the transport's configuration, the &[initgroups()]&
20055 function is called for the groups associated with that uid if the
20056 &%initgroups%& option is set for the transport. When the uid is not specified
20057 by the transport, but is associated with the address by a router, the option
20058 for calling &[initgroups()]& is taken from the router configuration.
20059
20060 .cindex "&(pipe)& transport" "uid for"
20061 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20062 is set and &%user%& is not set, the uid of the process that called Exim to
20063 receive the message is used, and if &%group%& is not set, the corresponding
20064 original gid is also used.
20065
20066 This is the detailed preference order for obtaining a gid; the first of the
20067 following that is set is used:
20068
20069 .ilist
20070 A &%group%& setting of the transport;
20071 .next
20072 A &%group%& setting of the router;
20073 .next
20074 A gid associated with a user setting of the router, either as a result of
20075 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20076 .next
20077 The group associated with a non-numeric &%user%& setting of the transport;
20078 .next
20079 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20080 the uid is the creator's uid;
20081 .next
20082 The Exim gid if the Exim uid is being used as a default.
20083 .endlist
20084
20085 If, for example, the user is specified numerically on the router and there are
20086 no group settings, no gid is available. In this situation, an error occurs.
20087 This is different for the uid, for which there always is an ultimate default.
20088 The first of the following that is set is used:
20089
20090 .ilist
20091 A &%user%& setting of the transport;
20092 .next
20093 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20094 .next
20095 A &%user%& setting of the router;
20096 .next
20097 A &%check_local_user%& setting of the router;
20098 .next
20099 The Exim uid.
20100 .endlist
20101
20102 Of course, an error will still occur if the uid that is chosen is on the
20103 &%never_users%& list.
20104
20105
20106
20107
20108
20109 .section "Current and home directories" "SECID132"
20110 .cindex "current directory for local transport"
20111 .cindex "home directory" "for local transport"
20112 .cindex "transport" "local; home directory for"
20113 .cindex "transport" "local; current directory for"
20114 Routers may set current and home directories for local transports by means of
20115 the &%transport_current_directory%& and &%transport_home_directory%& options.
20116 However, if the transport's &%current_directory%& or &%home_directory%& options
20117 are set, they override the router's values. In detail, the home directory
20118 for a local transport is taken from the first of these values that is set:
20119
20120 .ilist
20121 The &%home_directory%& option on the transport;
20122 .next
20123 The &%transport_home_directory%& option on the router;
20124 .next
20125 The password data if &%check_local_user%& is set on the router;
20126 .next
20127 The &%router_home_directory%& option on the router.
20128 .endlist
20129
20130 The current directory is taken from the first of these values that is set:
20131
20132 .ilist
20133 The &%current_directory%& option on the transport;
20134 .next
20135 The &%transport_current_directory%& option on the router.
20136 .endlist
20137
20138
20139 If neither the router nor the transport sets a current directory, Exim uses the
20140 value of the home directory, if it is set. Otherwise it sets the current
20141 directory to &_/_& before running a local transport.
20142
20143
20144
20145 .section "Expansion variables derived from the address" "SECID133"
20146 .vindex "&$domain$&"
20147 .vindex "&$local_part$&"
20148 .vindex "&$original_domain$&"
20149 Normally a local delivery is handling a single address, and in that case the
20150 variables such as &$domain$& and &$local_part$& are set during local
20151 deliveries. However, in some circumstances more than one address may be handled
20152 at once (for example, while writing batch SMTP for onward transmission by some
20153 other means). In this case, the variables associated with the local part are
20154 never set, &$domain$& is set only if all the addresses have the same domain,
20155 and &$original_domain$& is never set.
20156 .ecindex IIDenvlotra1
20157 .ecindex IIDenvlotra2
20158 .ecindex IIDenvlotra3
20159
20160
20161
20162
20163
20164
20165
20166 . ////////////////////////////////////////////////////////////////////////////
20167 . ////////////////////////////////////////////////////////////////////////////
20168
20169 .chapter "Generic options for transports" "CHAPtransportgeneric"
20170 .scindex IIDgenoptra1 "generic options" "transport"
20171 .scindex IIDgenoptra2 "options" "generic; for transports"
20172 .scindex IIDgenoptra3 "transport" "generic options for"
20173 The following generic options apply to all transports:
20174
20175
20176 .option body_only transports boolean false
20177 .cindex "transport" "body only"
20178 .cindex "message" "transporting body only"
20179 .cindex "body of message" "transporting"
20180 If this option is set, the message's headers are not transported. It is
20181 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20182 or &(pipe)& transports, the settings of &%message_prefix%& and
20183 &%message_suffix%& should be checked, because this option does not
20184 automatically suppress them.
20185
20186
20187 .option current_directory transports string&!! unset
20188 .cindex "transport" "current directory for"
20189 This specifies the current directory that is to be set while running the
20190 transport, overriding any value that may have been set by the router.
20191 If the expansion fails for any reason, including forced failure, an error is
20192 logged, and delivery is deferred.
20193
20194
20195 .option disable_logging transports boolean false
20196 If this option is set true, nothing is logged for any
20197 deliveries by the transport or for any
20198 transport errors. You should not set this option unless you really, really know
20199 what you are doing.
20200
20201
20202 .option debug_print transports string&!! unset
20203 .cindex "testing" "variables in drivers"
20204 If this option is set and debugging is enabled (see the &%-d%& command line
20205 option), the string is expanded and included in the debugging output when the
20206 transport is run.
20207 If expansion of the string fails, the error message is written to the debugging
20208 output, and Exim carries on processing.
20209 This facility is provided to help with checking out the values of variables and
20210 so on when debugging driver configurations. For example, if a &%headers_add%&
20211 option is not working properly, &%debug_print%& could be used to output the
20212 variables it references. A newline is added to the text if it does not end with
20213 one.
20214 The variables &$transport_name$& and &$router_name$& contain the name of the
20215 transport and the router that called it.
20216
20217 .option delivery_date_add transports boolean false
20218 .cindex "&'Delivery-date:'& header line"
20219 If this option is true, a &'Delivery-date:'& header is added to the message.
20220 This gives the actual time the delivery was made. As this is not a standard
20221 header, Exim has a configuration option (&%delivery_date_remove%&) which
20222 requests its removal from incoming messages, so that delivered messages can
20223 safely be resent to other recipients.
20224
20225
20226 .option driver transports string unset
20227 This specifies which of the available transport drivers is to be used.
20228 There is no default, and this option must be set for every transport.
20229
20230
20231 .option envelope_to_add transports boolean false
20232 .cindex "&'Envelope-to:'& header line"
20233 If this option is true, an &'Envelope-to:'& header is added to the message.
20234 This gives the original address(es) in the incoming envelope that caused this
20235 delivery to happen. More than one address may be present if the transport is
20236 configured to handle several addresses at once, or if more than one original
20237 address was redirected to the same final address. As this is not a standard
20238 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20239 its removal from incoming messages, so that delivered messages can safely be
20240 resent to other recipients.
20241
20242
20243 .option group transports string&!! "Exim group"
20244 .cindex "transport" "group; specifying"
20245 This option specifies a gid for running the transport process, overriding any
20246 value that the router supplies, and also overriding any value associated with
20247 &%user%& (see below).
20248
20249
20250 .option headers_add transports list&!! unset
20251 .cindex "header lines" "adding in transport"
20252 .cindex "transport" "header lines; adding"
20253 This option specifies a list of text headers,
20254 .new
20255 newline-separated (by default, changeable in the usual way),
20256 .wen
20257 which are (separately) expanded and added to the header
20258 portion of a message as it is transported, as described in section
20259 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20260 routers. If the result of the expansion is an empty string, or if the expansion
20261 is forced to fail, no action is taken. Other expansion failures are treated as
20262 errors and cause the delivery to be deferred.
20263
20264 Unlike most options, &%headers_add%& can be specified multiple times
20265 for a transport; all listed headers are added.
20266
20267
20268 .option headers_only transports boolean false
20269 .cindex "transport" "header lines only"
20270 .cindex "message" "transporting headers only"
20271 .cindex "header lines" "transporting"
20272 If this option is set, the message's body is not transported. It is mutually
20273 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20274 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20275 checked, since this option does not automatically suppress them.
20276
20277
20278 .option headers_remove transports list&!! unset
20279 .cindex "header lines" "removing"
20280 .cindex "transport" "header lines; removing"
20281 This option specifies a list of header names,
20282 .new
20283 colon-separated (by default, changeable in the usual way);
20284 .wen
20285 these headers are omitted from the message as it is transported, as described
20286 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20287 routers.
20288 Each list item is separately expanded.
20289 If the result of the expansion is an empty string, or if the expansion
20290 is forced to fail, no action is taken. Other expansion failures are treated as
20291 errors and cause the delivery to be deferred.
20292
20293 Unlike most options, &%headers_remove%& can be specified multiple times
20294 for a router; all listed headers are removed.
20295
20296
20297
20298 .option headers_rewrite transports string unset
20299 .cindex "transport" "header lines; rewriting"
20300 .cindex "rewriting" "at transport time"
20301 This option allows addresses in header lines to be rewritten at transport time,
20302 that is, as the message is being copied to its destination. The contents of the
20303 option are a colon-separated list of rewriting rules. Each rule is in exactly
20304 the same form as one of the general rewriting rules that are applied when a
20305 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20306 example,
20307 .code
20308 headers_rewrite = a@b c@d f : \
20309                   x@y w@z
20310 .endd
20311 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20312 &'w@z'& in all address-bearing header lines. The rules are applied to the
20313 header lines just before they are written out at transport time, so they affect
20314 only those copies of the message that pass through the transport. However, only
20315 the message's original header lines, and any that were added by a system
20316 filter, are rewritten. If a router or transport adds header lines, they are not
20317 affected by this option. These rewriting rules are &'not'& applied to the
20318 envelope. You can change the return path using &%return_path%&, but you cannot
20319 change envelope recipients at this time.
20320
20321
20322 .option home_directory transports string&!! unset
20323 .cindex "transport" "home directory for"
20324 .vindex "&$home$&"
20325 This option specifies a home directory setting for a local transport,
20326 overriding any value that may be set by the router. The home directory is
20327 placed in &$home$& while expanding the transport's private options. It is also
20328 used as the current directory if no current directory is set by the
20329 &%current_directory%& option on the transport or the
20330 &%transport_current_directory%& option on the router. If the expansion fails
20331 for any reason, including forced failure, an error is logged, and delivery is
20332 deferred.
20333
20334
20335 .option initgroups transports boolean false
20336 .cindex "additional groups"
20337 .cindex "groups" "additional"
20338 .cindex "transport" "group; additional"
20339 If this option is true and the uid for the delivery process is provided by the
20340 transport, the &[initgroups()]& function is called when running the transport
20341 to ensure that any additional groups associated with the uid are set up.
20342
20343
20344 .option message_size_limit transports string&!! 0
20345 .cindex "limit" "message size per transport"
20346 .cindex "size" "of message, limit"
20347 .cindex "transport" "message size; limiting"
20348 This option controls the size of messages passed through the transport. It is
20349 expanded before use; the result of the expansion must be a sequence of decimal
20350 digits, optionally followed by K or M. If the expansion fails for any reason,
20351 including forced failure, or if the result is not of the required form,
20352 delivery is deferred. If the value is greater than zero and the size of a
20353 message exceeds this limit, the address is failed. If there is any chance that
20354 the resulting bounce message could be routed to the same transport, you should
20355 ensure that &%return_size_limit%& is less than the transport's
20356 &%message_size_limit%&, as otherwise the bounce message will fail to get
20357 delivered.
20358
20359
20360
20361 .option rcpt_include_affixes transports boolean false
20362 .cindex "prefix" "for local part, including in envelope"
20363 .cindex "suffix for local part" "including in envelope"
20364 .cindex "local part" "prefix"
20365 .cindex "local part" "suffix"
20366 When this option is false (the default), and an address that has had any
20367 affixes (prefixes or suffixes) removed from the local part is delivered by any
20368 form of SMTP or LMTP, the affixes are not included. For example, if a router
20369 that contains
20370 .code
20371 local_part_prefix = *-
20372 .endd
20373 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20374 is delivered with
20375 .code
20376 RCPT TO:<xyz@some.domain>
20377 .endd
20378 This is also the case when an ACL-time callout is being used to verify a
20379 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20380 whole local part is included in the RCPT command. This option applies to BSMTP
20381 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20382 &(lmtp)& and &(smtp)& transports.
20383
20384
20385 .option retry_use_local_part transports boolean "see below"
20386 .cindex "hints database" "retry keys"
20387 When a delivery suffers a temporary failure, a retry record is created
20388 in Exim's hints database. For remote deliveries, the key for the retry record
20389 is based on the name and/or IP address of the failing remote host. For local
20390 deliveries, the key is normally the entire address, including both the local
20391 part and the domain. This is suitable for most common cases of local delivery
20392 temporary failure &-- for example, exceeding a mailbox quota should delay only
20393 deliveries to that mailbox, not to the whole domain.
20394
20395 However, in some special cases you may want to treat a temporary local delivery
20396 as a failure associated with the domain, and not with a particular local part.
20397 (For example, if you are storing all mail for some domain in files.) You can do
20398 this by setting &%retry_use_local_part%& false.
20399
20400 For all the local transports, its default value is true. For remote transports,
20401 the default value is false for tidiness, but changing the value has no effect
20402 on a remote transport in the current implementation.
20403
20404
20405 .option return_path transports string&!! unset
20406 .cindex "envelope sender"
20407 .cindex "transport" "return path; changing"
20408 .cindex "return path" "changing in transport"
20409 If this option is set, the string is expanded at transport time and replaces
20410 the existing return path (envelope sender) value in the copy of the message
20411 that is being delivered. An empty return path is permitted. This feature is
20412 designed for remote deliveries, where the value of this option is used in the
20413 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20414 only effect is to change the address that is placed in the &'Return-path:'&
20415 header line, if one is added to the message (see the next option).
20416
20417 &*Note:*& A changed return path is not logged unless you add
20418 &%return_path_on_delivery%& to the log selector.
20419
20420 .vindex "&$return_path$&"
20421 The expansion can refer to the existing value via &$return_path$&. This is
20422 either the message's envelope sender, or an address set by the
20423 &%errors_to%& option on a router. If the expansion is forced to fail, no
20424 replacement occurs; if it fails for another reason, delivery is deferred. This
20425 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20426 section &<<SECTverp>>&.
20427
20428 &*Note*&: If a delivery error is detected locally, including the case when a
20429 remote server rejects a message at SMTP time, the bounce message is not sent to
20430 the value of this option. It is sent to the previously set errors address.
20431 This defaults to the incoming sender address, but can be changed by setting
20432 &%errors_to%& in a router.
20433
20434
20435
20436 .option return_path_add transports boolean false
20437 .cindex "&'Return-path:'& header line"
20438 If this option is true, a &'Return-path:'& header is added to the message.
20439 Although the return path is normally available in the prefix line of BSD
20440 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20441 have easy access to it.
20442
20443 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20444 the delivery SMTP server makes the final delivery"&. This implies that this
20445 header should not be present in incoming messages. Exim has a configuration
20446 option, &%return_path_remove%&, which requests removal of this header from
20447 incoming messages, so that delivered messages can safely be resent to other
20448 recipients.
20449
20450
20451 .option shadow_condition transports string&!! unset
20452 See &%shadow_transport%& below.
20453
20454
20455 .option shadow_transport transports string unset
20456 .cindex "shadow transport"
20457 .cindex "transport" "shadow"
20458 A local transport may set the &%shadow_transport%& option to the name of
20459 another local transport. Shadow remote transports are not supported.
20460
20461 Whenever a delivery to the main transport succeeds, and either
20462 &%shadow_condition%& is unset, or its expansion does not result in the empty
20463 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20464 passed to the shadow transport, with the same delivery address or addresses. If
20465 expansion fails, no action is taken except that non-forced expansion failures
20466 cause a log line to be written.
20467
20468 The result of the shadow transport is discarded and does not affect the
20469 subsequent processing of the message. Only a single level of shadowing is
20470 provided; the &%shadow_transport%& option is ignored on any transport when it
20471 is running as a shadow. Options concerned with output from pipes are also
20472 ignored. The log line for the successful delivery has an item added on the end,
20473 of the form
20474 .code
20475 ST=<shadow transport name>
20476 .endd
20477 If the shadow transport did not succeed, the error message is put in
20478 parentheses afterwards. Shadow transports can be used for a number of different
20479 purposes, including keeping more detailed log information than Exim normally
20480 provides, and implementing automatic acknowledgment policies based on message
20481 headers that some sites insist on.
20482
20483
20484 .option transport_filter transports string&!! unset
20485 .cindex "transport" "filter"
20486 .cindex "filter" "transport filter"
20487 This option sets up a filtering (in the Unix shell sense) process for messages
20488 at transport time. It should not be confused with mail filtering as set up by
20489 individual users or via a system filter.
20490
20491 When the message is about to be written out, the command specified by
20492 &%transport_filter%& is started up in a separate, parallel process, and
20493 the entire message, including the header lines, is passed to it on its standard
20494 input (this in fact is done from a third process, to avoid deadlock). The
20495 command must be specified as an absolute path.
20496
20497 The lines of the message that are written to the transport filter are
20498 terminated by newline (&"\n"&). The message is passed to the filter before any
20499 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20500 lines beginning with a dot, and also before any processing implied by the
20501 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20502 &(pipe)& transports.
20503
20504 The standard error for the filter process is set to the same destination as its
20505 standard output; this is read and written to the message's ultimate
20506 destination. The process that writes the message to the filter, the
20507 filter itself, and the original process that reads the result and delivers it
20508 are all run in parallel, like a shell pipeline.
20509
20510 The filter can perform any transformations it likes, but of course should take
20511 care not to break RFC 2822 syntax. Exim does not check the result, except to
20512 test for a final newline when SMTP is in use. All messages transmitted over
20513 SMTP must end with a newline, so Exim supplies one if it is missing.
20514
20515 .cindex "content scanning" "per user"
20516 A transport filter can be used to provide content-scanning on a per-user basis
20517 at delivery time if the only required effect of the scan is to modify the
20518 message. For example, a content scan could insert a new header line containing
20519 a spam score. This could be interpreted by a filter in the user's MUA. It is
20520 not possible to discard a message at this stage.
20521
20522 .cindex "SMTP" "SIZE"
20523 A problem might arise if the filter increases the size of a message that is
20524 being sent down an SMTP connection. If the receiving SMTP server has indicated
20525 support for the SIZE parameter, Exim will have sent the size of the message
20526 at the start of the SMTP session. If what is actually sent is substantially
20527 more, the server might reject the message. This can be worked round by setting
20528 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20529 additions to the message, or to disable the use of SIZE altogether.
20530
20531 .vindex "&$pipe_addresses$&"
20532 The value of the &%transport_filter%& option is the command string for starting
20533 the filter, which is run directly from Exim, not under a shell. The string is
20534 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20535 Exim breaks it up into arguments and then expands each argument separately (see
20536 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20537 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20538 of arguments, one for each address that applies to this delivery. (This isn't
20539 an ideal name for this feature here, but as it was already implemented for the
20540 &(pipe)& transport, it seemed sensible not to change it.)
20541
20542 .vindex "&$host$&"
20543 .vindex "&$host_address$&"
20544 The expansion variables &$host$& and &$host_address$& are available when the
20545 transport is a remote one. They contain the name and IP address of the host to
20546 which the message is being sent. For example:
20547 .code
20548 transport_filter = /some/directory/transport-filter.pl \
20549   $host $host_address $sender_address $pipe_addresses
20550 .endd
20551
20552 Two problems arise if you want to use more complicated expansion items to
20553 generate transport filter commands, both of which due to the fact that the
20554 command is split up &'before'& expansion.
20555 .ilist
20556 If an expansion item contains white space, you must quote it, so that it is all
20557 part of the same command item. If the entire option setting is one such
20558 expansion item, you have to take care what kind of quoting you use. For
20559 example:
20560 .code
20561 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20562 .endd
20563 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20564 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20565 stripped by Exim when it read the option's value. When the value is used, if
20566 the single quotes were missing, the line would be split into two items,
20567 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20568 Exim tried to expand the first one.
20569 .next
20570 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20571 expansion cannot generate multiple arguments, or a command name followed by
20572 arguments. Consider this example:
20573 .code
20574 transport_filter = ${lookup{$host}lsearch{/a/file}\
20575                     {$value}{/bin/cat}}
20576 .endd
20577 The result of the lookup is interpreted as the name of the command, even
20578 if it contains white space. The simplest way round this is to use a shell:
20579 .code
20580 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20581                                {$value}{/bin/cat}}
20582 .endd
20583 .endlist
20584
20585 The filter process is run under the same uid and gid as the normal delivery.
20586 For remote deliveries this is the Exim uid/gid by default. The command should
20587 normally yield a zero return code. Transport filters are not supposed to fail.
20588 A non-zero code is taken to mean that the transport filter encountered some
20589 serious problem. Delivery of the message is deferred; the message remains on
20590 the queue and is tried again later. It is not possible to cause a message to be
20591 bounced from a transport filter.
20592
20593 If a transport filter is set on an autoreply transport, the original message is
20594 passed through the filter as it is being copied into the newly generated
20595 message, which happens if the &%return_message%& option is set.
20596
20597
20598 .option transport_filter_timeout transports time 5m
20599 .cindex "transport" "filter, timeout"
20600 When Exim is reading the output of a transport filter, it applies a timeout
20601 that can be set by this option. Exceeding the timeout is normally treated as a
20602 temporary delivery failure. However, if a transport filter is used with a
20603 &(pipe)& transport, a timeout in the transport filter is treated in the same
20604 way as a timeout in the pipe command itself. By default, a timeout is a hard
20605 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20606 becomes a temporary error.
20607
20608
20609 .option user transports string&!! "Exim user"
20610 .cindex "uid (user id)" "local delivery"
20611 .cindex "transport" "user, specifying"
20612 This option specifies the user under whose uid the delivery process is to be
20613 run, overriding any uid that may have been set by the router. If the user is
20614 given as a name, the uid is looked up from the password data, and the
20615 associated group is taken as the value of the gid to be used if the &%group%&
20616 option is not set.
20617
20618 For deliveries that use local transports, a user and group are normally
20619 specified explicitly or implicitly (for example, as a result of
20620 &%check_local_user%&) by the router or transport.
20621
20622 .cindex "hints database" "access by remote transport"
20623 For remote transports, you should leave this option unset unless you really are
20624 sure you know what you are doing. When a remote transport is running, it needs
20625 to be able to access Exim's hints databases, because each host may have its own
20626 retry data.
20627 .ecindex IIDgenoptra1
20628 .ecindex IIDgenoptra2
20629 .ecindex IIDgenoptra3
20630
20631
20632
20633
20634
20635
20636 . ////////////////////////////////////////////////////////////////////////////
20637 . ////////////////////////////////////////////////////////////////////////////
20638
20639 .chapter "Address batching in local transports" "CHAPbatching" &&&
20640          "Address batching"
20641 .cindex "transport" "local; address batching in"
20642 The only remote transport (&(smtp)&) is normally configured to handle more than
20643 one address at a time, so that when several addresses are routed to the same
20644 remote host, just one copy of the message is sent. Local transports, however,
20645 normally handle one address at a time. That is, a separate instance of the
20646 transport is run for each address that is routed to the transport. A separate
20647 copy of the message is delivered each time.
20648
20649 .cindex "batched local delivery"
20650 .oindex "&%batch_max%&"
20651 .oindex "&%batch_id%&"
20652 In special cases, it may be desirable to handle several addresses at once in a
20653 local transport, for example:
20654
20655 .ilist
20656 In an &(appendfile)& transport, when storing messages in files for later
20657 delivery by some other means, a single copy of the message with multiple
20658 recipients saves space.
20659 .next
20660 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20661 a single copy saves time, and is the normal way LMTP is expected to work.
20662 .next
20663 In a &(pipe)& transport, when passing the message
20664 to a scanner program or
20665 to some other delivery mechanism such as UUCP, multiple recipients may be
20666 acceptable.
20667 .endlist
20668
20669 These three local transports all have the same options for controlling multiple
20670 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20671 repeating the information for each transport, these options are described here.
20672
20673 The &%batch_max%& option specifies the maximum number of addresses that can be
20674 delivered together in a single run of the transport. Its default value is one
20675 (no batching). When more than one address is routed to a transport that has a
20676 &%batch_max%& value greater than one, the addresses are delivered in a batch
20677 (that is, in a single run of the transport with multiple recipients), subject
20678 to certain conditions:
20679
20680 .ilist
20681 .vindex "&$local_part$&"
20682 If any of the transport's options contain a reference to &$local_part$&, no
20683 batching is possible.
20684 .next
20685 .vindex "&$domain$&"
20686 If any of the transport's options contain a reference to &$domain$&, only
20687 addresses with the same domain are batched.
20688 .next
20689 .cindex "customizing" "batching condition"
20690 If &%batch_id%& is set, it is expanded for each address, and only those
20691 addresses with the same expanded value are batched. This allows you to specify
20692 customized batching conditions. Failure of the expansion for any reason,
20693 including forced failure, disables batching, but it does not stop the delivery
20694 from taking place.
20695 .next
20696 Batched addresses must also have the same errors address (where to send
20697 delivery errors), the same header additions and removals, the same user and
20698 group for the transport, and if a host list is present, the first host must
20699 be the same.
20700 .endlist
20701
20702 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20703 both when the file or pipe command is specified in the transport, and when it
20704 is specified by a &(redirect)& router, but all the batched addresses must of
20705 course be routed to the same file or pipe command. These two transports have an
20706 option called &%use_bsmtp%&, which causes them to deliver the message in
20707 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20708 &%check_string%& and &%escape_string%& options are forced to the values
20709 .code
20710 check_string = "."
20711 escape_string = ".."
20712 .endd
20713 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20714 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20715 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20716
20717 .cindex "&'Envelope-to:'& header line"
20718 If the generic &%envelope_to_add%& option is set for a batching transport, the
20719 &'Envelope-to:'& header that is added to the message contains all the addresses
20720 that are being processed together. If you are using a batching &(appendfile)&
20721 transport without &%use_bsmtp%&, the only way to preserve the recipient
20722 addresses is to set the &%envelope_to_add%& option.
20723
20724 .cindex "&(pipe)& transport" "with multiple addresses"
20725 .vindex "&$pipe_addresses$&"
20726 If you are using a &(pipe)& transport without BSMTP, and setting the
20727 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20728 the command. This is not a true variable; it is a bit of magic that causes each
20729 of the recipient addresses to be inserted into the command as a separate
20730 argument. This provides a way of accessing all the addresses that are being
20731 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20732 are specified by a &(redirect)& router.
20733
20734
20735
20736
20737 . ////////////////////////////////////////////////////////////////////////////
20738 . ////////////////////////////////////////////////////////////////////////////
20739
20740 .chapter "The appendfile transport" "CHAPappendfile"
20741 .scindex IIDapptra1 "&(appendfile)& transport"
20742 .scindex IIDapptra2 "transports" "&(appendfile)&"
20743 .cindex "directory creation"
20744 .cindex "creating directories"
20745 The &(appendfile)& transport delivers a message by appending it to an existing
20746 file, or by creating an entirely new file in a specified directory. Single
20747 files to which messages are appended can be in the traditional Unix mailbox
20748 format, or optionally in the MBX format supported by the Pine MUA and
20749 University of Washington IMAP daemon, &'inter alia'&. When each message is
20750 being delivered as a separate file, &"maildir"& format can optionally be used
20751 to give added protection against failures that happen part-way through the
20752 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20753 supported. For all file formats, Exim attempts to create as many levels of
20754 directory as necessary, provided that &%create_directory%& is set.
20755
20756 The code for the optional formats is not included in the Exim binary by
20757 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20758 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20759 included.
20760
20761 .cindex "quota" "system"
20762 Exim recognizes system quota errors, and generates an appropriate message. Exim
20763 also supports its own quota control within the transport, for use when the
20764 system facility is unavailable or cannot be used for some reason.
20765
20766 If there is an error while appending to a file (for example, quota exceeded or
20767 partition filled), Exim attempts to reset the file's length and last
20768 modification time back to what they were before. If there is an error while
20769 creating an entirely new file, the new file is removed.
20770
20771 Before appending to a file, a number of security checks are made, and the
20772 file is locked. A detailed description is given below, after the list of
20773 private options.
20774
20775 The &(appendfile)& transport is most commonly used for local deliveries to
20776 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20777 putting messages into files for remote delivery by some means other than Exim.
20778 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20779 option).
20780
20781
20782
20783 .section "The file and directory options" "SECTfildiropt"
20784 The &%file%& option specifies a single file, to which the message is appended;
20785 the &%directory%& option specifies a directory, in which a new file containing
20786 the message is created. Only one of these two options can be set, and for
20787 normal deliveries to mailboxes, one of them &'must'& be set.
20788
20789 .vindex "&$address_file$&"
20790 .vindex "&$local_part$&"
20791 However, &(appendfile)& is also used for delivering messages to files or
20792 directories whose names (or parts of names) are obtained from alias,
20793 forwarding, or filtering operations (for example, a &%save%& command in a
20794 user's Exim filter). When such a transport is running, &$local_part$& contains
20795 the local part that was aliased or forwarded, and &$address_file$& contains the
20796 name (or partial name) of the file or directory generated by the redirection
20797 operation. There are two cases:
20798
20799 .ilist
20800 If neither &%file%& nor &%directory%& is set, the redirection operation
20801 must specify an absolute path (one that begins with &`/`&). This is the most
20802 common case when users with local accounts use filtering to sort mail into
20803 different folders. See for example, the &(address_file)& transport in the
20804 default configuration. If the path ends with a slash, it is assumed to be the
20805 name of a directory. A delivery to a directory can also be forced by setting
20806 &%maildir_format%& or &%mailstore_format%&.
20807 .next
20808 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20809 used to determine the file or directory name for the delivery. Normally, the
20810 contents of &$address_file$& are used in some way in the string expansion.
20811 .endlist
20812
20813
20814 .cindex "Sieve filter" "configuring &(appendfile)&"
20815 .cindex "Sieve filter" "relative mailbox path handling"
20816 As an example of the second case, consider an environment where users do not
20817 have home directories. They may be permitted to use Exim filter commands of the
20818 form:
20819 .code
20820 save folder23
20821 .endd
20822 or Sieve filter commands of the form:
20823 .code
20824 require "fileinto";
20825 fileinto "folder23";
20826 .endd
20827 In this situation, the expansion of &%file%& or &%directory%& in the transport
20828 must transform the relative path into an appropriate absolute file name. In the
20829 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20830 is used as a result of a &"keep"& action in the filter. This example shows one
20831 way of handling this requirement:
20832 .code
20833 file = ${if eq{$address_file}{inbox} \
20834             {/var/mail/$local_part} \
20835             {${if eq{${substr_0_1:$address_file}}{/} \
20836                   {$address_file} \
20837                   {$home/mail/$address_file} \
20838             }} \
20839        }
20840 .endd
20841 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20842 location, absolute paths are used without change, and other folders are in the
20843 &_mail_& directory within the home directory.
20844
20845 &*Note 1*&: While processing an Exim filter, a relative path such as
20846 &_folder23_& is turned into an absolute path if a home directory is known to
20847 the router. In particular, this is the case if &%check_local_user%& is set. If
20848 you want to prevent this happening at routing time, you can set
20849 &%router_home_directory%& empty. This forces the router to pass the relative
20850 path to the transport.
20851
20852 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20853 the &%file%& or &%directory%& option is still used if it is set.
20854
20855
20856
20857
20858 .section "Private options for appendfile" "SECID134"
20859 .cindex "options" "&(appendfile)& transport"
20860
20861
20862
20863 .option allow_fifo appendfile boolean false
20864 .cindex "fifo (named pipe)"
20865 .cindex "named pipe (fifo)"
20866 .cindex "pipe" "named (fifo)"
20867 Setting this option permits delivery to named pipes (FIFOs) as well as to
20868 regular files. If no process is reading the named pipe at delivery time, the
20869 delivery is deferred.
20870
20871
20872 .option allow_symlink appendfile boolean false
20873 .cindex "symbolic link" "to mailbox"
20874 .cindex "mailbox" "symbolic link"
20875 By default, &(appendfile)& will not deliver if the path name for the file is
20876 that of a symbolic link. Setting this option relaxes that constraint, but there
20877 are security issues involved in the use of symbolic links. Be sure you know
20878 what you are doing if you set this. Details of exactly what this option affects
20879 are included in the discussion which follows this list of options.
20880
20881
20882 .option batch_id appendfile string&!! unset
20883 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20884 However, batching is automatically disabled for &(appendfile)& deliveries that
20885 happen as a result of forwarding or aliasing or other redirection directly to a
20886 file.
20887
20888
20889 .option batch_max appendfile integer 1
20890 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20891
20892
20893 .option check_group appendfile boolean false
20894 When this option is set, the group owner of the file defined by the &%file%&
20895 option is checked to see that it is the same as the group under which the
20896 delivery process is running. The default setting is false because the default
20897 file mode is 0600, which means that the group is irrelevant.
20898
20899
20900 .option check_owner appendfile boolean true
20901 When this option is set, the owner of the file defined by the &%file%& option
20902 is checked to ensure that it is the same as the user under which the delivery
20903 process is running.
20904
20905
20906 .option check_string appendfile string "see below"
20907 .cindex "&""From""& line"
20908 As &(appendfile)& writes the message, the start of each line is tested for
20909 matching &%check_string%&, and if it does, the initial matching characters are
20910 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20911 a literal string, not a regular expression, and the case of any letters it
20912 contains is significant.
20913
20914 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20915 are forced to &"."& and &".."& respectively, and any settings in the
20916 configuration are ignored. Otherwise, they default to &"From&~"& and
20917 &">From&~"& when the &%file%& option is set, and unset when any of the
20918 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20919
20920 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20921 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20922 &"From&~"& indicates the start of a new message. All four options need changing
20923 if another format is used. For example, to deliver to mailboxes in MMDF format:
20924 .cindex "MMDF format mailbox"
20925 .cindex "mailbox" "MMDF format"
20926 .code
20927 check_string = "\1\1\1\1\n"
20928 escape_string = "\1\1\1\1 \n"
20929 message_prefix = "\1\1\1\1\n"
20930 message_suffix = "\1\1\1\1\n"
20931 .endd
20932 .option create_directory appendfile boolean true
20933 .cindex "directory creation"
20934 When this option is true, Exim attempts to create any missing superior
20935 directories for the file that it is about to write. A created directory's mode
20936 is given by the &%directory_mode%& option.
20937
20938 The group ownership of a newly created directory is highly dependent on the
20939 operating system (and possibly the file system) that is being used. For
20940 example, in Solaris, if the parent directory has the setgid bit set, its group
20941 is propagated to the child; if not, the currently set group is used. However,
20942 in FreeBSD, the parent's group is always used.
20943
20944
20945
20946 .option create_file appendfile string anywhere
20947 This option constrains the location of files and directories that are created
20948 by this transport. It applies to files defined by the &%file%& option and
20949 directories defined by the &%directory%& option. In the case of maildir
20950 delivery, it applies to the top level directory, not the maildir directories
20951 beneath.
20952
20953 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20954 &"belowhome"&. In the second and third cases, a home directory must have been
20955 set for the transport. This option is not useful when an explicit file name is
20956 given for normal mailbox deliveries. It is intended for the case when file
20957 names are generated from users' &_.forward_& files. These are usually handled
20958 by an &(appendfile)& transport called &%address_file%&. See also
20959 &%file_must_exist%&.
20960
20961
20962 .option directory appendfile string&!! unset
20963 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20964 or &%directory%& must be set, unless the delivery is the direct result of a
20965 redirection (see section &<<SECTfildiropt>>&).
20966
20967 When &%directory%& is set, the string is expanded, and the message is delivered
20968 into a new file or files in or below the given directory, instead of being
20969 appended to a single mailbox file. A number of different formats are provided
20970 (see &%maildir_format%& and &%mailstore_format%&), and see section
20971 &<<SECTopdir>>& for further details of this form of delivery.
20972
20973
20974 .option directory_file appendfile string&!! "see below"
20975 .cindex "base62"
20976 .vindex "&$inode$&"
20977 When &%directory%& is set, but neither &%maildir_format%& nor
20978 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20979 whose name is obtained by expanding this string. The default value is:
20980 .code
20981 q${base62:$tod_epoch}-$inode
20982 .endd
20983 This generates a unique name from the current time, in base 62 form, and the
20984 inode of the file. The variable &$inode$& is available only when expanding this
20985 option.
20986
20987
20988 .option directory_mode appendfile "octal integer" 0700
20989 If &(appendfile)& creates any directories as a result of the
20990 &%create_directory%& option, their mode is specified by this option.
20991
20992
20993 .option escape_string appendfile string "see description"
20994 See &%check_string%& above.
20995
20996
20997 .option file appendfile string&!! unset
20998 This option is mutually exclusive with the &%directory%& option, but one of
20999 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21000 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21001 specifies a single file, to which the message is appended. One or more of
21002 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21003 &%file%&.
21004
21005 .cindex "NFS" "lock file"
21006 .cindex "locking files"
21007 .cindex "lock files"
21008 If you are using more than one host to deliver over NFS into the same
21009 mailboxes, you should always use lock files.
21010
21011 The string value is expanded for each delivery, and must yield an absolute
21012 path. The most common settings of this option are variations on one of these
21013 examples:
21014 .code
21015 file = /var/spool/mail/$local_part
21016 file = /home/$local_part/inbox
21017 file = $home/inbox
21018 .endd
21019 .cindex "&""sticky""& bit"
21020 In the first example, all deliveries are done into the same directory. If Exim
21021 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21022 create a file in the directory, so the &"sticky"& bit must be turned on for
21023 deliveries to be possible, or alternatively the &%group%& option can be used to
21024 run the delivery under a group id which has write access to the directory.
21025
21026
21027
21028 .option file_format appendfile string unset
21029 .cindex "file" "mailbox; checking existing format"
21030 This option requests the transport to check the format of an existing file
21031 before adding to it. The check consists of matching a specific string at the
21032 start of the file. The value of the option consists of an even number of
21033 colon-separated strings. The first of each pair is the test string, and the
21034 second is the name of a transport. If the transport associated with a matched
21035 string is not the current transport, control is passed over to the other
21036 transport. For example, suppose the standard &(local_delivery)& transport has
21037 this added to it:
21038 .code
21039 file_format = "From       : local_delivery :\
21040                \1\1\1\1\n : local_mmdf_delivery"
21041 .endd
21042 Mailboxes that begin with &"From"& are still handled by this transport, but if
21043 a mailbox begins with four binary ones followed by a newline, control is passed
21044 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21045 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21046 is assumed to match the current transport. If the start of a mailbox doesn't
21047 match any string, or if the transport named for a given string is not defined,
21048 delivery is deferred.
21049
21050
21051 .option file_must_exist appendfile boolean false
21052 If this option is true, the file specified by the &%file%& option must exist.
21053 A temporary error occurs if it does not, causing delivery to be deferred.
21054 If this option is false, the file is created if it does not exist.
21055
21056
21057 .option lock_fcntl_timeout appendfile time 0s
21058 .cindex "timeout" "mailbox locking"
21059 .cindex "mailbox" "locking, blocking and non-blocking"
21060 .cindex "locking files"
21061 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21062 when locking an open mailbox file. If the call fails, the delivery process
21063 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21064 Non-blocking calls are used so that the file is not kept open during the wait
21065 for the lock; the reason for this is to make it as safe as possible for
21066 deliveries over NFS in the case when processes might be accessing an NFS
21067 mailbox without using a lock file. This should not be done, but
21068 misunderstandings and hence misconfigurations are not unknown.
21069
21070 On a busy system, however, the performance of a non-blocking lock approach is
21071 not as good as using a blocking lock with a timeout. In this case, the waiting
21072 is done inside the system call, and Exim's delivery process acquires the lock
21073 and can proceed as soon as the previous lock holder releases it.
21074
21075 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21076 timeout, are used. There may still be some retrying: the maximum number of
21077 retries is
21078 .code
21079 (lock_retries * lock_interval) / lock_fcntl_timeout
21080 .endd
21081 rounded up to the next whole number. In other words, the total time during
21082 which &(appendfile)& is trying to get a lock is roughly the same, unless
21083 &%lock_fcntl_timeout%& is set very large.
21084
21085 You should consider setting this option if you are getting a lot of delayed
21086 local deliveries because of errors of the form
21087 .code
21088 failed to lock mailbox /some/file (fcntl)
21089 .endd
21090
21091 .option lock_flock_timeout appendfile time 0s
21092 This timeout applies to file locking when using &[flock()]& (see
21093 &%use_flock%&); the timeout operates in a similar manner to
21094 &%lock_fcntl_timeout%&.
21095
21096
21097 .option lock_interval appendfile time 3s
21098 This specifies the time to wait between attempts to lock the file. See below
21099 for details of locking.
21100
21101
21102 .option lock_retries appendfile integer 10
21103 This specifies the maximum number of attempts to lock the file. A value of zero
21104 is treated as 1. See below for details of locking.
21105
21106
21107 .option lockfile_mode appendfile "octal integer" 0600
21108 This specifies the mode of the created lock file, when a lock file is being
21109 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21110
21111
21112 .option lockfile_timeout appendfile time 30m
21113 .cindex "timeout" "mailbox locking"
21114 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21115 exists and is older than this value, it is assumed to have been left behind by
21116 accident, and Exim attempts to remove it.
21117
21118
21119 .option mailbox_filecount appendfile string&!! unset
21120 .cindex "mailbox" "specifying size of"
21121 .cindex "size" "of mailbox"
21122 If this option is set, it is expanded, and the result is taken as the current
21123 number of files in the mailbox. It must be a decimal number, optionally
21124 followed by K or M. This provides a way of obtaining this information from an
21125 external source that maintains the data.
21126
21127
21128 .option mailbox_size appendfile string&!! unset
21129 .cindex "mailbox" "specifying size of"
21130 .cindex "size" "of mailbox"
21131 If this option is set, it is expanded, and the result is taken as the current
21132 size the mailbox. It must be a decimal number, optionally followed by K or M.
21133 This provides a way of obtaining this information from an external source that
21134 maintains the data. This is likely to be helpful for maildir deliveries where
21135 it is computationally expensive to compute the size of a mailbox.
21136
21137
21138
21139 .option maildir_format appendfile boolean false
21140 .cindex "maildir format" "specifying"
21141 If this option is set with the &%directory%& option, the delivery is into a new
21142 file, in the &"maildir"& format that is used by other mail software. When the
21143 transport is activated directly from a &(redirect)& router (for example, the
21144 &(address_file)& transport in the default configuration), setting
21145 &%maildir_format%& causes the path received from the router to be treated as a
21146 directory, whether or not it ends with &`/`&. This option is available only if
21147 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21148 &<<SECTmaildirdelivery>>& below for further details.
21149
21150
21151 .option maildir_quota_directory_regex appendfile string "See below"
21152 .cindex "maildir format" "quota; directories included in"
21153 .cindex "quota" "maildir; directories included in"
21154 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21155 a regular expression for specifying directories, relative to the quota
21156 directory (see &%quota_directory%&), that should be included in the quota
21157 calculation. The default value is:
21158 .code
21159 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21160 .endd
21161 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21162 (directories whose names begin with a dot). If you want to exclude the
21163 &_Trash_&
21164 folder from the count (as some sites do), you need to change this setting to
21165 .code
21166 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21167 .endd
21168 This uses a negative lookahead in the regular expression to exclude the
21169 directory whose name is &_.Trash_&. When a directory is excluded from quota
21170 calculations, quota processing is bypassed for any messages that are delivered
21171 directly into that directory.
21172
21173
21174 .option maildir_retries appendfile integer 10
21175 This option specifies the number of times to retry when writing a file in
21176 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21177
21178
21179 .option maildir_tag appendfile string&!! unset
21180 This option applies only to deliveries in maildir format, and is described in
21181 section &<<SECTmaildirdelivery>>& below.
21182
21183
21184 .option maildir_use_size_file appendfile&!! boolean false
21185 .cindex "maildir format" "&_maildirsize_& file"
21186 The result of string expansion for this option must be a valid boolean value.
21187 If it is true, it enables support for &_maildirsize_& files. Exim
21188 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21189 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21190 value is zero. See &%maildir_quota_directory_regex%& above and section
21191 &<<SECTmaildirdelivery>>& below for further details.
21192
21193 .option maildirfolder_create_regex appendfile string unset
21194 .cindex "maildir format" "&_maildirfolder_& file"
21195 .cindex "&_maildirfolder_&, creating"
21196 The value of this option is a regular expression. If it is unset, it has no
21197 effect. Otherwise, before a maildir delivery takes place, the pattern is
21198 matched against the name of the maildir directory, that is, the directory
21199 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21200 delivery. If there is a match, Exim checks for the existence of a file called
21201 &_maildirfolder_& in the directory, and creates it if it does not exist.
21202 See section &<<SECTmaildirdelivery>>& for more details.
21203
21204
21205 .option mailstore_format appendfile boolean false
21206 .cindex "mailstore format" "specifying"
21207 If this option is set with the &%directory%& option, the delivery is into two
21208 new files in  &"mailstore"& format. The option is available only if
21209 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21210 below for further details.
21211
21212
21213 .option mailstore_prefix appendfile string&!! unset
21214 This option applies only to deliveries in mailstore format, and is described in
21215 section &<<SECTopdir>>& below.
21216
21217
21218 .option mailstore_suffix appendfile string&!! unset
21219 This option applies only to deliveries in mailstore format, and is described in
21220 section &<<SECTopdir>>& below.
21221
21222
21223 .option mbx_format appendfile boolean false
21224 .cindex "locking files"
21225 .cindex "file" "locking"
21226 .cindex "file" "MBX format"
21227 .cindex "MBX format, specifying"
21228 This option is available only if Exim has been compiled with SUPPORT_MBX
21229 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21230 the message is appended to the mailbox file in MBX format instead of
21231 traditional Unix format. This format is supported by Pine4 and its associated
21232 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21233
21234 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21235 automatically changed by the use of &%mbx_format%&. They should normally be set
21236 empty when using MBX format, so this option almost always appears in this
21237 combination:
21238 .code
21239 mbx_format = true
21240 message_prefix =
21241 message_suffix =
21242 .endd
21243 If none of the locking options are mentioned in the configuration,
21244 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21245 is possible to specify the other kinds of locking with &%mbx_format%&, but
21246 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21247 interworks with &'c-client'&, providing for shared access to the mailbox. It
21248 should not be used if any program that does not use this form of locking is
21249 going to access the mailbox, nor should it be used if the mailbox file is NFS
21250 mounted, because it works only when the mailbox is accessed from a single host.
21251
21252 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21253 the standard version of &'c-client'&, because as long as it has a mailbox open
21254 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21255 append messages to it.
21256
21257
21258 .option message_prefix appendfile string&!! "see below"
21259 .cindex "&""From""& line"
21260 The string specified here is expanded and output at the start of every message.
21261 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21262 in which case it is:
21263 .code
21264 message_prefix = "From ${if def:return_path{$return_path}\
21265   {MAILER-DAEMON}} $tod_bsdinbox\n"
21266 .endd
21267 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21268 &`\n`& to &`\r\n`& in &%message_prefix%&.
21269
21270 .option message_suffix appendfile string&!! "see below"
21271 The string specified here is expanded and output at the end of every message.
21272 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21273 in which case it is a single newline character. The suffix can be suppressed by
21274 setting
21275 .code
21276 message_suffix =
21277 .endd
21278 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21279 &`\n`& to &`\r\n`& in &%message_suffix%&.
21280
21281 .option mode appendfile "octal integer" 0600
21282 If the output file is created, it is given this mode. If it already exists and
21283 has wider permissions, they are reduced to this mode. If it has narrower
21284 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21285 if the delivery is the result of a &%save%& command in a filter file specifying
21286 a particular mode, the mode of the output file is always forced to take that
21287 value, and this option is ignored.
21288
21289
21290 .option mode_fail_narrower appendfile boolean true
21291 This option applies in the case when an existing mailbox file has a narrower
21292 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21293 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21294 continues with the delivery attempt, using the existing mode of the file.
21295
21296
21297 .option notify_comsat appendfile boolean false
21298 If this option is true, the &'comsat'& daemon is notified after every
21299 successful delivery to a user mailbox. This is the daemon that notifies logged
21300 on users about incoming mail.
21301
21302
21303 .option quota appendfile string&!! unset
21304 .cindex "quota" "imposed by Exim"
21305 This option imposes a limit on the size of the file to which Exim is appending,
21306 or to the total space used in the directory tree when the &%directory%& option
21307 is set. In the latter case, computation of the space used is expensive, because
21308 all the files in the directory (and any sub-directories) have to be
21309 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21310 &%maildir_use_size_file%& for ways to avoid this in environments where users
21311 have no shell access to their mailboxes).
21312
21313 As there is no interlock against two simultaneous deliveries into a
21314 multi-file mailbox, it is possible for the quota to be overrun in this case.
21315 For single-file mailboxes, of course, an interlock is a necessity.
21316
21317 A file's size is taken as its &'used'& value. Because of blocking effects, this
21318 may be a lot less than the actual amount of disk space allocated to the file.
21319 If the sizes of a number of files are being added up, the rounding effect can
21320 become quite noticeable, especially on systems that have large block sizes.
21321 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21322 the obvious value which users understand most easily.
21323
21324 The value of the option is expanded, and must then be a numerical value
21325 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21326 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21327 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21328 be handled.
21329
21330 &*Note*&: A value of zero is interpreted as &"no quota"&.
21331
21332 The expansion happens while Exim is running as root, before it changes uid for
21333 the delivery. This means that files that are inaccessible to the end user can
21334 be used to hold quota values that are looked up in the expansion. When delivery
21335 fails because this quota is exceeded, the handling of the error is as for
21336 system quota failures.
21337
21338 By default, Exim's quota checking mimics system quotas, and restricts the
21339 mailbox to the specified maximum size, though the value is not accurate to the
21340 last byte, owing to separator lines and additional headers that may get added
21341 during message delivery. When a mailbox is nearly full, large messages may get
21342 refused even though small ones are accepted, because the size of the current
21343 message is added to the quota when the check is made. This behaviour can be
21344 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21345 for exceeding the quota does not include the current message. Thus, deliveries
21346 continue until the quota has been exceeded; thereafter, no further messages are
21347 delivered. See also &%quota_warn_threshold%&.
21348
21349
21350 .option quota_directory appendfile string&!! unset
21351 This option defines the directory to check for quota purposes when delivering
21352 into individual files. The default is the delivery directory, or, if a file
21353 called &_maildirfolder_& exists in a maildir directory, the parent of the
21354 delivery directory.
21355
21356
21357 .option quota_filecount appendfile string&!! 0
21358 This option applies when the &%directory%& option is set. It limits the total
21359 number of files in the directory (compare the inode limit in system quotas). It
21360 can only be used if &%quota%& is also set. The value is expanded; an expansion
21361 failure causes delivery to be deferred. A value of zero is interpreted as
21362 &"no quota"&.
21363
21364
21365 .option quota_is_inclusive appendfile boolean true
21366 See &%quota%& above.
21367
21368
21369 .option quota_size_regex appendfile string unset
21370 This option applies when one of the delivery modes that writes a separate file
21371 for each message is being used. When Exim wants to find the size of one of
21372 these files in order to test the quota, it first checks &%quota_size_regex%&.
21373 If this is set to a regular expression that matches the file name, and it
21374 captures one string, that string is interpreted as a representation of the
21375 file's size. The value of &%quota_size_regex%& is not expanded.
21376
21377 This feature is useful only when users have no shell access to their mailboxes
21378 &-- otherwise they could defeat the quota simply by renaming the files. This
21379 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21380 the file length to the file name. For example:
21381 .code
21382 maildir_tag = ,S=$message_size
21383 quota_size_regex = ,S=(\d+)
21384 .endd
21385 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21386 number of lines in the message.
21387
21388 The regular expression should not assume that the length is at the end of the
21389 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21390 sometimes add other information onto the ends of message file names.
21391
21392 Section &<<SECID136>>& contains further information.
21393
21394
21395 .option quota_warn_message appendfile string&!! "see below"
21396 See below for the use of this option. If it is not set when
21397 &%quota_warn_threshold%& is set, it defaults to
21398 .code
21399 quota_warn_message = "\
21400   To: $local_part@$domain\n\
21401   Subject: Your mailbox\n\n\
21402   This message is automatically created \
21403   by mail delivery software.\n\n\
21404   The size of your mailbox has exceeded \
21405   a warning threshold that is\n\
21406   set by the system administrator.\n"
21407 .endd
21408
21409
21410 .option quota_warn_threshold appendfile string&!! 0
21411 .cindex "quota" "warning threshold"
21412 .cindex "mailbox" "size warning"
21413 .cindex "size" "of mailbox"
21414 This option is expanded in the same way as &%quota%& (see above). If the
21415 resulting value is greater than zero, and delivery of the message causes the
21416 size of the file or total space in the directory tree to cross the given
21417 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21418 may be specified as a percentage of it by following the value with a percent
21419 sign. For example:
21420 .code
21421 quota = 10M
21422 quota_warn_threshold = 75%
21423 .endd
21424 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21425 percent sign is ignored.
21426
21427 The warning message itself is specified by the &%quota_warn_message%& option,
21428 and it must start with a &'To:'& header line containing the recipient(s) of the
21429 warning message. These do not necessarily have to include the recipient(s) of
21430 the original message. A &'Subject:'& line should also normally be supplied. You
21431 can include any other header lines that you want. If you do not include a
21432 &'From:'& line, the default is:
21433 .code
21434 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21435 .endd
21436 .oindex &%errors_reply_to%&
21437 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21438 option.
21439
21440 The &%quota%& option does not have to be set in order to use this option; they
21441 are independent of one another except when the threshold is specified as a
21442 percentage.
21443
21444
21445 .option use_bsmtp appendfile boolean false
21446 .cindex "envelope sender"
21447 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21448 format, with the envelope sender and recipient(s) included as SMTP commands. If
21449 you want to include a leading HELO command with such messages, you can do
21450 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21451 for details of batch SMTP.
21452
21453
21454 .option use_crlf appendfile boolean false
21455 .cindex "carriage return"
21456 .cindex "linefeed"
21457 This option causes lines to be terminated with the two-character CRLF sequence
21458 (carriage return, linefeed) instead of just a linefeed character. In the case
21459 of batched SMTP, the byte sequence written to the file is then an exact image
21460 of what would be sent down a real SMTP connection.
21461
21462 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21463 (which are used to supply the traditional &"From&~"& and blank line separators
21464 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21465 carriage return characters if these are needed. In cases where these options
21466 have non-empty defaults, the values end with a single linefeed, so they must be
21467 changed to end with &`\r\n`& if &%use_crlf%& is set.
21468
21469
21470 .option use_fcntl_lock appendfile boolean "see below"
21471 This option controls the use of the &[fcntl()]& function to lock a file for
21472 exclusive use when a message is being appended. It is set by default unless
21473 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21474 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21475 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21476
21477
21478 .option use_flock_lock appendfile boolean false
21479 This option is provided to support the use of &[flock()]& for file locking, for
21480 the few situations where it is needed. Most modern operating systems support
21481 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21482 each other. Exim uses &[fcntl()]& locking by default.
21483
21484 This option is required only if you are using an operating system where
21485 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21486 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21487 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21488
21489 .cindex "Solaris" "&[flock()]& support"
21490 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21491 have it (and some, I think, provide a not quite right version built on top of
21492 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21493 the ability to use it, and any attempt to do so will cause a configuration
21494 error.
21495
21496 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21497 is just being mapped onto &[fcntl()]& by the OS).
21498
21499
21500 .option use_lockfile appendfile boolean "see below"
21501 If this option is turned off, Exim does not attempt to create a lock file when
21502 appending to a mailbox file. In this situation, the only locking is by
21503 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21504 sure that every MUA that is ever going to look at your users' mailboxes uses
21505 &[fcntl()]& rather than a lock file, and even then only when you are not
21506 delivering over NFS from more than one host.
21507
21508 .cindex "NFS" "lock file"
21509 In order to append to an NFS file safely from more than one host, it is
21510 necessary to take out a lock &'before'& opening the file, and the lock file
21511 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21512 file corruption.
21513
21514 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21515 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21516 except when &%mbx_format%& is set.
21517
21518
21519 .option use_mbx_lock appendfile boolean "see below"
21520 This option is available only if Exim has been compiled with SUPPORT_MBX
21521 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21522 locking rules be used. It is set by default if &%mbx_format%& is set and none
21523 of the locking options are mentioned in the configuration. The locking rules
21524 are the same as are used by the &'c-client'& library that underlies Pine and
21525 the IMAP4 and POP daemons that come with it (see the discussion below). The
21526 rules allow for shared access to the mailbox. However, this kind of locking
21527 does not work when the mailbox is NFS mounted.
21528
21529 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21530 &%use_flock_lock%& to control what kind of locking is used in implementing the
21531 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21532 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21533
21534
21535
21536
21537 .section "Operational details for appending" "SECTopappend"
21538 .cindex "appending to a file"
21539 .cindex "file" "appending"
21540 Before appending to a file, the following preparations are made:
21541
21542 .ilist
21543 If the name of the file is &_/dev/null_&, no action is taken, and a success
21544 return is given.
21545
21546 .next
21547 .cindex "directory creation"
21548 If any directories on the file's path are missing, Exim creates them if the
21549 &%create_directory%& option is set. A created directory's mode is given by the
21550 &%directory_mode%& option.
21551
21552 .next
21553 If &%file_format%& is set, the format of an existing file is checked. If this
21554 indicates that a different transport should be used, control is passed to that
21555 transport.
21556
21557 .next
21558 .cindex "file" "locking"
21559 .cindex "locking files"
21560 .cindex "NFS" "lock file"
21561 If &%use_lockfile%& is set, a lock file is built in a way that will work
21562 reliably over NFS, as follows:
21563
21564 .olist
21565 Create a &"hitching post"& file whose name is that of the lock file with the
21566 current time, primary host name, and process id added, by opening for writing
21567 as a new file. If this fails with an access error, delivery is deferred.
21568 .next
21569 Close the hitching post file, and hard link it to the lock file name.
21570 .next
21571 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21572 Unlink the hitching post name.
21573 .next
21574 Otherwise, use &[stat()]& to get information about the hitching post file, and
21575 then unlink hitching post name. If the number of links is exactly two, creation
21576 of the lock file succeeded but something (for example, an NFS server crash and
21577 restart) caused this fact not to be communicated to the &[link()]& call.
21578 .next
21579 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21580 up to &%lock_retries%& times. However, since any program that writes to a
21581 mailbox should complete its task very quickly, it is reasonable to time out old
21582 lock files that are normally the result of user agent and system crashes. If an
21583 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21584 it before trying again.
21585 .endlist olist
21586
21587 .next
21588 A call is made to &[lstat()]& to discover whether the main file exists, and if
21589 so, what its characteristics are. If &[lstat()]& fails for any reason other
21590 than non-existence, delivery is deferred.
21591
21592 .next
21593 .cindex "symbolic link" "to mailbox"
21594 .cindex "mailbox" "symbolic link"
21595 If the file does exist and is a symbolic link, delivery is deferred, unless the
21596 &%allow_symlink%& option is set, in which case the ownership of the link is
21597 checked, and then &[stat()]& is called to find out about the real file, which
21598 is then subjected to the checks below. The check on the top-level link
21599 ownership prevents one user creating a link for another's mailbox in a sticky
21600 directory, though allowing symbolic links in this case is definitely not a good
21601 idea. If there is a chain of symbolic links, the intermediate ones are not
21602 checked.
21603
21604 .next
21605 If the file already exists but is not a regular file, or if the file's owner
21606 and group (if the group is being checked &-- see &%check_group%& above) are
21607 different from the user and group under which the delivery is running,
21608 delivery is deferred.
21609
21610 .next
21611 If the file's permissions are more generous than specified, they are reduced.
21612 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21613 is set false, in which case the delivery is tried using the existing
21614 permissions.
21615
21616 .next
21617 The file's inode number is saved, and the file is then opened for appending.
21618 If this fails because the file has vanished, &(appendfile)& behaves as if it
21619 hadn't existed (see below). For any other failures, delivery is deferred.
21620
21621 .next
21622 If the file is opened successfully, check that the inode number hasn't
21623 changed, that it is still a regular file, and that the owner and permissions
21624 have not changed. If anything is wrong, defer delivery and freeze the message.
21625
21626 .next
21627 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21628 option is set. Otherwise, check that the file is being created in a permitted
21629 directory if the &%create_file%& option is set (deferring on failure), and then
21630 open for writing as a new file, with the O_EXCL and O_CREAT options,
21631 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21632 set). In this case, which can happen if the link points to a non-existent file,
21633 the file is opened for writing using O_CREAT but not O_EXCL, because
21634 that prevents link following.
21635
21636 .next
21637 .cindex "loop" "while file testing"
21638 If opening fails because the file exists, obey the tests given above for
21639 existing files. However, to avoid looping in a situation where the file is
21640 being continuously created and destroyed, the exists/not-exists loop is broken
21641 after 10 repetitions, and the message is then frozen.
21642
21643 .next
21644 If opening fails with any other error, defer delivery.
21645
21646 .next
21647 .cindex "file" "locking"
21648 .cindex "locking files"
21649 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21650 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21651 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21652 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21653 file, and an exclusive lock on the file whose name is
21654 .code
21655 /tmp/.<device-number>.<inode-number>
21656 .endd
21657 using the device and inode numbers of the open mailbox file, in accordance with
21658 the MBX locking rules. This file is created with a mode that is specified by
21659 the &%lockfile_mode%& option.
21660
21661 If Exim fails to lock the file, there are two possible courses of action,
21662 depending on the value of the locking timeout. This is obtained from
21663 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21664
21665 If the timeout value is zero, the file is closed, Exim waits for
21666 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21667 to lock it again. This happens up to &%lock_retries%& times, after which the
21668 delivery is deferred.
21669
21670 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21671 &[flock()]& are used (with the given timeout), so there has already been some
21672 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21673 immediately. It retries up to
21674 .code
21675 (lock_retries * lock_interval) / <timeout>
21676 .endd
21677 times (rounded up).
21678 .endlist
21679
21680 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21681 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21682
21683
21684 .section "Operational details for delivery to a new file" "SECTopdir"
21685 .cindex "delivery" "to single file"
21686 .cindex "&""From""& line"
21687 When the &%directory%& option is set instead of &%file%&, each message is
21688 delivered into a newly-created file or set of files. When &(appendfile)& is
21689 activated directly from a &(redirect)& router, neither &%file%& nor
21690 &%directory%& is normally set, because the path for delivery is supplied by the
21691 router. (See for example, the &(address_file)& transport in the default
21692 configuration.) In this case, delivery is to a new file if either the path name
21693 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21694
21695 No locking is required while writing the message to a new file, so the various
21696 locking options of the transport are ignored. The &"From"& line that by default
21697 separates messages in a single file is not normally needed, nor is the escaping
21698 of message lines that start with &"From"&, and there is no need to ensure a
21699 newline at the end of each message. Consequently, the default values for
21700 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21701 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21702
21703 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21704 the files in the delivery directory by default. However, you can specify a
21705 different directory by setting &%quota_directory%&. Also, for maildir
21706 deliveries (see below) the &_maildirfolder_& convention is honoured.
21707
21708
21709 .cindex "maildir format"
21710 .cindex "mailstore format"
21711 There are three different ways in which delivery to individual files can be
21712 done, controlled by the settings of the &%maildir_format%& and
21713 &%mailstore_format%& options. Note that code to support maildir or mailstore
21714 formats is not included in the binary unless SUPPORT_MAILDIR or
21715 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21716
21717 .cindex "directory creation"
21718 In all three cases an attempt is made to create the directory and any necessary
21719 sub-directories if they do not exist, provided that the &%create_directory%&
21720 option is set (the default). The location of a created directory can be
21721 constrained by setting &%create_file%&. A created directory's mode is given by
21722 the &%directory_mode%& option. If creation fails, or if the
21723 &%create_directory%& option is not set when creation is required, delivery is
21724 deferred.
21725
21726
21727
21728 .section "Maildir delivery" "SECTmaildirdelivery"
21729 .cindex "maildir format" "description of"
21730 If the &%maildir_format%& option is true, Exim delivers each message by writing
21731 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21732 directory that is defined by the &%directory%& option (the &"delivery
21733 directory"&). If the delivery is successful, the file is renamed into the
21734 &_new_& subdirectory.
21735
21736 In the file name, <&'stime'&> is the current time of day in seconds, and
21737 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21738 Exim checks that the time-of-day clock has moved on by at least one microsecond
21739 before terminating the delivery process. This guarantees uniqueness for the
21740 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21741 opening it. If any response other than ENOENT (does not exist) is given,
21742 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21743
21744 Before Exim carries out a maildir delivery, it ensures that subdirectories
21745 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21746 do not exist, Exim tries to create them and any superior directories in their
21747 path, subject to the &%create_directory%& and &%create_file%& options. If the
21748 &%maildirfolder_create_regex%& option is set, and the regular expression it
21749 contains matches the delivery directory, Exim also ensures that a file called
21750 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21751 &_maildirfolder_& file cannot be created, delivery is deferred.
21752
21753 These features make it possible to use Exim to create all the necessary files
21754 and directories in a maildir mailbox, including subdirectories for maildir++
21755 folders. Consider this example:
21756 .code
21757 maildir_format = true
21758 directory = /var/mail/$local_part\
21759            ${if eq{$local_part_suffix}{}{}\
21760            {/.${substr_1:$local_part_suffix}}}
21761 maildirfolder_create_regex = /\.[^/]+$
21762 .endd
21763 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21764 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21765 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21766 not match this name, so Exim will not look for or create the file
21767 &_/var/mail/pimbo/maildirfolder_&, though it will create
21768 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21769
21770 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21771 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21772 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21773 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21774 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21775
21776 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21777 not inadvertently match the toplevel maildir directory, because a
21778 &_maildirfolder_& file at top level would completely break quota calculations.
21779
21780 .cindex "quota" "in maildir delivery"
21781 .cindex "maildir++"
21782 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21783 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21784 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21785 Exim assumes the directory is a maildir++ folder directory, which is one level
21786 down from the user's top level mailbox directory. This causes it to start at
21787 the parent directory instead of the current directory when calculating the
21788 amount of space used.
21789
21790 One problem with delivering into a multi-file mailbox is that it is
21791 computationally expensive to compute the size of the mailbox for quota
21792 checking. Various approaches have been taken to reduce the amount of work
21793 needed. The next two sections describe two of them. A third alternative is to
21794 use some external process for maintaining the size data, and use the expansion
21795 of the &%mailbox_size%& option as a way of importing it into Exim.
21796
21797
21798
21799
21800 .section "Using tags to record message sizes" "SECID135"
21801 If &%maildir_tag%& is set, the string is expanded for each delivery.
21802 When the maildir file is renamed into the &_new_& sub-directory, the
21803 tag is added to its name. However, if adding the tag takes the length of the
21804 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21805 the tag is dropped and the maildir file is created with no tag.
21806
21807
21808 .vindex "&$message_size$&"
21809 Tags can be used to encode the size of files in their names; see
21810 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21811 happens after the message has been written. The value of the &$message_size$&
21812 variable is set to the number of bytes actually written. If the expansion is
21813 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21814 be deferred. The expanded tag may contain any printing characters except &"/"&.
21815 Non-printing characters in the string are ignored; if the resulting string is
21816 empty, it is ignored. If it starts with an alphanumeric character, a leading
21817 colon is inserted; this default has not proven to be the path that popular
21818 maildir implementations have chosen (but changing it in Exim would break
21819 backwards compatibility).
21820
21821 For one common implementation, you might set:
21822 .code
21823 maildir_tag = ,S=${message_size}
21824 .endd
21825 but you should check the documentation of the other software to be sure.
21826
21827 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21828 as this allows Exim to extract the size from your tag, instead of having to
21829 &[stat()]& each message file.
21830
21831
21832 .section "Using a maildirsize file" "SECID136"
21833 .cindex "quota" "in maildir delivery"
21834 .cindex "maildir format" "&_maildirsize_& file"
21835 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21836 storing quota and message size information in a file called &_maildirsize_&
21837 within the toplevel maildir directory. If this file does not exist, Exim
21838 creates it, setting the quota from the &%quota%& option of the transport. If
21839 the maildir directory itself does not exist, it is created before any attempt
21840 to write a &_maildirsize_& file.
21841
21842 The &_maildirsize_& file is used to hold information about the sizes of
21843 messages in the maildir, thus speeding up quota calculations. The quota value
21844 in the file is just a cache; if the quota is changed in the transport, the new
21845 value overrides the cached value when the next message is delivered. The cache
21846 is maintained for the benefit of other programs that access the maildir and
21847 need to know the quota.
21848
21849 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21850 file is maintained (with a zero quota setting), but no quota is imposed.
21851
21852 A regular expression is available for controlling which directories in the
21853 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21854 See the description of the &%maildir_quota_directory_regex%& option above for
21855 details.
21856
21857
21858 .section "Mailstore delivery" "SECID137"
21859 .cindex "mailstore format" "description of"
21860 If the &%mailstore_format%& option is true, each message is written as two
21861 files in the given directory. A unique base name is constructed from the
21862 message id and the current delivery process, and the files that are written use
21863 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21864 contains the message's envelope, and the &_.msg_& file contains the message
21865 itself. The base name is placed in the variable &$mailstore_basename$&.
21866
21867 During delivery, the envelope is first written to a file with the suffix
21868 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21869 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21870 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21871 file before accessing either of them. An alternative approach is to wait for
21872 the absence of a &_.tmp_& file.
21873
21874 The envelope file starts with any text defined by the &%mailstore_prefix%&
21875 option, expanded and terminated by a newline if there isn't one. Then follows
21876 the sender address on one line, then all the recipient addresses, one per line.
21877 There can be more than one recipient only if the &%batch_max%& option is set
21878 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21879 appended to the file, followed by a newline if it does not end with one.
21880
21881 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21882 failure, it is ignored. Other expansion errors are treated as serious
21883 configuration errors, and delivery is deferred. The variable
21884 &$mailstore_basename$& is available for use during these expansions.
21885
21886
21887 .section "Non-special new file delivery" "SECID138"
21888 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21889 file is created directly in the named directory. For example, when delivering
21890 messages into files in batched SMTP format for later delivery to some host (see
21891 section &<<SECTbatchSMTP>>&), a setting such as
21892 .code
21893 directory = /var/bsmtp/$host
21894 .endd
21895 might be used. A message is written to a file with a temporary name, which is
21896 then renamed when the delivery is complete. The final name is obtained by
21897 expanding the contents of the &%directory_file%& option.
21898 .ecindex IIDapptra1
21899 .ecindex IIDapptra2
21900
21901
21902
21903
21904
21905
21906 . ////////////////////////////////////////////////////////////////////////////
21907 . ////////////////////////////////////////////////////////////////////////////
21908
21909 .chapter "The autoreply transport" "CHID8"
21910 .scindex IIDauttra1 "transports" "&(autoreply)&"
21911 .scindex IIDauttra2 "&(autoreply)& transport"
21912 The &(autoreply)& transport is not a true transport in that it does not cause
21913 the message to be transmitted. Instead, it generates a new mail message as an
21914 automatic reply to the incoming message. &'References:'& and
21915 &'Auto-Submitted:'& header lines are included. These are constructed according
21916 to the rules in RFCs 2822 and 3834, respectively.
21917
21918 If the router that passes the message to this transport does not have the
21919 &%unseen%& option set, the original message (for the current recipient) is not
21920 delivered anywhere. However, when the &%unseen%& option is set on the router
21921 that passes the message to this transport, routing of the address continues, so
21922 another router can set up a normal message delivery.
21923
21924
21925 The &(autoreply)& transport is usually run as the result of mail filtering, a
21926 &"vacation"& message being the standard example. However, it can also be run
21927 directly from a router like any other transport. To reduce the possibility of
21928 message cascades, messages created by the &(autoreply)& transport always have
21929 empty envelope sender addresses, like bounce messages.
21930
21931 The parameters of the message to be sent can be specified in the configuration
21932 by options described below. However, these are used only when the address
21933 passed to the transport does not contain its own reply information. When the
21934 transport is run as a consequence of a
21935 &%mail%&
21936 or &%vacation%& command in a filter file, the parameters of the message are
21937 supplied by the filter, and passed with the address. The transport's options
21938 that define the message are then ignored (so they are not usually set in this
21939 case). The message is specified entirely by the filter or by the transport; it
21940 is never built from a mixture of options. However, the &%file_optional%&,
21941 &%mode%&, and &%return_message%& options apply in all cases.
21942
21943 &(Autoreply)& is implemented as a local transport. When used as a result of a
21944 command in a user's filter file, &(autoreply)& normally runs under the uid and
21945 gid of the user, and with appropriate current and home directories (see chapter
21946 &<<CHAPenvironment>>&).
21947
21948 There is a subtle difference between routing a message to a &(pipe)& transport
21949 that generates some text to be returned to the sender, and routing it to an
21950 &(autoreply)& transport. This difference is noticeable only if more than one
21951 address from the same message is so handled. In the case of a pipe, the
21952 separate outputs from the different addresses are gathered up and returned to
21953 the sender in a single message, whereas if &(autoreply)& is used, a separate
21954 message is generated for each address that is passed to it.
21955
21956 Non-printing characters are not permitted in the header lines generated for the
21957 message that &(autoreply)& creates, with the exception of newlines that are
21958 immediately followed by white space. If any non-printing characters are found,
21959 the transport defers.
21960 Whether characters with the top bit set count as printing characters or not is
21961 controlled by the &%print_topbitchars%& global option.
21962
21963 If any of the generic options for manipulating headers (for example,
21964 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21965 of the original message that is included in the generated message when
21966 &%return_message%& is set. They do not apply to the generated message itself.
21967
21968 .vindex "&$sender_address$&"
21969 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21970 the message, indicating that there were no recipients, it does not treat this
21971 as an error. This means that autoreplies sent to &$sender_address$& when this
21972 is empty (because the incoming message is a bounce message) do not cause
21973 problems. They are just discarded.
21974
21975
21976
21977 .section "Private options for autoreply" "SECID139"
21978 .cindex "options" "&(autoreply)& transport"
21979
21980 .option bcc autoreply string&!! unset
21981 This specifies the addresses that are to receive &"blind carbon copies"& of the
21982 message when the message is specified by the transport.
21983
21984
21985 .option cc autoreply string&!! unset
21986 This specifies recipients of the message and the contents of the &'Cc:'& header
21987 when the message is specified by the transport.
21988
21989
21990 .option file autoreply string&!! unset
21991 The contents of the file are sent as the body of the message when the message
21992 is specified by the transport. If both &%file%& and &%text%& are set, the text
21993 string comes first.
21994
21995
21996 .option file_expand autoreply boolean false
21997 If this is set, the contents of the file named by the &%file%& option are
21998 subjected to string expansion as they are added to the message.
21999
22000
22001 .option file_optional autoreply boolean false
22002 If this option is true, no error is generated if the file named by the &%file%&
22003 option or passed with the address does not exist or cannot be read.
22004
22005
22006 .option from autoreply string&!! unset
22007 This specifies the contents of the &'From:'& header when the message is
22008 specified by the transport.
22009
22010
22011 .option headers autoreply string&!! unset
22012 This specifies additional RFC 2822 headers that are to be added to the message
22013 when the message is specified by the transport. Several can be given by using
22014 &"\n"& to separate them. There is no check on the format.
22015
22016
22017 .option log autoreply string&!! unset
22018 This option names a file in which a record of every message sent is logged when
22019 the message is specified by the transport.
22020
22021
22022 .option mode autoreply "octal integer" 0600
22023 If either the log file or the &"once"& file has to be created, this mode is
22024 used.
22025
22026
22027 .option never_mail autoreply "address list&!!" unset
22028 If any run of the transport creates a message with a recipient that matches any
22029 item in the list, that recipient is quietly discarded. If all recipients are
22030 discarded, no message is created. This applies both when the recipients are
22031 generated by a filter and when they are specified in the transport.
22032
22033
22034
22035 .option once autoreply string&!! unset
22036 This option names a file or DBM database in which a record of each &'To:'&
22037 recipient is kept when the message is specified by the transport. &*Note*&:
22038 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22039
22040 If &%once%& is unset, or is set to an empty string, the message is always sent.
22041 By default, if &%once%& is set to a non-empty file name, the message
22042 is not sent if a potential recipient is already listed in the database.
22043 However, if the &%once_repeat%& option specifies a time greater than zero, the
22044 message is sent if that much time has elapsed since a message was last sent to
22045 this recipient. A setting of zero time for &%once_repeat%& (the default)
22046 prevents a message from being sent a second time &-- in this case, zero means
22047 infinity.
22048
22049 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22050 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22051 greater than zero, it changes the way Exim implements the &%once%& option.
22052 Instead of using a DBM file to record every recipient it sends to, it uses a
22053 regular file, whose size will never get larger than the given value.
22054
22055 In the file, Exim keeps a linear list of recipient addresses and the times at
22056 which they were sent messages. If the file is full when a new address needs to
22057 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22058 means that a given recipient may receive multiple messages, but at
22059 unpredictable intervals that depend on the rate of turnover of addresses in the
22060 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22061
22062
22063 .option once_file_size autoreply integer 0
22064 See &%once%& above.
22065
22066
22067 .option once_repeat autoreply time&!! 0s
22068 See &%once%& above.
22069 After expansion, the value of this option must be a valid time value.
22070
22071
22072 .option reply_to autoreply string&!! unset
22073 This specifies the contents of the &'Reply-To:'& header when the message is
22074 specified by the transport.
22075
22076
22077 .option return_message autoreply boolean false
22078 If this is set, a copy of the original message is returned with the new
22079 message, subject to the maximum size set in the &%return_size_limit%& global
22080 configuration option.
22081
22082
22083 .option subject autoreply string&!! unset
22084 This specifies the contents of the &'Subject:'& header when the message is
22085 specified by the transport. It is tempting to quote the original subject in
22086 automatic responses. For example:
22087 .code
22088 subject = Re: $h_subject:
22089 .endd
22090 There is a danger in doing this, however. It may allow a third party to
22091 subscribe your users to an opt-in mailing list, provided that the list accepts
22092 bounce messages as subscription confirmations. Well-managed lists require a
22093 non-bounce message to confirm a subscription, so the danger is relatively
22094 small.
22095
22096
22097
22098 .option text autoreply string&!! unset
22099 This specifies a single string to be used as the body of the message when the
22100 message is specified by the transport. If both &%text%& and &%file%& are set,
22101 the text comes first.
22102
22103
22104 .option to autoreply string&!! unset
22105 This specifies recipients of the message and the contents of the &'To:'& header
22106 when the message is specified by the transport.
22107 .ecindex IIDauttra1
22108 .ecindex IIDauttra2
22109
22110
22111
22112
22113 . ////////////////////////////////////////////////////////////////////////////
22114 . ////////////////////////////////////////////////////////////////////////////
22115
22116 .chapter "The lmtp transport" "CHAPLMTP"
22117 .cindex "transports" "&(lmtp)&"
22118 .cindex "&(lmtp)& transport"
22119 .cindex "LMTP" "over a pipe"
22120 .cindex "LMTP" "over a socket"
22121 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22122 specified command
22123 or by interacting with a Unix domain socket.
22124 This transport is something of a cross between the &(pipe)& and &(smtp)&
22125 transports. Exim also has support for using LMTP over TCP/IP; this is
22126 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22127 to be of minority interest, the default build-time configure in &_src/EDITME_&
22128 has it commented out. You need to ensure that
22129 .code
22130 TRANSPORT_LMTP=yes
22131 .endd
22132 .cindex "options" "&(lmtp)& transport"
22133 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22134 included in the Exim binary. The private options of the &(lmtp)& transport are
22135 as follows:
22136
22137 .option batch_id lmtp string&!! unset
22138 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22139
22140
22141 .option batch_max lmtp integer 1
22142 This limits the number of addresses that can be handled in a single delivery.
22143 Most LMTP servers can handle several addresses at once, so it is normally a
22144 good idea to increase this value. See the description of local delivery
22145 batching in chapter &<<CHAPbatching>>&.
22146
22147
22148 .option command lmtp string&!! unset
22149 This option must be set if &%socket%& is not set. The string is a command which
22150 is run in a separate process. It is split up into a command name and list of
22151 arguments, each of which is separately expanded (so expansion cannot change the
22152 number of arguments). The command is run directly, not via a shell. The message
22153 is passed to the new process using the standard input and output to operate the
22154 LMTP protocol.
22155
22156 .option ignore_quota lmtp boolean false
22157 .cindex "LMTP" "ignoring quota errors"
22158 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22159 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22160 in its response to the LHLO command.
22161
22162 .option socket lmtp string&!! unset
22163 This option must be set if &%command%& is not set. The result of expansion must
22164 be the name of a Unix domain socket. The transport connects to the socket and
22165 delivers the message to it using the LMTP protocol.
22166
22167
22168 .option timeout lmtp time 5m
22169 The transport is aborted if the created process or Unix domain socket does not
22170 respond to LMTP commands or message input within this timeout. Delivery
22171 is deferred, and will be tried again later. Here is an example of a typical
22172 LMTP transport:
22173 .code
22174 lmtp:
22175   driver = lmtp
22176   command = /some/local/lmtp/delivery/program
22177   batch_max = 20
22178   user = exim
22179 .endd
22180 This delivers up to 20 addresses at a time, in a mixture of domains if
22181 necessary, running as the user &'exim'&.
22182
22183
22184
22185 . ////////////////////////////////////////////////////////////////////////////
22186 . ////////////////////////////////////////////////////////////////////////////
22187
22188 .chapter "The pipe transport" "CHAPpipetransport"
22189 .scindex IIDpiptra1 "transports" "&(pipe)&"
22190 .scindex IIDpiptra2 "&(pipe)& transport"
22191 The &(pipe)& transport is used to deliver messages via a pipe to a command
22192 running in another process. One example is the use of &(pipe)& as a
22193 pseudo-remote transport for passing messages to some other delivery mechanism
22194 (such as UUCP). Another is the use by individual users to automatically process
22195 their incoming messages. The &(pipe)& transport can be used in one of the
22196 following ways:
22197
22198 .ilist
22199 .vindex "&$local_part$&"
22200 A router routes one address to a transport in the normal way, and the
22201 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22202 contains the local part of the address (as usual), and the command that is run
22203 is specified by the &%command%& option on the transport.
22204 .next
22205 .vindex "&$pipe_addresses$&"
22206 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22207 transport can handle more than one address in a single run. In this case, when
22208 more than one address is routed to the transport, &$local_part$& is not set
22209 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22210 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22211 that are routed to the transport.
22212 .next
22213 .vindex "&$address_pipe$&"
22214 A router redirects an address directly to a pipe command (for example, from an
22215 alias or forward file). In this case, &$address_pipe$& contains the text of the
22216 pipe command, and the &%command%& option on the transport is ignored unless
22217 &%force_command%& is set. If only one address is being transported
22218 (&%batch_max%& is not greater than one, or only one address was redirected to
22219 this pipe command), &$local_part$& contains the local part that was redirected.
22220 .endlist
22221
22222
22223 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22224 deliver messages over pipes using the LMTP interactive protocol. This is
22225 implemented by the &(lmtp)& transport.
22226
22227 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22228 &_.forward_& file, the command runs under the uid and gid of that user. In
22229 other cases, the uid and gid have to be specified explicitly, either on the
22230 transport or on the router that handles the address. Current and &"home"&
22231 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22232 details of the local delivery environment and chapter &<<CHAPbatching>>&
22233 for a discussion of local delivery batching.
22234
22235
22236 .section "Concurrent delivery" "SECID140"
22237 If two messages arrive at almost the same time, and both are routed to a pipe
22238 delivery, the two pipe transports may be run concurrently. You must ensure that
22239 any pipe commands you set up are robust against this happening. If the commands
22240 write to a file, the &%exim_lock%& utility might be of use.
22241
22242
22243
22244
22245 .section "Returned status and data" "SECID141"
22246 .cindex "&(pipe)& transport" "returned data"
22247 If the command exits with a non-zero return code, the delivery is deemed to
22248 have failed, unless either the &%ignore_status%& option is set (in which case
22249 the return code is treated as zero), or the return code is one of those listed
22250 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22251 later"&. In this case, delivery is deferred. Details of a permanent failure are
22252 logged, but are not included in the bounce message, which merely contains
22253 &"local delivery failed"&.
22254
22255 If the command exits on a signal and the &%freeze_signal%& option is set then
22256 the message will be frozen in the queue. If that option is not set, a bounce
22257 will be sent as normal.
22258
22259 If the return code is greater than 128 and the command being run is a shell
22260 script, it normally means that the script was terminated by a signal whose
22261 value is the return code minus 128. The &%freeze_signal%& option does not
22262 apply in this case.
22263
22264 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22265 return code is set to 127. This is the value that a shell returns if it is
22266 asked to run a non-existent command. The wording for the log line suggests that
22267 a non-existent command may be the problem.
22268
22269 The &%return_output%& option can affect the result of a pipe delivery. If it is
22270 set and the command produces any output on its standard output or standard
22271 error streams, the command is considered to have failed, even if it gave a zero
22272 return code or if &%ignore_status%& is set. The output from the command is
22273 included as part of the bounce message. The &%return_fail_output%& option is
22274 similar, except that output is returned only when the command exits with a
22275 failure return code, that is, a value other than zero or a code that matches
22276 &%temp_errors%&.
22277
22278
22279
22280 .section "How the command is run" "SECThowcommandrun"
22281 .cindex "&(pipe)& transport" "path for command"
22282 The command line is (by default) broken down into a command name and arguments
22283 by the &(pipe)& transport itself. The &%allow_commands%& and
22284 &%restrict_to_path%& options can be used to restrict the commands that may be
22285 run.
22286
22287 .cindex "quoting" "in pipe command"
22288 Unquoted arguments are delimited by white space. If an argument appears in
22289 double quotes, backslash is interpreted as an escape character in the usual
22290 way. If an argument appears in single quotes, no escaping is done.
22291
22292 String expansion is applied to the command line except when it comes from a
22293 traditional &_.forward_& file (commands from a filter file are expanded). The
22294 expansion is applied to each argument in turn rather than to the whole line.
22295 For this reason, any string expansion item that contains white space must be
22296 quoted so as to be contained within a single argument. A setting such as
22297 .code
22298 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22299 .endd
22300 will not work, because the expansion item gets split between several
22301 arguments. You have to write
22302 .code
22303 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22304 .endd
22305 to ensure that it is all in one argument. The expansion is done in this way,
22306 argument by argument, so that the number of arguments cannot be changed as a
22307 result of expansion, and quotes or backslashes in inserted variables do not
22308 interact with external quoting. However, this leads to problems if you want to
22309 generate multiple arguments (or the command name plus arguments) from a single
22310 expansion. In this situation, the simplest solution is to use a shell. For
22311 example:
22312 .code
22313 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22314 .endd
22315
22316 .cindex "transport" "filter"
22317 .cindex "filter" "transport filter"
22318 .vindex "&$pipe_addresses$&"
22319 Special handling takes place when an argument consists of precisely the text
22320 &`$pipe_addresses`&. This is not a general expansion variable; the only
22321 place this string is recognized is when it appears as an argument for a pipe or
22322 transport filter command. It causes each address that is being handled to be
22323 inserted in the argument list at that point &'as a separate argument'&. This
22324 avoids any problems with spaces or shell metacharacters, and is of use when a
22325 &(pipe)& transport is handling groups of addresses in a batch.
22326
22327 If &%force_command%& is enabled on the transport, Special handling takes place
22328 for an argument that consists of precisely the text &`$address_pipe`&.  It
22329 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22330 argument is inserted in the argument list at that point
22331 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22332 the only item in the argument; in fact, if it were then &%force_command%&
22333 should behave as a no-op.  Rather, it should be used to adjust the command
22334 run while preserving the argument vector separation.
22335
22336 After splitting up into arguments and expansion, the resulting command is run
22337 in a subprocess directly from the transport, &'not'& under a shell. The
22338 message that is being delivered is supplied on the standard input, and the
22339 standard output and standard error are both connected to a single pipe that is
22340 read by Exim. The &%max_output%& option controls how much output the command
22341 may produce, and the &%return_output%& and &%return_fail_output%& options
22342 control what is done with it.
22343
22344 Not running the command under a shell (by default) lessens the security risks
22345 in cases when a command from a user's filter file is built out of data that was
22346 taken from an incoming message. If a shell is required, it can of course be
22347 explicitly specified as the command to be run. However, there are circumstances
22348 where existing commands (for example, in &_.forward_& files) expect to be run
22349 under a shell and cannot easily be modified. To allow for these cases, there is
22350 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22351 works. Instead of breaking up the command line as just described, it expands it
22352 as a single string and passes the result to &_/bin/sh_&. The
22353 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22354 with &%use_shell%&, and the whole mechanism is inherently less secure.
22355
22356
22357
22358 .section "Environment variables" "SECTpipeenv"
22359 .cindex "&(pipe)& transport" "environment for command"
22360 .cindex "environment for pipe transport"
22361 The environment variables listed below are set up when the command is invoked.
22362 This list is a compromise for maximum compatibility with other MTAs. Note that
22363 the &%environment%& option can be used to add additional variables to this
22364 environment.
22365 .display
22366 &`DOMAIN            `&   the domain of the address
22367 &`HOME              `&   the home directory, if set
22368 &`HOST              `&   the host name when called from a router (see below)
22369 &`LOCAL_PART        `&   see below
22370 &`LOCAL_PART_PREFIX `&   see below
22371 &`LOCAL_PART_SUFFIX `&   see below
22372 &`LOGNAME           `&   see below
22373 &`MESSAGE_ID        `&   Exim's local ID for the message
22374 &`PATH              `&   as specified by the &%path%& option below
22375 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22376 &`RECIPIENT         `&   the complete recipient address
22377 &`SENDER            `&   the sender of the message (empty if a bounce)
22378 &`SHELL             `&   &`/bin/sh`&
22379 &`TZ                `&   the value of the &%timezone%& option, if set
22380 &`USER              `&   see below
22381 .endd
22382 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22383 router, LOCAL_PART is set to the local part of the address. When it is
22384 called as a result of a forward or alias expansion, LOCAL_PART is set to
22385 the local part of the address that was expanded. In both cases, any affixes are
22386 removed from the local part, and made available in LOCAL_PART_PREFIX and
22387 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22388 same value as LOCAL_PART for compatibility with other MTAs.
22389
22390 .cindex "HOST"
22391 HOST is set only when a &(pipe)& transport is called from a router that
22392 associates hosts with an address, typically when using &(pipe)& as a
22393 pseudo-remote transport. HOST is set to the first host name specified by
22394 the router.
22395
22396 .cindex "HOME"
22397 If the transport's generic &%home_directory%& option is set, its value is used
22398 for the HOME environment variable. Otherwise, a home directory may be set
22399 by the router's &%transport_home_directory%& option, which defaults to the
22400 user's home directory if &%check_local_user%& is set.
22401
22402
22403 .section "Private options for pipe" "SECID142"
22404 .cindex "options" "&(pipe)& transport"
22405
22406
22407
22408 .option allow_commands pipe "string list&!!" unset
22409 .cindex "&(pipe)& transport" "permitted commands"
22410 The string is expanded, and is then interpreted as a colon-separated list of
22411 permitted commands. If &%restrict_to_path%& is not set, the only commands
22412 permitted are those in the &%allow_commands%& list. They need not be absolute
22413 paths; the &%path%& option is still used for relative paths. If
22414 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22415 in the &%allow_commands%& list, or a name without any slashes that is found on
22416 the path. In other words, if neither &%allow_commands%& nor
22417 &%restrict_to_path%& is set, there is no restriction on the command, but
22418 otherwise only commands that are permitted by one or the other are allowed. For
22419 example, if
22420 .code
22421 allow_commands = /usr/bin/vacation
22422 .endd
22423 and &%restrict_to_path%& is not set, the only permitted command is
22424 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22425 &%use_shell%& is set.
22426
22427
22428 .option batch_id pipe string&!! unset
22429 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22430
22431
22432 .option batch_max pipe integer 1
22433 This limits the number of addresses that can be handled in a single delivery.
22434 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22435
22436
22437 .option check_string pipe string unset
22438 As &(pipe)& writes the message, the start of each line is tested for matching
22439 &%check_string%&, and if it does, the initial matching characters are replaced
22440 by the contents of &%escape_string%&, provided both are set. The value of
22441 &%check_string%& is a literal string, not a regular expression, and the case of
22442 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22443 of &%check_string%& and &%escape_string%& are forced to values that implement
22444 the SMTP escaping protocol. Any settings made in the configuration file are
22445 ignored.
22446
22447
22448 .option command pipe string&!! unset
22449 This option need not be set when &(pipe)& is being used to deliver to pipes
22450 obtained directly from address redirections. In other cases, the option must be
22451 set, to provide a command to be run. It need not yield an absolute path (see
22452 the &%path%& option below). The command is split up into separate arguments by
22453 Exim, and each argument is separately expanded, as described in section
22454 &<<SECThowcommandrun>>& above.
22455
22456
22457 .option environment pipe string&!! unset
22458 .cindex "&(pipe)& transport" "environment for command"
22459 .cindex "environment for &(pipe)& transport"
22460 This option is used to add additional variables to the environment in which the
22461 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22462 a string which is expanded, and then interpreted as a colon-separated list of
22463 environment settings of the form <&'name'&>=<&'value'&>.
22464
22465
22466 .option escape_string pipe string unset
22467 See &%check_string%& above.
22468
22469
22470 .option freeze_exec_fail pipe boolean false
22471 .cindex "exec failure"
22472 .cindex "failure of exec"
22473 .cindex "&(pipe)& transport" "failure of exec"
22474 Failure to exec the command in a pipe transport is by default treated like
22475 any other failure while running the command. However, if &%freeze_exec_fail%&
22476 is set, failure to exec is treated specially, and causes the message to be
22477 frozen, whatever the setting of &%ignore_status%&.
22478
22479
22480 .option freeze_signal pipe boolean false
22481 .cindex "signal exit"
22482 .cindex "&(pipe)& transport", "signal exit"
22483 Normally if the process run by a command in a pipe transport exits on a signal,
22484 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22485 frozen in Exim's queue instead.
22486
22487
22488 .option force_command pipe boolean false
22489 .cindex "force command"
22490 .cindex "&(pipe)& transport", "force command"
22491 Normally when a router redirects an address directly to a pipe command
22492 the &%command%& option on the transport is ignored.  If &%force_command%&
22493 is set, the &%command%& option will used. This is especially
22494 useful for forcing a wrapper or additional argument to be added to the
22495 command. For example:
22496 .code
22497 command = /usr/bin/remote_exec myhost -- $address_pipe
22498 force_command
22499 .endd
22500
22501 Note that &$address_pipe$& is handled specially in &%command%& when
22502 &%force_command%& is set, expanding out to the original argument vector as
22503 separate items, similarly to a Unix shell &`"$@"`& construct.
22504
22505 .option ignore_status pipe boolean false
22506 If this option is true, the status returned by the subprocess that is set up to
22507 run the command is ignored, and Exim behaves as if zero had been returned.
22508 Otherwise, a non-zero status or termination by signal causes an error return
22509 from the transport unless the status value is one of those listed in
22510 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22511
22512 &*Note*&: This option does not apply to timeouts, which do not return a status.
22513 See the &%timeout_defer%& option for how timeouts are handled.
22514
22515 .option log_defer_output pipe boolean false
22516 .cindex "&(pipe)& transport" "logging output"
22517 If this option is set, and the status returned by the command is
22518 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22519 and any output was produced, the first line of it is written to the main log.
22520
22521
22522 .option log_fail_output pipe boolean false
22523 If this option is set, and the command returns any output, and also ends with a
22524 return code that is neither zero nor one of the return codes listed in
22525 &%temp_errors%& (that is, the delivery failed), the first line of output is
22526 written to the main log. This option and &%log_output%& are mutually exclusive.
22527 Only one of them may be set.
22528
22529
22530
22531 .option log_output pipe boolean false
22532 If this option is set and the command returns any output, the first line of
22533 output is written to the main log, whatever the return code. This option and
22534 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22535
22536
22537
22538 .option max_output pipe integer 20K
22539 This specifies the maximum amount of output that the command may produce on its
22540 standard output and standard error file combined. If the limit is exceeded, the
22541 process running the command is killed. This is intended as a safety measure to
22542 catch runaway processes. The limit is applied independently of the settings of
22543 the options that control what is done with such output (for example,
22544 &%return_output%&). Because of buffering effects, the amount of output may
22545 exceed the limit by a small amount before Exim notices.
22546
22547
22548 .option message_prefix pipe string&!! "see below"
22549 The string specified here is expanded and output at the start of every message.
22550 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22551 .code
22552 message_prefix = \
22553   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22554   ${tod_bsdinbox}\n
22555 .endd
22556 .cindex "Cyrus"
22557 .cindex "&%tmail%&"
22558 .cindex "&""From""& line"
22559 This is required by the commonly used &_/usr/bin/vacation_& program.
22560 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22561 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22562 setting
22563 .code
22564 message_prefix =
22565 .endd
22566 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22567 &`\n`& to &`\r\n`& in &%message_prefix%&.
22568
22569
22570 .option message_suffix pipe string&!! "see below"
22571 The string specified here is expanded and output at the end of every message.
22572 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22573 The suffix can be suppressed by setting
22574 .code
22575 message_suffix =
22576 .endd
22577 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22578 &`\n`& to &`\r\n`& in &%message_suffix%&.
22579
22580
22581 .option path pipe string "see below"
22582 This option specifies the string that is set up in the PATH environment
22583 variable of the subprocess. The default is:
22584 .code
22585 /bin:/usr/bin
22586 .endd
22587 If the &%command%& option does not yield an absolute path name, the command is
22588 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22589 apply to a command specified as a transport filter.
22590
22591
22592 .option permit_coredump pipe boolean false
22593 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22594 a core-dump of a pipe command, enable this command.  This enables core-dumps
22595 during delivery and affects both the Exim binary and the pipe command run.
22596 It is recommended that this option remain off unless and until you have a need
22597 for it and that this only be enabled when needed, as the risk of excessive
22598 resource consumption can be quite high.  Note also that Exim is typically
22599 installed as a setuid binary and most operating systems will inhibit coredumps
22600 of these by default, so further OS-specific action may be required.
22601
22602
22603 .option pipe_as_creator pipe boolean false
22604 .cindex "uid (user id)" "local delivery"
22605 If the generic &%user%& option is not set and this option is true, the delivery
22606 process is run under the uid that was in force when Exim was originally called
22607 to accept the message. If the group id is not otherwise set (via the generic
22608 &%group%& option), the gid that was in force when Exim was originally called to
22609 accept the message is used.
22610
22611
22612 .option restrict_to_path pipe boolean false
22613 When this option is set, any command name not listed in &%allow_commands%& must
22614 contain no slashes. The command is searched for only in the directories listed
22615 in the &%path%& option. This option is intended for use in the case when a pipe
22616 command has been generated from a user's &_.forward_& file. This is usually
22617 handled by a &(pipe)& transport called &%address_pipe%&.
22618
22619
22620 .option return_fail_output pipe boolean false
22621 If this option is true, and the command produced any output and ended with a
22622 return code other than zero or one of the codes listed in &%temp_errors%& (that
22623 is, the delivery failed), the output is returned in the bounce message.
22624 However, if the message has a null sender (that is, it is itself a bounce
22625 message), output from the command is discarded. This option and
22626 &%return_output%& are mutually exclusive. Only one of them may be set.
22627
22628
22629
22630 .option return_output pipe boolean false
22631 If this option is true, and the command produced any output, the delivery is
22632 deemed to have failed whatever the return code from the command, and the output
22633 is returned in the bounce message. Otherwise, the output is just discarded.
22634 However, if the message has a null sender (that is, it is a bounce message),
22635 output from the command is always discarded, whatever the setting of this
22636 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22637 of them may be set.
22638
22639
22640
22641 .option temp_errors pipe "string list" "see below"
22642 .cindex "&(pipe)& transport" "temporary failure"
22643 This option contains either a colon-separated list of numbers, or a single
22644 asterisk. If &%ignore_status%& is false
22645 and &%return_output%& is not set,
22646 and the command exits with a non-zero return code, the failure is treated as
22647 temporary and the delivery is deferred if the return code matches one of the
22648 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22649 codes are treated as permanent errors. The default setting contains the codes
22650 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22651 compiled on a system that does not define these macros, it assumes values of 75
22652 and 73, respectively.
22653
22654
22655 .option timeout pipe time 1h
22656 If the command fails to complete within this time, it is killed. This normally
22657 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22658 specifies no timeout. In order to ensure that any subprocesses created by the
22659 command are also killed, Exim makes the initial process a process group leader,
22660 and kills the whole process group on a timeout. However, this can be defeated
22661 if one of the processes starts a new process group.
22662
22663 .option timeout_defer pipe boolean false
22664 A timeout in a &(pipe)& transport, either in the command that the transport
22665 runs, or in a transport filter that is associated with it, is by default
22666 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22667 is set true, both kinds of timeout become temporary errors, causing the
22668 delivery to be deferred.
22669
22670 .option umask pipe "octal integer" 022
22671 This specifies the umask setting for the subprocess that runs the command.
22672
22673
22674 .option use_bsmtp pipe boolean false
22675 .cindex "envelope sender"
22676 If this option is set true, the &(pipe)& transport writes messages in &"batch
22677 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22678 commands. If you want to include a leading HELO command with such messages,
22679 you can do so by setting the &%message_prefix%& option. See section
22680 &<<SECTbatchSMTP>>& for details of batch SMTP.
22681
22682 .option use_classresources pipe boolean false
22683 .cindex "class resources (BSD)"
22684 This option is available only when Exim is running on FreeBSD, NetBSD, or
22685 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22686 resource limits when a &(pipe)& transport is run to perform a delivery. The
22687 limits for the uid under which the pipe is to run are obtained from the login
22688 class database.
22689
22690
22691 .option use_crlf pipe boolean false
22692 .cindex "carriage return"
22693 .cindex "linefeed"
22694 This option causes lines to be terminated with the two-character CRLF sequence
22695 (carriage return, linefeed) instead of just a linefeed character. In the case
22696 of batched SMTP, the byte sequence written to the pipe is then an exact image
22697 of what would be sent down a real SMTP connection.
22698
22699 The contents of the &%message_prefix%& and &%message_suffix%& options are
22700 written verbatim, so must contain their own carriage return characters if these
22701 are needed. When &%use_bsmtp%& is not set, the default values for both
22702 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22703 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22704
22705
22706 .option use_shell pipe boolean false
22707 .vindex "&$pipe_addresses$&"
22708 If this option is set, it causes the command to be passed to &_/bin/sh_&
22709 instead of being run directly from the transport, as described in section
22710 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22711 where the command is expected to be run under a shell and cannot easily be
22712 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22713 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22714 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22715 its &%-c%& option.
22716
22717
22718
22719 .section "Using an external local delivery agent" "SECID143"
22720 .cindex "local delivery" "using an external agent"
22721 .cindex "&'procmail'&"
22722 .cindex "external local delivery"
22723 .cindex "delivery" "&'procmail'&"
22724 .cindex "delivery" "by external agent"
22725 The &(pipe)& transport can be used to pass all messages that require local
22726 delivery to a separate local delivery agent such as &%procmail%&. When doing
22727 this, care must be taken to ensure that the pipe is run under an appropriate
22728 uid and gid. In some configurations one wants this to be a uid that is trusted
22729 by the delivery agent to supply the correct sender of the message. It may be
22730 necessary to recompile or reconfigure the delivery agent so that it trusts an
22731 appropriate user. The following is an example transport and router
22732 configuration for &%procmail%&:
22733 .code
22734 # transport
22735 procmail_pipe:
22736   driver = pipe
22737   command = /usr/local/bin/procmail -d $local_part
22738   return_path_add
22739   delivery_date_add
22740   envelope_to_add
22741   check_string = "From "
22742   escape_string = ">From "
22743   umask = 077
22744   user = $local_part
22745   group = mail
22746
22747 # router
22748 procmail:
22749   driver = accept
22750   check_local_user
22751   transport = procmail_pipe
22752 .endd
22753 In this example, the pipe is run as the local user, but with the group set to
22754 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22755 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22756 user to supply a correct sender address. If you do not specify either a
22757 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22758 home directory is the user's home directory by default.
22759
22760 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22761 .code
22762 IFS=" "
22763 .endd
22764 as shown in some &%procmail%& documentation, because Exim does not by default
22765 use a shell to run pipe commands.
22766
22767 .cindex "Cyrus"
22768 The next example shows a transport and a router for a system where local
22769 deliveries are handled by the Cyrus IMAP server.
22770 .code
22771 # transport
22772 local_delivery_cyrus:
22773   driver = pipe
22774   command = /usr/cyrus/bin/deliver \
22775             -m ${substr_1:$local_part_suffix} -- $local_part
22776   user = cyrus
22777   group = mail
22778   return_output
22779   log_output
22780   message_prefix =
22781   message_suffix =
22782
22783 # router
22784 local_user_cyrus:
22785   driver = accept
22786   check_local_user
22787   local_part_suffix = .*
22788   transport = local_delivery_cyrus
22789 .endd
22790 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22791 &%return_output%& to cause any text written by Cyrus to be returned to the
22792 sender.
22793 .ecindex IIDpiptra1
22794 .ecindex IIDpiptra2
22795
22796
22797 . ////////////////////////////////////////////////////////////////////////////
22798 . ////////////////////////////////////////////////////////////////////////////
22799
22800 .chapter "The smtp transport" "CHAPsmtptrans"
22801 .scindex IIDsmttra1 "transports" "&(smtp)&"
22802 .scindex IIDsmttra2 "&(smtp)& transport"
22803 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22804 or LMTP protocol. The list of hosts to try can either be taken from the address
22805 that is being processed (having been set up by the router), or specified
22806 explicitly for the transport. Timeout and retry processing (see chapter
22807 &<<CHAPretry>>&) is applied to each IP address independently.
22808
22809
22810 .section "Multiple messages on a single connection" "SECID144"
22811 The sending of multiple messages over a single TCP/IP connection can arise in
22812 two ways:
22813
22814 .ilist
22815 If a message contains more than &%max_rcpt%& (see below) addresses that are
22816 routed to the same host, more than one copy of the message has to be sent to
22817 that host. In this situation, multiple copies may be sent in a single run of
22818 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22819 does when it has too many addresses to send in one message also depends on the
22820 value of the global &%remote_max_parallel%& option. Details are given in
22821 section &<<SECToutSMTPTCP>>&.)
22822 .next
22823 .cindex "hints database" "remembering routing"
22824 When a message has been successfully delivered over a TCP/IP connection, Exim
22825 looks in its hints database to see if there are any other messages awaiting a
22826 connection to the same host. If there are, a new delivery process is started
22827 for one of them, and the current TCP/IP connection is passed on to it. The new
22828 process may in turn send multiple copies and possibly create yet another
22829 process.
22830 .endlist
22831
22832
22833 For each copy sent over the same TCP/IP connection, a sequence counter is
22834 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22835 no further messages are sent over that connection.
22836
22837
22838
22839 .section "Use of the $host and $host_address variables" "SECID145"
22840 .vindex "&$host$&"
22841 .vindex "&$host_address$&"
22842 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22843 &$host_address$& are the name and IP address of the first host on the host list
22844 passed by the router. However, when the transport is about to connect to a
22845 specific host, and while it is connected to that host, &$host$& and
22846 &$host_address$& are set to the values for that host. These are the values
22847 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22848 &%serialize_hosts%&, and the various TLS options are expanded.
22849
22850
22851 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22852 .vindex &$tls_bits$&
22853 .vindex &$tls_cipher$&
22854 .vindex &$tls_peerdn$&
22855 .vindex &$tls_sni$&
22856 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22857 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22858 are the values that were set when the message was received.
22859 These are the values that are used for options that are expanded before any
22860 SMTP connections are made. Just before each connection is made, these four
22861 variables are emptied. If TLS is subsequently started, they are set to the
22862 appropriate values for the outgoing connection, and these are the values that
22863 are in force when any authenticators are run and when the
22864 &%authenticated_sender%& option is expanded.
22865
22866 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22867 and will be removed in a future release.
22868
22869
22870 .section "Private options for smtp" "SECID146"
22871 .cindex "options" "&(smtp)& transport"
22872 The private options of the &(smtp)& transport are as follows:
22873
22874
22875 .option address_retry_include_sender smtp boolean true
22876 .cindex "4&'xx'& responses" "retrying after"
22877 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22878 is the combination of sender and recipient that is delayed in subsequent queue
22879 runs until the retry time is reached. You can delay the recipient without
22880 reference to the sender (which is what earlier versions of Exim did), by
22881 setting &%address_retry_include_sender%& false. However, this can lead to
22882 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22883
22884 .option allow_localhost smtp boolean false
22885 .cindex "local host" "sending to"
22886 .cindex "fallback" "hosts specified on transport"
22887 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22888 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22889 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22890 the delivery anyway. This should be used only in special cases when the
22891 configuration ensures that no looping will result (for example, a differently
22892 configured Exim is listening on the port to which the message is sent).
22893
22894
22895 .option authenticated_sender smtp string&!! unset
22896 .cindex "Cyrus"
22897 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22898 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22899 overriding any existing authenticated sender value. If the string expansion is
22900 forced to fail, the option is ignored. Other expansion failures cause delivery
22901 to be deferred. If the result of expansion is an empty string, that is also
22902 ignored.
22903
22904 The expansion happens after the outgoing connection has been made and TLS
22905 started, if required. This means that the &$host$&, &$host_address$&,
22906 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22907 particular connection.
22908
22909 If the SMTP session is not authenticated, the expansion of
22910 &%authenticated_sender%& still happens (and can cause the delivery to be
22911 deferred if it fails), but no AUTH= item is added to MAIL commands
22912 unless &%authenticated_sender_force%& is true.
22913
22914 This option allows you to use the &(smtp)& transport in LMTP mode to
22915 deliver mail to Cyrus IMAP and provide the proper local part as the
22916 &"authenticated sender"&, via a setting such as:
22917 .code
22918 authenticated_sender = $local_part
22919 .endd
22920 This removes the need for IMAP subfolders to be assigned special ACLs to
22921 allow direct delivery to those subfolders.
22922
22923 Because of expected uses such as that just described for Cyrus (when no
22924 domain is involved), there is no checking on the syntax of the provided
22925 value.
22926
22927
22928 .option authenticated_sender_force smtp boolean false
22929 If this option is set true, the &%authenticated_sender%& option's value
22930 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22931 authenticated as a client.
22932
22933
22934 .option command_timeout smtp time 5m
22935 This sets a timeout for receiving a response to an SMTP command that has been
22936 sent out. It is also used when waiting for the initial banner line from the
22937 remote host. Its value must not be zero.
22938
22939
22940 .option connect_timeout smtp time 5m
22941 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22942 to a remote host. A setting of zero allows the system timeout (typically
22943 several minutes) to act. To have any effect, the value of this option must be
22944 less than the system timeout. However, it has been observed that on some
22945 systems there is no system timeout, which is why the default value for this
22946 option is 5 minutes, a value recommended by RFC 1123.
22947
22948
22949 .option connection_max_messages smtp integer 500
22950 .cindex "SMTP" "passed connection"
22951 .cindex "SMTP" "multiple deliveries"
22952 .cindex "multiple SMTP deliveries"
22953 This controls the maximum number of separate message deliveries that are sent
22954 over a single TCP/IP connection. If the value is zero, there is no limit.
22955 For testing purposes, this value can be overridden by the &%-oB%& command line
22956 option.
22957
22958
22959 .option data_timeout smtp time 5m
22960 This sets a timeout for the transmission of each block in the data portion of
22961 the message. As a result, the overall timeout for a message depends on the size
22962 of the message. Its value must not be zero. See also &%final_timeout%&.
22963
22964
22965 .option delay_after_cutoff smtp boolean true
22966 This option controls what happens when all remote IP addresses for a given
22967 domain have been inaccessible for so long that they have passed their retry
22968 cutoff times.
22969
22970 In the default state, if the next retry time has not been reached for any of
22971 them, the address is bounced without trying any deliveries. In other words,
22972 Exim delays retrying an IP address after the final cutoff time until a new
22973 retry time is reached, and can therefore bounce an address without ever trying
22974 a delivery, when machines have been down for a long time. Some people are
22975 unhappy at this prospect, so...
22976
22977 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22978 addresses are past their final cutoff time, Exim tries to deliver to those
22979 IP addresses that have not been tried since the message arrived. If there are
22980 none, of if they all fail, the address is bounced. In other words, it does not
22981 delay when a new message arrives, but immediately tries those expired IP
22982 addresses that haven't been tried since the message arrived. If there is a
22983 continuous stream of messages for the dead hosts, unsetting
22984 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22985 to them.
22986
22987
22988 .option dns_qualify_single smtp boolean true
22989 If the &%hosts%& or &%fallback_hosts%& option is being used,
22990 and the &%gethostbyname%& option is false,
22991 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22992 in chapter &<<CHAPdnslookup>>& for more details.
22993
22994
22995 .option dns_search_parents smtp boolean false
22996 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22997 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22998 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22999 details.
23000
23001
23002 .option dnssec_request_domains smtp "domain list&!!" unset
23003 .cindex "MX record" "security"
23004 .cindex "DNSSEC" "MX lookup"
23005 .cindex "security" "MX lookup"
23006 .cindex "DNS" "DNSSEC"
23007 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23008 the dnssec request bit set.
23009 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23010
23011
23012
23013 .option dnssec_require_domains smtp "domain list&!!" unset
23014 .cindex "MX record" "security"
23015 .cindex "DNSSEC" "MX lookup"
23016 .cindex "security" "MX lookup"
23017 .cindex "DNS" "DNSSEC"
23018 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23019 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23020 (AD bit) set wil be ignored and logged as a host-lookup failure.
23021 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23022
23023
23024
23025 .option dscp smtp string&!! unset
23026 .cindex "DCSP" "outbound"
23027 This option causes the DSCP value associated with a socket to be set to one
23028 of a number of fixed strings or to numeric value.
23029 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23030 Common values include &`throughput`&, &`mincost`&, and on newer systems
23031 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23032
23033 The outbound packets from Exim will be marked with this value in the header
23034 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23035 that these values will have any effect, not be stripped by networking
23036 equipment, or do much of anything without cooperation with your Network
23037 Engineer and those of all network operators between the source and destination.
23038
23039
23040 .option fallback_hosts smtp "string list" unset
23041 .cindex "fallback" "hosts specified on transport"
23042 String expansion is not applied to this option. The argument must be a
23043 colon-separated list of host names or IP addresses, optionally also including
23044 port numbers, though the separator can be changed, as described in section
23045 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23046 item in a &%route_list%& setting for the &(manualroute)& router, as described
23047 in section &<<SECTformatonehostitem>>&.
23048
23049 Fallback hosts can also be specified on routers, which associate them with the
23050 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23051 &%fallback_hosts%& specified on the transport is used only if the address does
23052 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23053 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23054 However, &%hosts_randomize%& does apply to fallback host lists.
23055
23056 If Exim is unable to deliver to any of the hosts for a particular address, and
23057 the errors are not permanent rejections, the address is put on a separate
23058 transport queue with its host list replaced by the fallback hosts, unless the
23059 address was routed via MX records and the current host was in the original MX
23060 list. In that situation, the fallback host list is not used.
23061
23062 Once normal deliveries are complete, the fallback queue is delivered by
23063 re-running the same transports with the new host lists. If several failing
23064 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23065 copy of the message is sent.
23066
23067 The resolution of the host names on the fallback list is controlled by the
23068 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23069 both to cases when the host list comes with the address and when it is taken
23070 from &%hosts%&. This option provides a &"use a smart host only if delivery
23071 fails"& facility.
23072
23073
23074 .option final_timeout smtp time 10m
23075 This is the timeout that applies while waiting for the response to the final
23076 line containing just &"."& that terminates a message. Its value must not be
23077 zero.
23078
23079 .option gethostbyname smtp boolean false
23080 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23081 being used, names are looked up using &[gethostbyname()]&
23082 (or &[getipnodebyname()]& when available)
23083 instead of using the DNS. Of course, that function may in fact use the DNS, but
23084 it may also consult other sources of information such as &_/etc/hosts_&.
23085
23086 .option gnutls_compat_mode smtp boolean unset
23087 This option controls whether GnuTLS is used in compatibility mode in an Exim
23088 server. This reduces security slightly, but improves interworking with older
23089 implementations of TLS.
23090
23091 .option helo_data smtp string&!! "see below"
23092 .cindex "HELO" "argument, setting"
23093 .cindex "EHLO" "argument, setting"
23094 .cindex "LHLO argument setting"
23095 The value of this option is expanded after a connection to a another host has
23096 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23097 command that starts the outgoing SMTP or LMTP session. The default value of the
23098 option is:
23099 .code
23100 $primary_hostname
23101 .endd
23102 During the expansion, the variables &$host$& and &$host_address$& are set to
23103 the identity of the remote host, and the variables &$sending_ip_address$& and
23104 &$sending_port$& are set to the local IP address and port number that are being
23105 used. These variables can be used to generate different values for different
23106 servers or different local IP addresses. For example, if you want the string
23107 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23108 interface address, you could use this:
23109 .code
23110 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23111   {$primary_hostname}}
23112 .endd
23113 The use of &%helo_data%& applies both to sending messages and when doing
23114 callouts.
23115
23116 .option hosts smtp "string list&!!" unset
23117 Hosts are associated with an address by a router such as &(dnslookup)&, which
23118 finds the hosts by looking up the address domain in the DNS, or by
23119 &(manualroute)&, which has lists of hosts in its configuration. However,
23120 email addresses can be passed to the &(smtp)& transport by any router, and not
23121 all of them can provide an associated list of hosts.
23122
23123 The &%hosts%& option specifies a list of hosts to be used if the address being
23124 processed does not have any hosts associated with it. The hosts specified by
23125 &%hosts%& are also used, whether or not the address has its own hosts, if
23126 &%hosts_override%& is set.
23127
23128 The string is first expanded, before being interpreted as a colon-separated
23129 list of host names or IP addresses, possibly including port numbers. The
23130 separator may be changed to something other than colon, as described in section
23131 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23132 item in a &%route_list%& setting for the &(manualroute)& router, as described
23133 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23134 of the &(manualroute)& router is not available here.
23135
23136 If the expansion fails, delivery is deferred. Unless the failure was caused by
23137 the inability to complete a lookup, the error is logged to the panic log as
23138 well as the main log. Host names are looked up either by searching directly for
23139 address records in the DNS or by calling &[gethostbyname()]& (or
23140 &[getipnodebyname()]& when available), depending on the setting of the
23141 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23142 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23143 address are used.
23144
23145 During delivery, the hosts are tried in order, subject to their retry status,
23146 unless &%hosts_randomize%& is set.
23147
23148
23149 .option hosts_avoid_esmtp smtp "host list&!!" unset
23150 .cindex "ESMTP, avoiding use of"
23151 .cindex "HELO" "forcing use of"
23152 .cindex "EHLO" "avoiding use of"
23153 .cindex "PIPELINING" "avoiding the use of"
23154 This option is for use with broken hosts that announce ESMTP facilities (for
23155 example, PIPELINING) and then fail to implement them properly. When a host
23156 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23157 start of the SMTP session. This means that it cannot use any of the ESMTP
23158 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23159
23160
23161 .option hosts_avoid_pipelining smtp "host list&!!" unset
23162 .cindex "PIPELINING" "avoiding the use of"
23163 Exim will not use the SMTP PIPELINING extension when delivering to any host
23164 that matches this list, even if the server host advertises PIPELINING support.
23165
23166
23167 .option hosts_avoid_tls smtp "host list&!!" unset
23168 .cindex "TLS" "avoiding for certain hosts"
23169 Exim will not try to start a TLS session when delivering to any host that
23170 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23171
23172 .option hosts_verify_avoid_tls smtp "host list&!!" *
23173 .cindex "TLS" "avoiding for certain hosts"
23174 Exim will not try to start a TLS session for a verify callout,
23175 or when delivering in cutthrough mode,
23176 to any host that matches this list.
23177 Note that the default is to not use TLS.
23178
23179
23180 .option hosts_max_try smtp integer 5
23181 .cindex "host" "maximum number to try"
23182 .cindex "limit" "number of hosts tried"
23183 .cindex "limit" "number of MX tried"
23184 .cindex "MX record" "maximum tried"
23185 This option limits the number of IP addresses that are tried for any one
23186 delivery in cases where there are temporary delivery errors. Section
23187 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23188
23189
23190 .option hosts_max_try_hardlimit smtp integer 50
23191 This is an additional check on the maximum number of IP addresses that Exim
23192 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23193 why it exists.
23194
23195
23196
23197 .option hosts_nopass_tls smtp "host list&!!" unset
23198 .cindex "TLS" "passing connection"
23199 .cindex "multiple SMTP deliveries"
23200 .cindex "TLS" "multiple message deliveries"
23201 For any host that matches this list, a connection on which a TLS session has
23202 been started will not be passed to a new delivery process for sending another
23203 message on the same connection. See section &<<SECTmulmessam>>& for an
23204 explanation of when this might be needed.
23205
23206
23207 .option hosts_override smtp boolean false
23208 If this option is set and the &%hosts%& option is also set, any hosts that are
23209 attached to the address are ignored, and instead the hosts specified by the
23210 &%hosts%& option are always used. This option does not apply to
23211 &%fallback_hosts%&.
23212
23213
23214 .option hosts_randomize smtp boolean false
23215 .cindex "randomized host list"
23216 .cindex "host" "list of; randomized"
23217 .cindex "fallback" "randomized hosts"
23218 If this option is set, and either the list of hosts is taken from the
23219 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23220 were not obtained from MX records (this includes fallback hosts from the
23221 router), and were not randomized by the router, the order of trying the hosts
23222 is randomized each time the transport runs. Randomizing the order of a host
23223 list can be used to do crude load sharing.
23224
23225 When &%hosts_randomize%& is true, a host list may be split into groups whose
23226 order is separately randomized. This makes it possible to set up MX-like
23227 behaviour. The boundaries between groups are indicated by an item that is just
23228 &`+`& in the host list. For example:
23229 .code
23230 hosts = host1:host2:host3:+:host4:host5
23231 .endd
23232 The order of the first three hosts and the order of the last two hosts is
23233 randomized for each use, but the first three always end up before the last two.
23234 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23235
23236 .option hosts_require_auth smtp "host list&!!" unset
23237 .cindex "authentication" "required by client"
23238 This option provides a list of servers for which authentication must succeed
23239 before Exim will try to transfer a message. If authentication fails for
23240 servers which are not in this list, Exim tries to send unauthenticated. If
23241 authentication fails for one of these servers, delivery is deferred. This
23242 temporary error is detectable in the retry rules, so it can be turned into a
23243 hard failure if required. See also &%hosts_try_auth%&, and chapter
23244 &<<CHAPSMTPAUTH>>& for details of authentication.
23245
23246
23247 .option hosts_request_ocsp smtp "host list&!!" *
23248 .cindex "TLS" "requiring for certain servers"
23249 Exim will request a Certificate Status on a
23250 TLS session for any host that matches this list.
23251 &%tls_verify_certificates%& should also be set for the transport.
23252
23253 .option hosts_require_ocsp smtp "host list&!!" unset
23254 .cindex "TLS" "requiring for certain servers"
23255 Exim will request, and check for a valid Certificate Status being given, on a
23256 TLS session for any host that matches this list.
23257 &%tls_verify_certificates%& should also be set for the transport.
23258
23259 .option hosts_require_tls smtp "host list&!!" unset
23260 .cindex "TLS" "requiring for certain servers"
23261 Exim will insist on using a TLS session when delivering to any host that
23262 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23263 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23264 incoming messages, use an appropriate ACL.
23265
23266 .option hosts_try_auth smtp "host list&!!" unset
23267 .cindex "authentication" "optional in client"
23268 This option provides a list of servers to which, provided they announce
23269 authentication support, Exim will attempt to authenticate as a client when it
23270 connects. If authentication fails, Exim will try to transfer the message
23271 unauthenticated. See also &%hosts_require_auth%&, and chapter
23272 &<<CHAPSMTPAUTH>>& for details of authentication.
23273
23274 .new
23275 .option hosts_try_prdr smtp "host list&!!" *
23276 .cindex "PRDR" "enabling, optional in client"
23277 This option provides a list of servers to which, provided they announce
23278 PRDR support, Exim will attempt to negotiate PRDR
23279 for multi-recipient messages.
23280 The option can usually be left as default.
23281 .wen
23282
23283 .option interface smtp "string list&!!" unset
23284 .cindex "bind IP address"
23285 .cindex "IP address" "binding"
23286 .vindex "&$host$&"
23287 .vindex "&$host_address$&"
23288 This option specifies which interface to bind to when making an outgoing SMTP
23289 call. The value is an IP address, not an interface name such as
23290 &`eth0`&. Do not confuse this with the interface address that was used when a
23291 message was received, which is in &$received_ip_address$&, formerly known as
23292 &$interface_address$&. The name was changed to minimize confusion with the
23293 outgoing interface address. There is no variable that contains an outgoing
23294 interface address because, unless it is set by this option, its value is
23295 unknown.
23296
23297 During the expansion of the &%interface%& option the variables &$host$& and
23298 &$host_address$& refer to the host to which a connection is about to be made
23299 during the expansion of the string. Forced expansion failure, or an empty
23300 string result causes the option to be ignored. Otherwise, after expansion, the
23301 string must be a list of IP addresses, colon-separated by default, but the
23302 separator can be changed in the usual way. For example:
23303 .code
23304 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23305 .endd
23306 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23307 connection. If none of them are the correct type, the option is ignored. If
23308 &%interface%& is not set, or is ignored, the system's IP functions choose which
23309 interface to use if the host has more than one.
23310
23311
23312 .option keepalive smtp boolean true
23313 .cindex "keepalive" "on outgoing connection"
23314 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23315 connections. When set, it causes the kernel to probe idle connections
23316 periodically, by sending packets with &"old"& sequence numbers. The other end
23317 of the connection should send a acknowledgment if the connection is still okay
23318 or a reset if the connection has been aborted. The reason for doing this is
23319 that it has the beneficial effect of freeing up certain types of connection
23320 that can get stuck when the remote host is disconnected without tidying up the
23321 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23322 unreachable hosts.
23323
23324
23325 .option lmtp_ignore_quota smtp boolean false
23326 .cindex "LMTP" "ignoring quota errors"
23327 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23328 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23329 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23330
23331 .option max_rcpt smtp integer 100
23332 .cindex "RCPT" "maximum number of outgoing"
23333 This option limits the number of RCPT commands that are sent in a single
23334 SMTP message transaction. Each set of addresses is treated independently, and
23335 so can cause parallel connections to the same host if &%remote_max_parallel%&
23336 permits this.
23337
23338
23339 .option multi_domain smtp boolean&!! true
23340 .vindex "&$domain$&"
23341 When this option is set, the &(smtp)& transport can handle a number of
23342 addresses containing a mixture of different domains provided they all resolve
23343 to the same list of hosts. Turning the option off restricts the transport to
23344 handling only one domain at a time. This is useful if you want to use
23345 &$domain$& in an expansion for the transport, because it is set only when there
23346 is a single domain involved in a remote delivery.
23347
23348 .new
23349 It is expanded per-address and can depend on any of
23350 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23351 &$host$&, &$host_address$& and &$host_port$&.
23352 .wen
23353
23354 .option port smtp string&!! "see below"
23355 .cindex "port" "sending TCP/IP"
23356 .cindex "TCP/IP" "setting outgoing port"
23357 This option specifies the TCP/IP port on the server to which Exim connects.
23358 &*Note:*& Do not confuse this with the port that was used when a message was
23359 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23360 The name was changed to minimize confusion with the outgoing port. There is no
23361 variable that contains an outgoing port.
23362
23363 If the value of this option begins with a digit it is taken as a port number;
23364 otherwise it is looked up using &[getservbyname()]&. The default value is
23365 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23366 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23367 is deferred.
23368
23369
23370
23371 .option protocol smtp string smtp
23372 .cindex "LMTP" "over TCP/IP"
23373 .cindex "ssmtp protocol" "outbound"
23374 .cindex "TLS" "SSL-on-connect outbound"
23375 .vindex "&$port$&"
23376 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23377 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23378 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23379 deliveries into closed message stores. Exim also has support for running LMTP
23380 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23381
23382 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23383 changes to &"smtps"&, and the transport initiates TLS immediately after
23384 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23385 The Internet standards bodies strongly discourage use of this mode.
23386
23387
23388 .option retry_include_ip_address smtp boolean&!! true
23389 Exim normally includes both the host name and the IP address in the key it
23390 constructs for indexing retry data after a temporary delivery failure. This
23391 means that when one of several IP addresses for a host is failing, it gets
23392 tried periodically (controlled by the retry rules), but use of the other IP
23393 addresses is not affected.
23394
23395 However, in some dialup environments hosts are assigned a different IP address
23396 each time they connect. In this situation the use of the IP address as part of
23397 the retry key leads to undesirable behaviour. Setting this option false causes
23398 Exim to use only the host name.
23399 .new
23400 Since it is expanded it can be made to depend on the host or domain.
23401 .wen
23402
23403
23404 .option serialize_hosts smtp "host list&!!" unset
23405 .cindex "serializing connections"
23406 .cindex "host" "serializing connections"
23407 Because Exim operates in a distributed manner, if several messages for the same
23408 host arrive at around the same time, more than one simultaneous connection to
23409 the remote host can occur. This is not usually a problem except when there is a
23410 slow link between the hosts. In that situation it may be helpful to restrict
23411 Exim to one connection at a time. This can be done by setting
23412 &%serialize_hosts%& to match the relevant hosts.
23413
23414 .cindex "hints database" "serializing deliveries to a host"
23415 Exim implements serialization by means of a hints database in which a record is
23416 written whenever a process connects to one of the restricted hosts. The record
23417 is deleted when the connection is completed. Obviously there is scope for
23418 records to get left lying around if there is a system or program crash. To
23419 guard against this, Exim ignores any records that are more than six hours old.
23420
23421 If you set up this kind of serialization, you should also arrange to delete the
23422 relevant hints database whenever your system reboots. The names of the files
23423 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23424 may be one or two files, depending on the type of DBM in use. The same files
23425 are used for ETRN serialization.
23426
23427
23428 .option size_addition smtp integer 1024
23429 .cindex "SMTP" "SIZE"
23430 .cindex "message" "size issue for transport filter"
23431 .cindex "size" "of message"
23432 .cindex "transport" "filter"
23433 .cindex "filter" "transport filter"
23434 If a remote SMTP server indicates that it supports the SIZE option of the
23435 MAIL command, Exim uses this to pass over the message size at the start of
23436 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23437 sends, to allow for headers and other text that may be added during delivery by
23438 configuration options or in a transport filter. It may be necessary to increase
23439 this if a lot of text is added to messages.
23440
23441 Alternatively, if the value of &%size_addition%& is set negative, it disables
23442 the use of the SIZE option altogether.
23443
23444
23445 .option tls_certificate smtp string&!! unset
23446 .cindex "TLS" "client certificate, location of"
23447 .cindex "certificate" "client, location of"
23448 .vindex "&$host$&"
23449 .vindex "&$host_address$&"
23450 The value of this option must be the absolute path to a file which contains the
23451 client's certificate, for possible use when sending a message over an encrypted
23452 connection. The values of &$host$& and &$host_address$& are set to the name and
23453 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23454 details of TLS.
23455
23456 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23457 certificate when sending messages as a client. The global option of the same
23458 name specifies the certificate for Exim as a server; it is not automatically
23459 assumed that the same certificate should be used when Exim is operating as a
23460 client.
23461
23462
23463 .option tls_crl smtp string&!! unset
23464 .cindex "TLS" "client certificate revocation list"
23465 .cindex "certificate" "revocation list for client"
23466 This option specifies a certificate revocation list. The expanded value must
23467 be the name of a file that contains a CRL in PEM format.
23468
23469
23470 .option tls_dh_min_bits smtp integer 1024
23471 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23472 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23473 key agreement is negotiated, the server will provide a large prime number
23474 for use.  This option establishes the minimum acceptable size of that number.
23475 If the parameter offered by the server is too small, then the TLS handshake
23476 will fail.
23477
23478 Only supported when using GnuTLS.
23479
23480
23481 .option tls_privatekey smtp string&!! unset
23482 .cindex "TLS" "client private key, location of"
23483 .vindex "&$host$&"
23484 .vindex "&$host_address$&"
23485 The value of this option must be the absolute path to a file which contains the
23486 client's private key. This is used when sending a message over an encrypted
23487 connection using a client certificate. The values of &$host$& and
23488 &$host_address$& are set to the name and address of the server during the
23489 expansion. If this option is unset, or the expansion is forced to fail, or the
23490 result is an empty string, the private key is assumed to be in the same file as
23491 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23492
23493
23494 .option tls_require_ciphers smtp string&!! unset
23495 .cindex "TLS" "requiring specific ciphers"
23496 .cindex "cipher" "requiring specific"
23497 .vindex "&$host$&"
23498 .vindex "&$host_address$&"
23499 The value of this option must be a list of permitted cipher suites, for use
23500 when setting up an outgoing encrypted connection. (There is a global option of
23501 the same name for controlling incoming connections.) The values of &$host$& and
23502 &$host_address$& are set to the name and address of the server during the
23503 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23504 is used in different ways by OpenSSL and GnuTLS (see sections
23505 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23506 ciphers is a preference order.
23507
23508
23509
23510 .option tls_sni smtp string&!! unset
23511 .cindex "TLS" "Server Name Indication"
23512 .vindex "&$tls_sni$&"
23513 If this option is set then it sets the $tls_out_sni variable and causes any
23514 TLS session to pass this value as the Server Name Indication extension to
23515 the remote side, which can be used by the remote side to select an appropriate
23516 certificate and private key for the session.
23517
23518 See &<<SECTtlssni>>& for more information.
23519
23520 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23521 TLS extensions.
23522
23523
23524
23525
23526 .option tls_tempfail_tryclear smtp boolean true
23527 .cindex "4&'xx'& responses" "to STARTTLS"
23528 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23529 setting up a TLS session, this option determines whether or not Exim should try
23530 to deliver the message unencrypted. If it is set false, delivery to the
23531 current host is deferred; if there are other hosts, they are tried. If this
23532 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23533 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23534 TLS negotiation fails, Exim closes the current connection (because it is in an
23535 unknown state), opens a new one to the same host, and then tries the delivery
23536 in clear.
23537
23538
23539 .new
23540 .option tls_try_verify_hosts smtp "host list&!!" *
23541 .wen
23542 .cindex "TLS" "server certificate verification"
23543 .cindex "certificate" "verification of server"
23544 This option gives a list of hosts for which, on encrypted connections,
23545 certificate verification will be tried but need not succeed.
23546 The &%tls_verify_certificates%& option must also be set.
23547 Note that unless the host is in this list
23548 TLS connections will be denied to hosts using self-signed certificates
23549 when &%tls_verify_certificates%& is matched.
23550 The &$tls_out_certificate_verified$& variable is set when
23551 certificate verification succeeds.
23552
23553
23554 .new
23555 .option tls_verify_cert_hostnames smtp "host list&!!" *
23556 .cindex "TLS" "server certificate hostname verification"
23557 .cindex "certificate" "verification of server"
23558 This option give a list of hosts for which,
23559 while verifying the server certificate,
23560 checks will be included on the host name
23561 (note that this will generally be the result of a DNS MX lookup)
23562 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23563 limited to being the initial component of a 3-or-more component FQDN.
23564
23565 There is no equivalent checking on client certificates.
23566 .wen
23567
23568
23569 .new
23570 .option tls_verify_certificates smtp string&!! system
23571 .cindex "TLS" "server certificate verification"
23572 .cindex "certificate" "verification of server"
23573 .vindex "&$host$&"
23574 .vindex "&$host_address$&"
23575 The value of this option must be either the
23576 word "system"
23577 or the absolute path to
23578 a file or directory containing permitted certificates for servers,
23579 for use when setting up an encrypted connection.
23580
23581 The "system" value for the option will use a location compiled into the SSL library.
23582 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23583 is taken as empty and an explicit location
23584 must be specified.
23585
23586 The use of a directory for the option value is not avilable for GnuTLS versions
23587 preceding 3.3.6 and a single file must be used.
23588 .wen
23589
23590 With OpenSSL the certificates specified
23591 explicitly
23592 either by file or directory
23593 are added to those given by the system default location.
23594
23595 The values of &$host$& and
23596 &$host_address$& are set to the name and address of the server during the
23597 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23598
23599 For back-compatability,
23600 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23601 (a single-colon empty list counts as being set)
23602 and certificate verification fails the TLS connection is closed.
23603
23604
23605 .option tls_verify_hosts smtp "host list&!!" unset
23606 .cindex "TLS" "server certificate verification"
23607 .cindex "certificate" "verification of server"
23608 This option gives a list of hosts for which. on encrypted connections,
23609 certificate verification must succeed.
23610 The &%tls_verify_certificates%& option must also be set.
23611 If both this option and &%tls_try_verify_hosts%& are unset
23612 operation is as if this option selected all hosts.
23613
23614
23615
23616
23617 .section "How the limits for the number of hosts to try are used" &&&
23618          "SECTvalhosmax"
23619 .cindex "host" "maximum number to try"
23620 .cindex "limit" "hosts; maximum number tried"
23621 There are two options that are concerned with the number of hosts that are
23622 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23623 &%hosts_max_try_hardlimit%&.
23624
23625
23626 The &%hosts_max_try%& option limits the number of hosts that are tried
23627 for a single delivery. However, despite the term &"host"& in its name, the
23628 option actually applies to each IP address independently. In other words, a
23629 multihomed host is treated as several independent hosts, just as it is for
23630 retrying.
23631
23632 Many of the larger ISPs have multiple MX records which often point to
23633 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23634 created as a result of routing one of these domains.
23635
23636 Trying every single IP address on such a long list does not seem sensible; if
23637 several at the top of the list fail, it is reasonable to assume there is some
23638 problem that is likely to affect all of them. Roughly speaking, the value of
23639 &%hosts_max_try%& is the maximum number that are tried before deferring the
23640 delivery. However, the logic cannot be quite that simple.
23641
23642 Firstly, IP addresses that are skipped because their retry times have not
23643 arrived do not count, and in addition, addresses that are past their retry
23644 limits are also not counted, even when they are tried. This means that when
23645 some IP addresses are past their retry limits, more than the value of
23646 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23647 that all IP addresses are considered before timing out an email address (but
23648 see below for an exception).
23649
23650 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23651 list to see if there is a subsequent host with a different (higher valued) MX.
23652 If there is, that host is considered next, and the current IP address is used
23653 but not counted. This behaviour helps in the case of a domain with a retry rule
23654 that hardly ever delays any hosts, as is now explained:
23655
23656 Consider the case of a long list of hosts with one MX value, and a few with a
23657 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23658 hosts at the top of the list are tried at first. With the default retry rule,
23659 which specifies increasing retry times, the higher MX hosts are eventually
23660 tried when those at the top of the list are skipped because they have not
23661 reached their retry times.
23662
23663 However, it is common practice to put a fixed short retry time on domains for
23664 large ISPs, on the grounds that their servers are rarely down for very long.
23665 Unfortunately, these are exactly the domains that tend to resolve to long lists
23666 of hosts. The short retry time means that the lowest MX hosts are tried every
23667 time. The attempts may be in a different order because of random sorting, but
23668 without the special MX check, the higher MX hosts would never be tried until
23669 all the lower MX hosts had timed out (which might be several days), because
23670 there are always some lower MX hosts that have reached their retry times. With
23671 the special check, Exim considers at least one IP address from each MX value at
23672 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23673 reached.
23674
23675 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23676 particular, Exim normally eventually tries all the IP addresses before timing
23677 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23678 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23679 been set up with hundreds of IP addresses for some domains. It can
23680 take a very long time indeed for an address to time out in these cases.
23681
23682 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23683 Exim never tries more than this number of IP addresses; if it hits this limit
23684 and they are all timed out, the email address is bounced, even though not all
23685 possible IP addresses have been tried.
23686 .ecindex IIDsmttra1
23687 .ecindex IIDsmttra2
23688
23689
23690
23691
23692
23693 . ////////////////////////////////////////////////////////////////////////////
23694 . ////////////////////////////////////////////////////////////////////////////
23695
23696 .chapter "Address rewriting" "CHAPrewrite"
23697 .scindex IIDaddrew "rewriting" "addresses"
23698 There are some circumstances in which Exim automatically rewrites domains in
23699 addresses. The two most common are when an address is given without a domain
23700 (referred to as an &"unqualified address"&) or when an address contains an
23701 abbreviated domain that is expanded by DNS lookup.
23702
23703 Unqualified envelope addresses are accepted only for locally submitted
23704 messages, or for messages that are received from hosts matching
23705 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23706 appropriate. Unqualified addresses in header lines are qualified if they are in
23707 locally submitted messages, or messages from hosts that are permitted to send
23708 unqualified envelope addresses. Otherwise, unqualified addresses in header
23709 lines are neither qualified nor rewritten.
23710
23711 One situation in which Exim does &'not'& automatically rewrite a domain is
23712 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23713 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23714 do this. The new RFCs do not contain this suggestion.
23715
23716
23717 .section "Explicitly configured address rewriting" "SECID147"
23718 This chapter describes the rewriting rules that can be used in the
23719 main rewrite section of the configuration file, and also in the generic
23720 &%headers_rewrite%& option that can be set on any transport.
23721
23722 Some people believe that configured address rewriting is a Mortal Sin.
23723 Others believe that life is not possible without it. Exim provides the
23724 facility; you do not have to use it.
23725
23726 The main rewriting rules that appear in the &"rewrite"& section of the
23727 configuration file are applied to addresses in incoming messages, both envelope
23728 addresses and addresses in header lines. Each rule specifies the types of
23729 address to which it applies.
23730
23731 Whether or not addresses in header lines are rewritten depends on the origin of
23732 the headers and the type of rewriting. Global rewriting, that is, rewriting
23733 rules from the rewrite section of the configuration file, is applied only to
23734 those headers that were received with the message. Header lines that are added
23735 by ACLs or by a system filter or by individual routers or transports (which
23736 are specific to individual recipient addresses) are not rewritten by the global
23737 rules.
23738
23739 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23740 applies all headers except those added by routers and transports. That is, as
23741 well as the headers that were received with the message, it also applies to
23742 headers that were added by an ACL or a system filter.
23743
23744
23745 In general, rewriting addresses from your own system or domain has some
23746 legitimacy. Rewriting other addresses should be done only with great care and
23747 in special circumstances. The author of Exim believes that rewriting should be
23748 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23749 Although it can sometimes be used as a routing tool, this is very strongly
23750 discouraged.
23751
23752 There are two commonly encountered circumstances where rewriting is used, as
23753 illustrated by these examples:
23754
23755 .ilist
23756 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23757 exchange mail with each other behind a firewall, but there is only a single
23758 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23759 &'hitch.fict.example'& when sending mail off-site.
23760 .next
23761 A host rewrites the local parts of its own users so that, for example,
23762 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23763 .endlist
23764
23765
23766
23767 .section "When does rewriting happen?" "SECID148"
23768 .cindex "rewriting" "timing of"
23769 .cindex "&ACL;" "rewriting addresses in"
23770 Configured address rewriting can take place at several different stages of a
23771 message's processing.
23772
23773 .vindex "&$sender_address$&"
23774 At the start of an ACL for MAIL, the sender address may have been rewritten
23775 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23776 ordinary rewrite rules have yet been applied. If, however, the sender address
23777 is verified in the ACL, it is rewritten before verification, and remains
23778 rewritten thereafter. The subsequent value of &$sender_address$& is the
23779 rewritten address. This also applies if sender verification happens in a
23780 RCPT ACL. Otherwise, when the sender address is not verified, it is
23781 rewritten as soon as a message's header lines have been received.
23782
23783 .vindex "&$domain$&"
23784 .vindex "&$local_part$&"
23785 Similarly, at the start of an ACL for RCPT, the current recipient's address
23786 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23787 rewrite rules have yet been applied to it. However, the behaviour is different
23788 from the sender address when a recipient is verified. The address is rewritten
23789 for the verification, but the rewriting is not remembered at this stage. The
23790 value of &$local_part$& and &$domain$& after verification are always the same
23791 as they were before (that is, they contain the unrewritten &-- except for
23792 SMTP-time rewriting &-- address).
23793
23794 As soon as a message's header lines have been received, all the envelope
23795 recipient addresses are permanently rewritten, and rewriting is also applied to
23796 the addresses in the header lines (if configured). This happens before adding
23797 any header lines that were specified in MAIL or RCPT ACLs, and
23798 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23799 before the DATA ACL and &[local_scan()]& functions are run.
23800
23801 When an address is being routed, either for delivery or for verification,
23802 rewriting is applied immediately to child addresses that are generated by
23803 redirection, unless &%no_rewrite%& is set on the router.
23804
23805 .cindex "envelope sender" "rewriting at transport time"
23806 .cindex "rewriting" "at transport time"
23807 .cindex "header lines" "rewriting at transport time"
23808 At transport time, additional rewriting of addresses in header lines can be
23809 specified by setting the generic &%headers_rewrite%& option on a transport.
23810 This option contains rules that are identical in form to those in the rewrite
23811 section of the configuration file. They are applied to the original message
23812 header lines and any that were added by ACLs or a system filter. They are not
23813 applied to header lines that are added by routers or the transport.
23814
23815 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23816 transport option. However, it is not possible to rewrite envelope recipients at
23817 transport time.
23818
23819
23820
23821
23822 .section "Testing the rewriting rules that apply on input" "SECID149"
23823 .cindex "rewriting" "testing"
23824 .cindex "testing" "rewriting"
23825 Exim's input rewriting configuration appears in a part of the run time
23826 configuration file headed by &"begin rewrite"&. It can be tested by the
23827 &%-brw%& command line option. This takes an address (which can be a full RFC
23828 2822 address) as its argument. The output is a list of how the address would be
23829 transformed by the rewriting rules for each of the different places it might
23830 appear in an incoming message, that is, for each different header and for the
23831 envelope sender and recipient fields. For example,
23832 .code
23833 exim -brw ph10@exim.workshop.example
23834 .endd
23835 might produce the output
23836 .code
23837 sender: Philip.Hazel@exim.workshop.example
23838 from: Philip.Hazel@exim.workshop.example
23839 to: ph10@exim.workshop.example
23840 cc: ph10@exim.workshop.example
23841 bcc: ph10@exim.workshop.example
23842 reply-to: Philip.Hazel@exim.workshop.example
23843 env-from: Philip.Hazel@exim.workshop.example
23844 env-to: ph10@exim.workshop.example
23845 .endd
23846 which shows that rewriting has been set up for that address when used in any of
23847 the source fields, but not when it appears as a recipient address. At the
23848 present time, there is no equivalent way of testing rewriting rules that are
23849 set for a particular transport.
23850
23851
23852 .section "Rewriting rules" "SECID150"
23853 .cindex "rewriting" "rules"
23854 The rewrite section of the configuration file consists of lines of rewriting
23855 rules in the form
23856 .display
23857 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23858 .endd
23859 Rewriting rules that are specified for the &%headers_rewrite%& generic
23860 transport option are given as a colon-separated list. Each item in the list
23861 takes the same form as a line in the main rewriting configuration (except that
23862 any colons must be doubled, of course).
23863
23864 The formats of source patterns and replacement strings are described below.
23865 Each is terminated by white space, unless enclosed in double quotes, in which
23866 case normal quoting conventions apply inside the quotes. The flags are single
23867 characters which may appear in any order. Spaces and tabs between them are
23868 ignored.
23869
23870 For each address that could potentially be rewritten, the rules are scanned in
23871 order, and replacements for the address from earlier rules can themselves be
23872 replaced by later rules (but see the &"q"& and &"R"& flags).
23873
23874 The order in which addresses are rewritten is undefined, may change between
23875 releases, and must not be relied on, with one exception: when a message is
23876 received, the envelope sender is always rewritten first, before any header
23877 lines are rewritten. For example, the replacement string for a rewrite of an
23878 address in &'To:'& must not assume that the message's address in &'From:'& has
23879 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23880 that the envelope sender has already been rewritten.
23881
23882 .vindex "&$domain$&"
23883 .vindex "&$local_part$&"
23884 The variables &$local_part$& and &$domain$& can be used in the replacement
23885 string to refer to the address that is being rewritten. Note that lookup-driven
23886 rewriting can be done by a rule of the form
23887 .code
23888 *@*   ${lookup ...
23889 .endd
23890 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23891 refer to the address that is being rewritten.
23892
23893
23894 .section "Rewriting patterns" "SECID151"
23895 .cindex "rewriting" "patterns"
23896 .cindex "address list" "in a rewriting pattern"
23897 The source pattern in a rewriting rule is any item which may appear in an
23898 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23899 single-item address list, which means that it is expanded before being tested
23900 against the address. As always, if you use a regular expression as a pattern,
23901 you must take care to escape dollar and backslash characters, or use the &`\N`&
23902 facility to suppress string expansion within the regular expression.
23903
23904 Domains in patterns should be given in lower case. Local parts in patterns are
23905 case-sensitive. If you want to do case-insensitive matching of local parts, you
23906 can use a regular expression that starts with &`^(?i)`&.
23907
23908 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23909 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23910 depending on the type of match which occurred. These can be used in the
23911 replacement string to insert portions of the incoming address. &$0$& always
23912 refers to the complete incoming address. When a regular expression is used, the
23913 numerical variables are set from its capturing subexpressions. For other types
23914 of pattern they are set as follows:
23915
23916 .ilist
23917 If a local part or domain starts with an asterisk, the numerical variables
23918 refer to the character strings matched by asterisks, with &$1$& associated with
23919 the first asterisk, and &$2$& with the second, if present. For example, if the
23920 pattern
23921 .code
23922 *queen@*.fict.example
23923 .endd
23924 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23925 .code
23926 $0 = hearts-queen@wonderland.fict.example
23927 $1 = hearts-
23928 $2 = wonderland
23929 .endd
23930 Note that if the local part does not start with an asterisk, but the domain
23931 does, it is &$1$& that contains the wild part of the domain.
23932
23933 .next
23934 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23935 of the domain are placed in the next available numerical variables. Suppose,
23936 for example, that the address &'foo@bar.baz.example'& is processed by a
23937 rewriting rule of the form
23938 .display
23939 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23940 .endd
23941 and the key in the file that matches the domain is &`*.baz.example`&. Then
23942 .code
23943 $1 = foo
23944 $2 = bar
23945 $3 = baz.example
23946 .endd
23947 If the address &'foo@baz.example'& is looked up, this matches the same
23948 wildcard file entry, and in this case &$2$& is set to the empty string, but
23949 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23950 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23951 whole domain. For non-partial domain lookups, no numerical variables are set.
23952 .endlist
23953
23954
23955 .section "Rewriting replacements" "SECID152"
23956 .cindex "rewriting" "replacements"
23957 If the replacement string for a rule is a single asterisk, addresses that
23958 match the pattern and the flags are &'not'& rewritten, and no subsequent
23959 rewriting rules are scanned. For example,
23960 .code
23961 hatta@lookingglass.fict.example  *  f
23962 .endd
23963 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23964 &'From:'& headers.
23965
23966 .vindex "&$domain$&"
23967 .vindex "&$local_part$&"
23968 If the replacement string is not a single asterisk, it is expanded, and must
23969 yield a fully qualified address. Within the expansion, the variables
23970 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23971 Any letters they contain retain their original case &-- they are not lower
23972 cased. The numerical variables are set up according to the type of pattern that
23973 matched the address, as described above. If the expansion is forced to fail by
23974 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23975 current rule is abandoned, but subsequent rules may take effect. Any other
23976 expansion failure causes the entire rewriting operation to be abandoned, and an
23977 entry written to the panic log.
23978
23979
23980
23981 .section "Rewriting flags" "SECID153"
23982 There are three different kinds of flag that may appear on rewriting rules:
23983
23984 .ilist
23985 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23986 c, f, h, r, s, t.
23987 .next
23988 A flag that specifies rewriting at SMTP time: S.
23989 .next
23990 Flags that control the rewriting process: Q, q, R, w.
23991 .endlist
23992
23993 For rules that are part of the &%headers_rewrite%& generic transport option,
23994 E, F, T, and S are not permitted.
23995
23996
23997
23998 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23999          "SECID154"
24000 .cindex "rewriting" "flags"
24001 If none of the following flag letters, nor the &"S"& flag (see section
24002 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24003 and to both the sender and recipient fields of the envelope, whereas a
24004 transport-time rewriting rule just applies to all headers. Otherwise, the
24005 rewriting rule is skipped unless the relevant addresses are being processed.
24006 .display
24007 &`E`&       rewrite all envelope fields
24008 &`F`&       rewrite the envelope From field
24009 &`T`&       rewrite the envelope To field
24010 &`b`&       rewrite the &'Bcc:'& header
24011 &`c`&       rewrite the &'Cc:'& header
24012 &`f`&       rewrite the &'From:'& header
24013 &`h`&       rewrite all headers
24014 &`r`&       rewrite the &'Reply-To:'& header
24015 &`s`&       rewrite the &'Sender:'& header
24016 &`t`&       rewrite the &'To:'& header
24017 .endd
24018 "All headers" means all of the headers listed above that can be selected
24019 individually, plus their &'Resent-'& versions. It does not include
24020 other headers such as &'Subject:'& etc.
24021
24022 You should be particularly careful about rewriting &'Sender:'& headers, and
24023 restrict this to special known cases in your own domains.
24024
24025
24026 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24027 .cindex "SMTP" "rewriting malformed addresses"
24028 .cindex "RCPT" "rewriting argument of"
24029 .cindex "MAIL" "rewriting argument of"
24030 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24031 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24032 before any other processing; even before syntax checking. The pattern is
24033 required to be a regular expression, and it is matched against the whole of the
24034 data for the command, including any surrounding angle brackets.
24035
24036 .vindex "&$domain$&"
24037 .vindex "&$local_part$&"
24038 This form of rewrite rule allows for the handling of addresses that are not
24039 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24040 input). Because the input is not required to be a syntactically valid address,
24041 the variables &$local_part$& and &$domain$& are not available during the
24042 expansion of the replacement string. The result of rewriting replaces the
24043 original address in the MAIL or RCPT command.
24044
24045
24046 .section "Flags controlling the rewriting process" "SECID155"
24047 There are four flags which control the way the rewriting process works. These
24048 take effect only when a rule is invoked, that is, when the address is of the
24049 correct type (matches the flags) and matches the pattern:
24050
24051 .ilist
24052 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24053 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24054 absence of &"Q"& the rewritten address must always include a domain.
24055 .next
24056 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24057 even if no rewriting actually takes place because of a &"fail"& in the
24058 expansion. The &"q"& flag is not effective if the address is of the wrong type
24059 (does not match the flags) or does not match the pattern.
24060 .next
24061 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24062 address, up to ten times. It can be combined with the &"q"& flag, to stop
24063 rewriting once it fails to match (after at least one successful rewrite).
24064 .next
24065 .cindex "rewriting" "whole addresses"
24066 When an address in a header is rewritten, the rewriting normally applies only
24067 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24068 left unchanged. For example, rewriting might change
24069 .code
24070 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24071 .endd
24072 into
24073 .code
24074 From: Ford Prefect <prefectf@hitch.fict.example>
24075 .endd
24076 .cindex "RFC 2047"
24077 Sometimes there is a need to replace the whole address item, and this can be
24078 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24079 causes an address in a header line to be rewritten, the entire address is
24080 replaced, not just the working part. The replacement must be a complete RFC
24081 2822 address, including the angle brackets if necessary. If text outside angle
24082 brackets contains a character whose value is greater than 126 or less than 32
24083 (except for tab), the text is encoded according to RFC 2047. The character set
24084 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24085
24086 When the &"w"& flag is set on a rule that causes an envelope address to be
24087 rewritten, all but the working part of the replacement address is discarded.
24088 .endlist
24089
24090
24091 .section "Rewriting examples" "SECID156"
24092 Here is an example of the two common rewriting paradigms:
24093 .code
24094 *@*.hitch.fict.example  $1@hitch.fict.example
24095 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24096                      {$value}fail}@hitch.fict.example bctfrF
24097 .endd
24098 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24099 the string expansion to fail if the lookup does not succeed. In this context it
24100 has the effect of leaving the original address unchanged, but Exim goes on to
24101 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24102 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24103 explicitly, which would cause the rewritten address to be the same as before,
24104 at the cost of a small bit of processing. Not supplying either of these is an
24105 error, since the rewritten address would then contain no local part.
24106
24107 The first example above replaces the domain with a superior, more general
24108 domain. This may not be desirable for certain local parts. If the rule
24109 .code
24110 root@*.hitch.fict.example  *
24111 .endd
24112 were inserted before the first rule, rewriting would be suppressed for the
24113 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24114
24115 Rewriting can be made conditional on a number of tests, by making use of
24116 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24117 messages that originate outside the local host:
24118 .code
24119 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24120                          {$1@hitch.fict.example}fail}"
24121 .endd
24122 The replacement string is quoted in this example because it contains white
24123 space.
24124
24125 .cindex "rewriting" "bang paths"
24126 .cindex "bang paths" "rewriting"
24127 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24128 an address it treats it as an unqualified local part which it qualifies with
24129 the local qualification domain (if the source of the message is local or if the
24130 remote host is permitted to send unqualified addresses). Rewriting can
24131 sometimes be used to handle simple bang paths with a fixed number of
24132 components. For example, the rule
24133 .code
24134 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24135 .endd
24136 rewrites a two-component bang path &'host.name!user'& as the domain address
24137 &'user@host.name'&. However, there is a security implication in using this as
24138 a global rewriting rule for envelope addresses. It can provide a backdoor
24139 method for using your system as a relay, because the incoming addresses appear
24140 to be local. If the bang path addresses are received via SMTP, it is safer to
24141 use the &"S"& flag to rewrite them as they are received, so that relay checking
24142 can be done on the rewritten addresses.
24143 .ecindex IIDaddrew
24144
24145
24146
24147
24148
24149 . ////////////////////////////////////////////////////////////////////////////
24150 . ////////////////////////////////////////////////////////////////////////////
24151
24152 .chapter "Retry configuration" "CHAPretry"
24153 .scindex IIDretconf1 "retry" "configuration, description of"
24154 .scindex IIDregconf2 "configuration file" "retry section"
24155 The &"retry"& section of the runtime configuration file contains a list of
24156 retry rules that control how often Exim tries to deliver messages that cannot
24157 be delivered at the first attempt. If there are no retry rules (the section is
24158 empty or not present), there are no retries. In this situation, temporary
24159 errors are treated as permanent. The default configuration contains a single,
24160 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24161 line option can be used to test which retry rule will be used for a given
24162 address, domain and error.
24163
24164 The most common cause of retries is temporary failure to deliver to a remote
24165 host because the host is down, or inaccessible because of a network problem.
24166 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24167 address) basis, not on a per-message basis. Thus, if one message has recently
24168 been delayed, delivery of a new message to the same host is not immediately
24169 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24170 log selector is set, the message
24171 .cindex "retry" "time not reached"
24172 &"retry time not reached"& is written to the main log whenever a delivery is
24173 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24174 the handling of errors during remote deliveries.
24175
24176 Retry processing applies to routing as well as to delivering, except as covered
24177 in the next paragraph. The retry rules do not distinguish between these
24178 actions. It is not possible, for example, to specify different behaviour for
24179 failures to route the domain &'snark.fict.example'& and failures to deliver to
24180 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24181 added complication, so did not implement it. However, although they share the
24182 same retry rule, the actual retry times for routing and transporting a given
24183 domain are maintained independently.
24184
24185 When a delivery is not part of a queue run (typically an immediate delivery on
24186 receipt of a message), the routers are always run, and local deliveries are
24187 always attempted, even if retry times are set for them. This makes for better
24188 behaviour if one particular message is causing problems (for example, causing
24189 quota overflow, or provoking an error in a filter file). If such a delivery
24190 suffers a temporary failure, the retry data is updated as normal, and
24191 subsequent delivery attempts from queue runs occur only when the retry time for
24192 the local address is reached.
24193
24194 .section "Changing retry rules" "SECID157"
24195 If you change the retry rules in your configuration, you should consider
24196 whether or not to delete the retry data that is stored in Exim's spool area in
24197 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24198 always safe; that is why they are called &"hints"&.
24199
24200 The hints retry data contains suggested retry times based on the previous
24201 rules. In the case of a long-running problem with a remote host, it might
24202 record the fact that the host has timed out. If your new rules increase the
24203 timeout time for such a host, you should definitely remove the old retry data
24204 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24205 messages that it should now be retaining.
24206
24207
24208
24209 .section "Format of retry rules" "SECID158"
24210 .cindex "retry" "rules"
24211 Each retry rule occupies one line and consists of three or four parts,
24212 separated by white space: a pattern, an error name, an optional list of sender
24213 addresses, and a list of retry parameters. The pattern and sender lists must be
24214 enclosed in double quotes if they contain white space. The rules are searched
24215 in order until one is found where the pattern, error name, and sender list (if
24216 present) match the failing host or address, the error that occurred, and the
24217 message's sender, respectively.
24218
24219
24220 The pattern is any single item that may appear in an address list (see section
24221 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24222 which means that it is expanded before being tested against the address that
24223 has been delayed. A negated address list item is permitted. Address
24224 list processing treats a plain domain name as if it were preceded by &"*@"&,
24225 which makes it possible for many retry rules to start with just a domain. For
24226 example,
24227 .code
24228 lookingglass.fict.example        *  F,24h,30m;
24229 .endd
24230 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24231 whereas
24232 .code
24233 alice@lookingglass.fict.example  *  F,24h,30m;
24234 .endd
24235 applies only to temporary failures involving the local part &%alice%&.
24236 In practice, almost all rules start with a domain name pattern without a local
24237 part.
24238
24239 .cindex "regular expressions" "in retry rules"
24240 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24241 must match a complete address, not just a domain, because that is how regular
24242 expressions work in address lists.
24243 .display
24244 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24245 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24246 .endd
24247
24248
24249 .section "Choosing which retry rule to use for address errors" "SECID159"
24250 When Exim is looking for a retry rule after a routing attempt has failed (for
24251 example, after a DNS timeout), each line in the retry configuration is tested
24252 against the complete address only if &%retry_use_local_part%& is set for the
24253 router. Otherwise, only the domain is used, except when matching against a
24254 regular expression, when the local part of the address is replaced with &"*"&.
24255 A domain on its own can match a domain pattern, or a pattern that starts with
24256 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24257 &%check_local_user%& is true, and false for other routers.
24258
24259 Similarly, when Exim is looking for a retry rule after a local delivery has
24260 failed (for example, after a mailbox full error), each line in the retry
24261 configuration is tested against the complete address only if
24262 &%retry_use_local_part%& is set for the transport (it defaults true for all
24263 local transports).
24264
24265 .cindex "4&'xx'& responses" "retry rules for"
24266 However, when Exim is looking for a retry rule after a remote delivery attempt
24267 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24268 whole address is always used as the key when searching the retry rules. The
24269 rule that is found is used to create a retry time for the combination of the
24270 failing address and the message's sender. It is the combination of sender and
24271 recipient that is delayed in subsequent queue runs until its retry time is
24272 reached. You can delay the recipient without regard to the sender by setting
24273 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24274 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24275 commands.
24276
24277
24278
24279 .section "Choosing which retry rule to use for host and message errors" &&&
24280          "SECID160"
24281 For a temporary error that is not related to an individual address (for
24282 example, a connection timeout), each line in the retry configuration is checked
24283 twice. First, the name of the remote host is used as a domain name (preceded by
24284 &"*@"& when matching a regular expression). If this does not match the line,
24285 the domain from the email address is tried in a similar fashion. For example,
24286 suppose the MX records for &'a.b.c.example'& are
24287 .code
24288 a.b.c.example  MX  5  x.y.z.example
24289                MX  6  p.q.r.example
24290                MX  7  m.n.o.example
24291 .endd
24292 and the retry rules are
24293 .code
24294 p.q.r.example    *      F,24h,30m;
24295 a.b.c.example    *      F,4d,45m;
24296 .endd
24297 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24298 first rule matches neither the host nor the domain, so Exim looks at the second
24299 rule. This does not match the host, but it does match the domain, so it is used
24300 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24301 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24302 first retry rule is used, because it matches the host.
24303
24304 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24305 first rule to determine retry times, but for all the other hosts for the domain
24306 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24307 routing to &'a.b.c.example'& suffers a temporary failure.
24308
24309 &*Note*&: The host name is used when matching the patterns, not its IP address.
24310 However, if a message is routed directly to an IP address without the use of a
24311 host name, for example, if a &(manualroute)& router contains a setting such as:
24312 .code
24313 route_list = *.a.example  192.168.34.23
24314 .endd
24315 then the &"host name"& that is used when searching for a retry rule is the
24316 textual form of the IP address.
24317
24318 .section "Retry rules for specific errors" "SECID161"
24319 .cindex "retry" "specific errors; specifying"
24320 The second field in a retry rule is the name of a particular error, or an
24321 asterisk, which matches any error. The errors that can be tested for are:
24322
24323 .vlist
24324 .vitem &%auth_failed%&
24325 Authentication failed when trying to send to a host in the
24326 &%hosts_require_auth%& list in an &(smtp)& transport.
24327
24328 .vitem &%data_4xx%&
24329 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24330 after the command, or after sending the message's data.
24331
24332 .vitem &%mail_4xx%&
24333 A 4&'xx'& error was received for an outgoing MAIL command.
24334
24335 .vitem &%rcpt_4xx%&
24336 A 4&'xx'& error was received for an outgoing RCPT command.
24337 .endlist
24338
24339 For the three 4&'xx'& errors, either the first or both of the x's can be given
24340 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24341 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24342 and have retries every ten minutes with a one-hour timeout, you could set up a
24343 retry rule of this form:
24344 .code
24345 the.domain.name  rcpt_452   F,1h,10m
24346 .endd
24347 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24348 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24349
24350 .vlist
24351 .vitem &%lost_connection%&
24352 A server unexpectedly closed the SMTP connection. There may, of course,
24353 legitimate reasons for this (host died, network died), but if it repeats a lot
24354 for the same host, it indicates something odd.
24355
24356 .vitem &%refused_MX%&
24357 A connection to a host obtained from an MX record was refused.
24358
24359 .vitem &%refused_A%&
24360 A connection to a host not obtained from an MX record was refused.
24361
24362 .vitem &%refused%&
24363 A connection was refused.
24364
24365 .vitem &%timeout_connect_MX%&
24366 A connection attempt to a host obtained from an MX record timed out.
24367
24368 .vitem &%timeout_connect_A%&
24369 A connection attempt to a host not obtained from an MX record timed out.
24370
24371 .vitem &%timeout_connect%&
24372 A connection attempt timed out.
24373
24374 .vitem &%timeout_MX%&
24375 There was a timeout while connecting or during an SMTP session with a host
24376 obtained from an MX record.
24377
24378 .vitem &%timeout_A%&
24379 There was a timeout while connecting or during an SMTP session with a host not
24380 obtained from an MX record.
24381
24382 .vitem &%timeout%&
24383 There was a timeout while connecting or during an SMTP session.
24384
24385 .vitem &%tls_required%&
24386 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24387 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24388 to STARTTLS, or there was a problem setting up the TLS connection.
24389
24390 .vitem &%quota%&
24391 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24392 transport.
24393
24394 .vitem &%quota_%&<&'time'&>
24395 .cindex "quota" "error testing in retry rule"
24396 .cindex "retry" "quota error testing"
24397 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24398 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24399 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24400 for four days.
24401 .endlist
24402
24403 .cindex "mailbox" "time of last read"
24404 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24405 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24406 it should be based on the last time that the user accessed the mailbox.
24407 However, it is not always possible to determine this. Exim uses the following
24408 heuristic rules:
24409
24410 .ilist
24411 If the mailbox is a single file, the time of last access (the &"atime"&) is
24412 used. As no new messages are being delivered (because the mailbox is over
24413 quota), Exim does not access the file, so this is the time of last user access.
24414 .next
24415 .cindex "maildir format" "time of last read"
24416 For a maildir delivery, the time of last modification of the &_new_&
24417 subdirectory is used. As the mailbox is over quota, no new files are created in
24418 the &_new_& subdirectory, because no new messages are being delivered. Any
24419 change to the &_new_& subdirectory is therefore assumed to be the result of an
24420 MUA moving a new message to the &_cur_& directory when it is first read. The
24421 time that is used is therefore the last time that the user read a new message.
24422 .next
24423 For other kinds of multi-file mailbox, the time of last access cannot be
24424 obtained, so a retry rule that uses this type of error field is never matched.
24425 .endlist
24426
24427 The quota errors apply both to system-enforced quotas and to Exim's own quota
24428 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24429 when a local delivery is deferred because a partition is full (the ENOSPC
24430 error).
24431
24432
24433
24434 .section "Retry rules for specified senders" "SECID162"
24435 .cindex "retry" "rules; sender-specific"
24436 You can specify retry rules that apply only when the failing message has a
24437 specific sender. In particular, this can be used to define retry rules that
24438 apply only to bounce messages. The third item in a retry rule can be of this
24439 form:
24440 .display
24441 &`senders=`&<&'address list'&>
24442 .endd
24443 The retry timings themselves are then the fourth item. For example:
24444 .code
24445 *   rcpt_4xx   senders=:   F,1h,30m
24446 .endd
24447 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24448 host. If the address list contains white space, it must be enclosed in quotes.
24449 For example:
24450 .code
24451 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24452 .endd
24453 &*Warning*&: This facility can be unhelpful if it is used for host errors
24454 (which do not depend on the recipient). The reason is that the sender is used
24455 only to match the retry rule. Once the rule has been found for a host error,
24456 its contents are used to set a retry time for the host, and this will apply to
24457 all messages, not just those with specific senders.
24458
24459 When testing retry rules using &%-brt%&, you can supply a sender using the
24460 &%-f%& command line option, like this:
24461 .code
24462 exim -f "" -brt user@dom.ain
24463 .endd
24464 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24465 list is never matched.
24466
24467
24468
24469
24470
24471 .section "Retry parameters" "SECID163"
24472 .cindex "retry" "parameters in rules"
24473 The third (or fourth, if a senders list is present) field in a retry rule is a
24474 sequence of retry parameter sets, separated by semicolons. Each set consists of
24475 .display
24476 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24477 .endd
24478 The letter identifies the algorithm for computing a new retry time; the cutoff
24479 time is the time beyond which this algorithm no longer applies, and the
24480 arguments vary the algorithm's action. The cutoff time is measured from the
24481 time that the first failure for the domain (combined with the local part if
24482 relevant) was detected, not from the time the message was received.
24483
24484 .cindex "retry" "algorithms"
24485 .cindex "retry" "fixed intervals"
24486 .cindex "retry" "increasing intervals"
24487 .cindex "retry" "random intervals"
24488 The available algorithms are:
24489
24490 .ilist
24491 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24492 the interval.
24493 .next
24494 &'G'&: retry at geometrically increasing intervals. The first argument
24495 specifies a starting value for the interval, and the second a multiplier, which
24496 is used to increase the size of the interval at each retry.
24497 .next
24498 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24499 retry, the previous interval is multiplied by the factor in order to get a
24500 maximum for the next interval. The minimum interval is the first argument of
24501 the parameter, and an actual interval is chosen randomly between them. Such a
24502 rule has been found to be helpful in cluster configurations when all the
24503 members of the cluster restart at once, and may therefore synchronize their
24504 queue processing times.
24505 .endlist
24506
24507 When computing the next retry time, the algorithm definitions are scanned in
24508 order until one whose cutoff time has not yet passed is reached. This is then
24509 used to compute a new retry time that is later than the current time. In the
24510 case of fixed interval retries, this simply means adding the interval to the
24511 current time. For geometrically increasing intervals, retry intervals are
24512 computed from the rule's parameters until one that is greater than the previous
24513 interval is found. The main configuration variable
24514 .cindex "limit" "retry interval"
24515 .cindex "retry" "interval, maximum"
24516 .oindex "&%retry_interval_max%&"
24517 &%retry_interval_max%& limits the maximum interval between retries. It
24518 cannot be set greater than &`24h`&, which is its default value.
24519
24520 A single remote domain may have a number of hosts associated with it, and each
24521 host may have more than one IP address. Retry algorithms are selected on the
24522 basis of the domain name, but are applied to each IP address independently. If,
24523 for example, a host has two IP addresses and one is unusable, Exim will
24524 generate retry times for it and will not try to use it until its next retry
24525 time comes. Thus the good IP address is likely to be tried first most of the
24526 time.
24527
24528 .cindex "hints database" "use for retrying"
24529 Retry times are hints rather than promises. Exim does not make any attempt to
24530 run deliveries exactly at the computed times. Instead, a queue runner process
24531 starts delivery processes for delayed messages periodically, and these attempt
24532 new deliveries only for those addresses that have passed their next retry time.
24533 If a new message arrives for a deferred address, an immediate delivery attempt
24534 occurs only if the address has passed its retry time. In the absence of new
24535 messages, the minimum time between retries is the interval between queue runner
24536 processes. There is not much point in setting retry times of five minutes if
24537 your queue runners happen only once an hour, unless there are a significant
24538 number of incoming messages (which might be the case on a system that is
24539 sending everything to a smart host, for example).
24540
24541 The data in the retry hints database can be inspected by using the
24542 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24543 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24544 &'exinext'& utility script can be used to find out what the next retry times
24545 are for the hosts associated with a particular mail domain, and also for local
24546 deliveries that have been deferred.
24547
24548
24549 .section "Retry rule examples" "SECID164"
24550 Here are some example retry rules:
24551 .code
24552 alice@wonderland.fict.example quota_5d  F,7d,3h
24553 wonderland.fict.example       quota_5d
24554 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24555 lookingglass.fict.example     *         F,24h,30m;
24556 *                 refused_A   F,2h,20m;
24557 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24558 .endd
24559 The first rule sets up special handling for mail to
24560 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24561 mailbox has not been read for at least 5 days. Retries continue every three
24562 hours for 7 days. The second rule handles over-quota errors for all other local
24563 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24564 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24565 fail are bounced immediately if the mailbox has not been read for at least 5
24566 days.
24567
24568 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24569 happen every 15 minutes for an hour, then with geometrically increasing
24570 intervals until two days have passed since a delivery first failed. After the
24571 first hour there is a delay of one hour, then two hours, then four hours, and
24572 so on (this is a rather extreme example).
24573
24574 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24575 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24576 all other domains, with special action for connection refusal from hosts that
24577 were not obtained from an MX record.
24578
24579 The final rule in a retry configuration should always have asterisks in the
24580 first two fields so as to provide a general catch-all for any addresses that do
24581 not have their own special handling. This example tries every 15 minutes for 2
24582 hours, then with intervals starting at one hour and increasing by a factor of
24583 1.5 up to 16 hours, then every 8 hours up to 5 days.
24584
24585
24586
24587 .section "Timeout of retry data" "SECID165"
24588 .cindex "timeout" "of retry data"
24589 .oindex "&%retry_data_expire%&"
24590 .cindex "hints database" "data expiry"
24591 .cindex "retry" "timeout of data"
24592 Exim timestamps the data that it writes to its retry hints database. When it
24593 consults the data during a delivery it ignores any that is older than the value
24594 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24595 been tried for 7 days, Exim will try to deliver to it immediately a message
24596 arrives, and if that fails, it will calculate a retry time as if it were
24597 failing for the first time.
24598
24599 This improves the behaviour for messages routed to rarely-used hosts such as MX
24600 backups. If such a host was down at one time, and happens to be down again when
24601 Exim tries a month later, using the old retry data would imply that it had been
24602 down all the time, which is not a justified assumption.
24603
24604 If a host really is permanently dead, this behaviour causes a burst of retries
24605 every now and again, but only if messages routed to it are rare. If there is a
24606 message at least once every 7 days the retry data never expires.
24607
24608
24609
24610
24611 .section "Long-term failures" "SECID166"
24612 .cindex "delivery failure, long-term"
24613 .cindex "retry" "after long-term failure"
24614 Special processing happens when an email address has been failing for so long
24615 that the cutoff time for the last algorithm is reached. For example, using the
24616 default retry rule:
24617 .code
24618 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24619 .endd
24620 the cutoff time is four days. Reaching the retry cutoff is independent of how
24621 long any specific message has been failing; it is the length of continuous
24622 failure for the recipient address that counts.
24623
24624 When the cutoff time is reached for a local delivery, or for all the IP
24625 addresses associated with a remote delivery, a subsequent delivery failure
24626 causes Exim to give up on the address, and a bounce message is generated.
24627 In order to cater for new messages that use the failing address, a next retry
24628 time is still computed from the final algorithm, and is used as follows:
24629
24630 For local deliveries, one delivery attempt is always made for any subsequent
24631 messages. If this delivery fails, the address fails immediately. The
24632 post-cutoff retry time is not used.
24633
24634 If the delivery is remote, there are two possibilities, controlled by the
24635 .oindex "&%delay_after_cutoff%&"
24636 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24637 default. Until the post-cutoff retry time for one of the IP addresses is
24638 reached, the failing email address is bounced immediately, without a delivery
24639 attempt taking place. After that time, one new delivery attempt is made to
24640 those IP addresses that are past their retry times, and if that still fails,
24641 the address is bounced and new retry times are computed.
24642
24643 In other words, when all the hosts for a given email address have been failing
24644 for a long time, Exim bounces rather then defers until one of the hosts' retry
24645 times is reached. Then it tries once, and bounces if that attempt fails. This
24646 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24647 to a broken destination, but if the host does recover, Exim will eventually
24648 notice.
24649
24650 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24651 addresses are past their final cutoff time, Exim tries to deliver to those IP
24652 addresses that have not been tried since the message arrived. If there are
24653 no suitable IP addresses, or if they all fail, the address is bounced. In other
24654 words, it does not delay when a new message arrives, but tries the expired
24655 addresses immediately, unless they have been tried since the message arrived.
24656 If there is a continuous stream of messages for the failing domains, setting
24657 &%delay_after_cutoff%& false means that there will be many more attempts to
24658 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24659 true.
24660
24661 .section "Deliveries that work intermittently" "SECID167"
24662 .cindex "retry" "intermittently working deliveries"
24663 Some additional logic is needed to cope with cases where a host is
24664 intermittently available, or when a message has some attribute that prevents
24665 its delivery when others to the same address get through. In this situation,
24666 because some messages are successfully delivered, the &"retry clock"& for the
24667 host or address keeps getting reset by the successful deliveries, and so
24668 failing messages remain on the queue for ever because the cutoff time is never
24669 reached.
24670
24671 Two exceptional actions are applied to prevent this happening. The first
24672 applies to errors that are related to a message rather than a remote host.
24673 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24674 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24675 commands, and quota failures. For this type of error, if a message's arrival
24676 time is earlier than the &"first failed"& time for the error, the earlier time
24677 is used when scanning the retry rules to decide when to try next and when to
24678 time out the address.
24679
24680 The exceptional second action applies in all cases. If a message has been on
24681 the queue for longer than the cutoff time of any applicable retry rule for a
24682 given address, a delivery is attempted for that address, even if it is not yet
24683 time, and if this delivery fails, the address is timed out. A new retry time is
24684 not computed in this case, so that other messages for the same address are
24685 considered immediately.
24686 .ecindex IIDretconf1
24687 .ecindex IIDregconf2
24688
24689
24690
24691
24692
24693
24694 . ////////////////////////////////////////////////////////////////////////////
24695 . ////////////////////////////////////////////////////////////////////////////
24696
24697 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24698 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24699 .scindex IIDauthconf2 "authentication"
24700 The &"authenticators"& section of Exim's run time configuration is concerned
24701 with SMTP authentication. This facility is an extension to the SMTP protocol,
24702 described in RFC 2554, which allows a client SMTP host to authenticate itself
24703 to a server. This is a common way for a server to recognize clients that are
24704 permitted to use it as a relay. SMTP authentication is not of relevance to the
24705 transfer of mail between servers that have no managerial connection with each
24706 other.
24707
24708 .cindex "AUTH" "description of"
24709 Very briefly, the way SMTP authentication works is as follows:
24710
24711 .ilist
24712 The server advertises a number of authentication &'mechanisms'& in response to
24713 the client's EHLO command.
24714 .next
24715 The client issues an AUTH command, naming a specific mechanism. The command
24716 may, optionally, contain some authentication data.
24717 .next
24718 The server may issue one or more &'challenges'&, to which the client must send
24719 appropriate responses. In simple authentication mechanisms, the challenges are
24720 just prompts for user names and passwords. The server does not have to issue
24721 any challenges &-- in some mechanisms the relevant data may all be transmitted
24722 with the AUTH command.
24723 .next
24724 The server either accepts or denies authentication.
24725 .next
24726 If authentication succeeds, the client may optionally make use of the AUTH
24727 option on the MAIL command to pass an authenticated sender in subsequent
24728 mail transactions. Authentication lasts for the remainder of the SMTP
24729 connection.
24730 .next
24731 If authentication fails, the client may give up, or it may try a different
24732 authentication mechanism, or it may try transferring mail over the
24733 unauthenticated connection.
24734 .endlist
24735
24736 If you are setting up a client, and want to know which authentication
24737 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24738 SMTP port) on the server, and issue an EHLO command. The response to this
24739 includes the list of supported mechanisms. For example:
24740 .display
24741 &`$ `&&*&`telnet server.example 25`&*&
24742 &`Trying 192.168.34.25...`&
24743 &`Connected to server.example.`&
24744 &`Escape character is &#x0027;^]&#x0027;.`&
24745 &`220 server.example ESMTP Exim 4.20 ...`&
24746 &*&`ehlo client.example`&*&
24747 &`250-server.example Hello client.example [10.8.4.5]`&
24748 &`250-SIZE 52428800`&
24749 &`250-PIPELINING`&
24750 &`250-AUTH PLAIN`&
24751 &`250 HELP`&
24752 .endd
24753 The second-last line of this example output shows that the server supports
24754 authentication using the PLAIN mechanism. In Exim, the different authentication
24755 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24756 routers and transports, which authenticators are included in the binary is
24757 controlled by build-time definitions. The following are currently available,
24758 included by setting
24759 .code
24760 AUTH_CRAM_MD5=yes
24761 AUTH_CYRUS_SASL=yes
24762 AUTH_DOVECOT=yes
24763 AUTH_GSASL=yes
24764 AUTH_HEIMDAL_GSSAPI=yes
24765 AUTH_PLAINTEXT=yes
24766 AUTH_SPA=yes
24767 .endd
24768 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24769 authentication mechanism (RFC 2195), and the second provides an interface to
24770 the Cyrus SASL authentication library.
24771 The third is an interface to Dovecot's authentication system, delegating the
24772 work via a socket interface.
24773 The fourth provides an interface to the GNU SASL authentication library, which
24774 provides mechanisms but typically not data sources.
24775 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24776 supporting setting a server keytab.
24777 The sixth can be configured to support
24778 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24779 not formally documented, but used by several MUAs. The seventh authenticator
24780 supports Microsoft's &'Secure Password Authentication'& mechanism.
24781
24782 The authenticators are configured using the same syntax as other drivers (see
24783 section &<<SECTfordricon>>&). If no authenticators are required, no
24784 authentication section need be present in the configuration file. Each
24785 authenticator can in principle have both server and client functions. When Exim
24786 is receiving SMTP mail, it is acting as a server; when it is sending out
24787 messages over SMTP, it is acting as a client. Authenticator configuration
24788 options are provided for use in both these circumstances.
24789
24790 To make it clear which options apply to which situation, the prefixes
24791 &%server_%& and &%client_%& are used on option names that are specific to
24792 either the server or the client function, respectively. Server and client
24793 functions are disabled if none of their options are set. If an authenticator is
24794 to be used for both server and client functions, a single definition, using
24795 both sets of options, is required. For example:
24796 .code
24797 cram:
24798   driver = cram_md5
24799   public_name = CRAM-MD5
24800   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24801   client_name = ph10
24802   client_secret = secret2
24803 .endd
24804 The &%server_%& option is used when Exim is acting as a server, and the
24805 &%client_%& options when it is acting as a client.
24806
24807 Descriptions of the individual authenticators are given in subsequent chapters.
24808 The remainder of this chapter covers the generic options for the
24809 authenticators, followed by general discussion of the way authentication works
24810 in Exim.
24811
24812 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24813 per-mechanism basis.  Please read carefully to determine which variables hold
24814 account labels such as usercodes and which hold passwords or other
24815 authenticating data.
24816
24817 Note that some mechanisms support two different identifiers for accounts: the
24818 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24819 and &'authz'& are commonly encountered.  The American spelling is standard here.
24820 Conceptually, authentication data such as passwords are tied to the identifier
24821 used to authenticate; servers may have rules to permit one user to act as a
24822 second user, so that after login the session is treated as though that second
24823 user had logged in.  That second user is the &'authorization id'&.  A robust
24824 configuration might confirm that the &'authz'& field is empty or matches the
24825 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24826 as verified data, the &'authz'& as an unverified request which the server might
24827 choose to honour.
24828
24829 A &'realm'& is a text string, typically a domain name, presented by a server
24830 to a client to help it select an account and credentials to use.  In some
24831 mechanisms, the client and server provably agree on the realm, but clients
24832 typically can not treat the realm as secure data to be blindly trusted.
24833
24834
24835
24836 .section "Generic options for authenticators" "SECID168"
24837 .cindex "authentication" "generic options"
24838 .cindex "options" "generic; for authenticators"
24839
24840 .option client_condition authenticators string&!! unset
24841 When Exim is authenticating as a client, it skips any authenticator whose
24842 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24843 used, for example, to skip plain text authenticators when the connection is not
24844 encrypted by a setting such as:
24845 .code
24846 client_condition = ${if !eq{$tls_out_cipher}{}}
24847 .endd
24848
24849
24850 .option client_set_id authenticators string&!! unset
24851 When client authentication succeeds, this condition is expanded; the
24852 result is used in the log lines for outbound messasges.
24853 Typically it will be the user name used for authentication.
24854
24855
24856 .option driver authenticators string unset
24857 This option must always be set. It specifies which of the available
24858 authenticators is to be used.
24859
24860
24861 .option public_name authenticators string unset
24862 This option specifies the name of the authentication mechanism that the driver
24863 implements, and by which it is known to the outside world. These names should
24864 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24865 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24866 defaults to the driver's instance name.
24867
24868
24869 .option server_advertise_condition authenticators string&!! unset
24870 When a server is about to advertise an authentication mechanism, the condition
24871 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24872 mechanism is not advertised.
24873 If the expansion fails, the mechanism is not advertised. If the failure was not
24874 forced, and was not caused by a lookup defer, the incident is logged.
24875 See section &<<SECTauthexiser>>& below for further discussion.
24876
24877
24878 .option server_condition authenticators string&!! unset
24879 This option must be set for a &%plaintext%& server authenticator, where it
24880 is used directly to control authentication. See section &<<SECTplainserver>>&
24881 for details.
24882
24883 For the &(gsasl)& authenticator, this option is required for various
24884 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24885
24886 For the other authenticators, &%server_condition%& can be used as an additional
24887 authentication or authorization mechanism that is applied after the other
24888 authenticator conditions succeed. If it is set, it is expanded when the
24889 authenticator would otherwise return a success code. If the expansion is forced
24890 to fail, authentication fails. Any other expansion failure causes a temporary
24891 error code to be returned. If the result of a successful expansion is an empty
24892 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24893 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24894 other result, a temporary error code is returned, with the expanded string as
24895 the error text.
24896
24897
24898 .option server_debug_print authenticators string&!! unset
24899 If this option is set and authentication debugging is enabled (see the &%-d%&
24900 command line option), the string is expanded and included in the debugging
24901 output when the authenticator is run as a server. This can help with checking
24902 out the values of variables.
24903 If expansion of the string fails, the error message is written to the debugging
24904 output, and Exim carries on processing.
24905
24906
24907 .option server_set_id authenticators string&!! unset
24908 .vindex "&$authenticated_id$&"
24909 When an Exim server successfully authenticates a client, this string is
24910 expanded using data from the authentication, and preserved for any incoming
24911 messages in the variable &$authenticated_id$&. It is also included in the log
24912 lines for incoming messages. For example, a user/password authenticator
24913 configuration might preserve the user name that was used to authenticate, and
24914 refer to it subsequently during delivery of the message.
24915 If expansion fails, the option is ignored.
24916
24917
24918 .option server_mail_auth_condition authenticators string&!! unset
24919 This option allows a server to discard authenticated sender addresses supplied
24920 as part of MAIL commands in SMTP connections that are authenticated by the
24921 driver on which &%server_mail_auth_condition%& is set. The option is not used
24922 as part of the authentication process; instead its (unexpanded) value is
24923 remembered for later use.
24924 How it is used is described in the following section.
24925
24926
24927
24928
24929
24930 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24931 .cindex "authentication" "sender; authenticated"
24932 .cindex "AUTH" "on MAIL command"
24933 When a client supplied an AUTH= item on a MAIL command, Exim applies
24934 the following checks before accepting it as the authenticated sender of the
24935 message:
24936
24937 .ilist
24938 If the connection is not using extended SMTP (that is, HELO was used rather
24939 than EHLO), the use of AUTH= is a syntax error.
24940 .next
24941 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24942 .next
24943 .vindex "&$authenticated_sender$&"
24944 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24945 running, the value of &$authenticated_sender$& is set to the value obtained
24946 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24947 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24948 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24949 given for the MAIL command.
24950 .next
24951 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24952 is accepted and placed in &$authenticated_sender$& only if the client has
24953 authenticated.
24954 .next
24955 If the AUTH= value was accepted by either of the two previous rules, and
24956 the client has authenticated, and the authenticator has a setting for the
24957 &%server_mail_auth_condition%&, the condition is checked at this point. The
24958 valued that was saved from the authenticator is expanded. If the expansion
24959 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24960 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24961 the value of &$authenticated_sender$& is retained and passed on with the
24962 message.
24963 .endlist
24964
24965
24966 When &$authenticated_sender$& is set for a message, it is passed on to other
24967 hosts to which Exim authenticates as a client. Do not confuse this value with
24968 &$authenticated_id$&, which is a string obtained from the authentication
24969 process, and which is not usually a complete email address.
24970
24971 .vindex "&$sender_address$&"
24972 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24973 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24974 therefore make use of &$authenticated_sender$&. The converse is not true: the
24975 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24976 ACL is run.
24977
24978
24979
24980 .section "Authentication on an Exim server" "SECTauthexiser"
24981 .cindex "authentication" "on an Exim server"
24982 When Exim receives an EHLO command, it advertises the public names of those
24983 authenticators that are configured as servers, subject to the following
24984 conditions:
24985
24986 .ilist
24987 The client host must match &%auth_advertise_hosts%& (default *).
24988 .next
24989 It the &%server_advertise_condition%& option is set, its expansion must not
24990 yield the empty string, &"0"&, &"no"&, or &"false"&.
24991 .endlist
24992
24993 The order in which the authenticators are defined controls the order in which
24994 the mechanisms are advertised.
24995
24996 Some mail clients (for example, some versions of Netscape) require the user to
24997 provide a name and password for authentication whenever AUTH is advertised,
24998 even though authentication may not in fact be needed (for example, Exim may be
24999 set up to allow unconditional relaying from the client by an IP address check).
25000 You can make such clients more friendly by not advertising AUTH to them.
25001 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25002 that runs for RCPT) to relay without authentication, you should set
25003 .code
25004 auth_advertise_hosts = ! 10.9.8.0/24
25005 .endd
25006 so that no authentication mechanisms are advertised to them.
25007
25008 The &%server_advertise_condition%& controls the advertisement of individual
25009 authentication mechanisms. For example, it can be used to restrict the
25010 advertisement of a particular mechanism to encrypted connections, by a setting
25011 such as:
25012 .code
25013 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25014 .endd
25015 .vindex "&$tls_in_cipher$&"
25016 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25017 yields &"yes"&, which allows the advertisement to happen.
25018
25019 When an Exim server receives an AUTH command from a client, it rejects it
25020 immediately if AUTH was not advertised in response to an earlier EHLO
25021 command. This is the case if
25022
25023 .ilist
25024 The client host does not match &%auth_advertise_hosts%&; or
25025 .next
25026 No authenticators are configured with server options; or
25027 .next
25028 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25029 server authenticators.
25030 .endlist
25031
25032
25033 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25034 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25035 AUTH is accepted from any client host.
25036
25037 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25038 server authentication mechanism that was advertised in response to EHLO and
25039 that matches the one named in the AUTH command. If it finds one, it runs
25040 the appropriate authentication protocol, and authentication either succeeds or
25041 fails. If there is no matching advertised mechanism, the AUTH command is
25042 rejected with a 504 error.
25043
25044 .vindex "&$received_protocol$&"
25045 .vindex "&$sender_host_authenticated$&"
25046 When a message is received from an authenticated host, the value of
25047 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25048 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25049 public name) of the authenticator driver that successfully authenticated the
25050 client from which the message was received. This variable is empty if there was
25051 no successful authentication.
25052
25053
25054
25055
25056 .section "Testing server authentication" "SECID169"
25057 .cindex "authentication" "testing a server"
25058 .cindex "AUTH" "testing a server"
25059 .cindex "base64 encoding" "creating authentication test data"
25060 Exim's &%-bh%& option can be useful for testing server authentication
25061 configurations. The data for the AUTH command has to be sent using base64
25062 encoding. A quick way to produce such data for testing is the following Perl
25063 script:
25064 .code
25065 use MIME::Base64;
25066 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25067 .endd
25068 .cindex "binary zero" "in authentication data"
25069 This interprets its argument as a Perl string, and then encodes it. The
25070 interpretation as a Perl string allows binary zeros, which are required for
25071 some kinds of authentication, to be included in the data. For example, a
25072 command line to run this script on such data might be
25073 .code
25074 encode '\0user\0password'
25075 .endd
25076 Note the use of single quotes to prevent the shell interpreting the
25077 backslashes, so that they can be interpreted by Perl to specify characters
25078 whose code value is zero.
25079
25080 &*Warning 1*&: If either of the user or password strings starts with an octal
25081 digit, you must use three zeros instead of one after the leading backslash. If
25082 you do not, the octal digit that starts your string will be incorrectly
25083 interpreted as part of the code for the first character.
25084
25085 &*Warning 2*&: If there are characters in the strings that Perl interprets
25086 specially, you must use a Perl escape to prevent them being misinterpreted. For
25087 example, a command such as
25088 .code
25089 encode '\0user@domain.com\0pas$$word'
25090 .endd
25091 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25092
25093 If you have the &%mimencode%& command installed, another way to do produce
25094 base64-encoded strings is to run the command
25095 .code
25096 echo -e -n `\0user\0password' | mimencode
25097 .endd
25098 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25099 in the argument, and the &%-n%& option specifies no newline at the end of its
25100 output. However, not all versions of &%echo%& recognize these options, so you
25101 should check your version before relying on this suggestion.
25102
25103
25104
25105 .section "Authentication by an Exim client" "SECID170"
25106 .cindex "authentication" "on an Exim client"
25107 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25108 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25109 announces support for authentication, and the host matches an entry in either
25110 of these options, Exim (as a client) tries to authenticate as follows:
25111
25112 .ilist
25113 For each authenticator that is configured as a client, in the order in which
25114 they are defined in the configuration, it searches the authentication
25115 mechanisms announced by the server for one whose name matches the public name
25116 of the authenticator.
25117 .next
25118 .vindex "&$host$&"
25119 .vindex "&$host_address$&"
25120 When it finds one that matches, it runs the authenticator's client code. The
25121 variables &$host$& and &$host_address$& are available for any string expansions
25122 that the client might do. They are set to the server's name and IP address. If
25123 any expansion is forced to fail, the authentication attempt is abandoned, and
25124 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25125 delivery to be deferred.
25126 .next
25127 If the result of the authentication attempt is a temporary error or a timeout,
25128 Exim abandons trying to send the message to the host for the moment. It will
25129 try again later. If there are any backup hosts available, they are tried in the
25130 usual way.
25131 .next
25132 If the response to authentication is a permanent error (5&'xx'& code), Exim
25133 carries on searching the list of authenticators and tries another one if
25134 possible. If all authentication attempts give permanent errors, or if there are
25135 no attempts because no mechanisms match (or option expansions force failure),
25136 what happens depends on whether the host matches &%hosts_require_auth%& or
25137 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25138 delivery is deferred. The error can be detected in the retry rules, and thereby
25139 turned into a permanent error if you wish. In the second case, Exim tries to
25140 deliver the message unauthenticated.
25141 .endlist
25142
25143 .cindex "AUTH" "on MAIL command"
25144 When Exim has authenticated itself to a remote server, it adds the AUTH
25145 parameter to the MAIL commands it sends, if it has an authenticated sender for
25146 the message. If the message came from a remote host, the authenticated sender
25147 is the one that was receiving on an incoming MAIL command, provided that the
25148 incoming connection was authenticated and the &%server_mail_auth%& condition
25149 allowed the authenticated sender to be retained. If a local process calls Exim
25150 to send a message, the sender address that is built from the login name and
25151 &%qualify_domain%& is treated as authenticated. However, if the
25152 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25153 the authenticated sender that was received with the message.
25154 .ecindex IIDauthconf1
25155 .ecindex IIDauthconf2
25156
25157
25158
25159
25160
25161
25162 . ////////////////////////////////////////////////////////////////////////////
25163 . ////////////////////////////////////////////////////////////////////////////
25164
25165 .chapter "The plaintext authenticator" "CHAPplaintext"
25166 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25167 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25168 The &(plaintext)& authenticator can be configured to support the PLAIN and
25169 LOGIN authentication mechanisms, both of which transfer authentication data as
25170 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25171 security risk; you are strongly advised to insist on the use of SMTP encryption
25172 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25173 use unencrypted plain text, you should not use the same passwords for SMTP
25174 connections as you do for login accounts.
25175
25176 .section "Plaintext options" "SECID171"
25177 .cindex "options" "&(plaintext)& authenticator (server)"
25178 When configured as a server, &(plaintext)& uses the following options:
25179
25180 .option server_condition authenticators string&!! unset
25181 This is actually a global authentication option, but it must be set in order to
25182 configure the &(plaintext)& driver as a server. Its use is described below.
25183
25184 .option server_prompts plaintext string&!! unset
25185 The contents of this option, after expansion, must be a colon-separated list of
25186 prompt strings. If expansion fails, a temporary authentication rejection is
25187 given.
25188
25189 .section "Using plaintext in a server" "SECTplainserver"
25190 .cindex "AUTH" "in &(plaintext)& authenticator"
25191 .cindex "binary zero" "in &(plaintext)& authenticator"
25192 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25193         "in &(plaintext)& authenticator"
25194 .vindex "&$auth1$&, &$auth2$&, etc"
25195 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25196
25197 When running as a server, &(plaintext)& performs the authentication test by
25198 expanding a string. The data sent by the client with the AUTH command, or in
25199 response to subsequent prompts, is base64 encoded, and so may contain any byte
25200 values when decoded. If any data is supplied with the command, it is treated as
25201 a list of strings, separated by NULs (binary zeros), the first three of which
25202 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25203 (neither LOGIN nor PLAIN uses more than three strings).
25204
25205 For compatibility with previous releases of Exim, the values are also placed in
25206 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25207 variables for this purpose is now deprecated, as it can lead to confusion in
25208 string expansions that also use them for other things.
25209
25210 If there are more strings in &%server_prompts%& than the number of strings
25211 supplied with the AUTH command, the remaining prompts are used to obtain more
25212 data. Each response from the client may be a list of NUL-separated strings.
25213
25214 .vindex "&$authenticated_id$&"
25215 Once a sufficient number of data strings have been received,
25216 &%server_condition%& is expanded. If the expansion is forced to fail,
25217 authentication fails. Any other expansion failure causes a temporary error code
25218 to be returned. If the result of a successful expansion is an empty string,
25219 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25220 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25221 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25222 For any other result, a temporary error code is returned, with the expanded
25223 string as the error text
25224
25225 &*Warning*&: If you use a lookup in the expansion to find the user's
25226 password, be sure to make the authentication fail if the user is unknown.
25227 There are good and bad examples at the end of the next section.
25228
25229
25230
25231 .section "The PLAIN authentication mechanism" "SECID172"
25232 .cindex "PLAIN authentication mechanism"
25233 .cindex "authentication" "PLAIN mechanism"
25234 .cindex "binary zero" "in &(plaintext)& authenticator"
25235 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25236 sent as one item of data (that is, one combined string containing two NUL
25237 separators). The data is sent either as part of the AUTH command, or
25238 subsequently in response to an empty prompt from the server.
25239
25240 The second and third strings are a user name and a corresponding password.
25241 Using a single fixed user name and password as an example, this could be
25242 configured as follows:
25243 .code
25244 fixed_plain:
25245   driver = plaintext
25246   public_name = PLAIN
25247   server_prompts = :
25248   server_condition = \
25249     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25250   server_set_id = $auth2
25251 .endd
25252 Note that the default result strings from &%if%& (&"true"& or an empty string)
25253 are exactly what we want here, so they need not be specified. Obviously, if the
25254 password contains expansion-significant characters such as dollar, backslash,
25255 or closing brace, they have to be escaped.
25256
25257 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25258 the end of a string list are ignored). If all the data comes as part of the
25259 AUTH command, as is commonly the case, the prompt is not used. This
25260 authenticator is advertised in the response to EHLO as
25261 .code
25262 250-AUTH PLAIN
25263 .endd
25264 and a client host can authenticate itself by sending the command
25265 .code
25266 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25267 .endd
25268 As this contains three strings (more than the number of prompts), no further
25269 data is required from the client. Alternatively, the client may just send
25270 .code
25271 AUTH PLAIN
25272 .endd
25273 to initiate authentication, in which case the server replies with an empty
25274 prompt. The client must respond with the combined data string.
25275
25276 The data string is base64 encoded, as required by the RFC. This example,
25277 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25278 represents a zero byte. This is split up into three strings, the first of which
25279 is empty. The &%server_condition%& option in the authenticator checks that the
25280 second two are &`username`& and &`mysecret`& respectively.
25281
25282 Having just one fixed user name and password, as in this example, is not very
25283 realistic, though for a small organization with only a handful of
25284 authenticating clients it could make sense.
25285
25286 A more sophisticated instance of this authenticator could use the user name in
25287 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25288 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25289 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25290 This is an incorrect example:
25291 .code
25292 server_condition = \
25293   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25294 .endd
25295 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25296 which it then compares to the supplied password (&$auth3$&). Why is this example
25297 incorrect? It works fine for existing users, but consider what happens if a
25298 non-existent user name is given. The lookup fails, but as no success/failure
25299 strings are given for the lookup, it yields an empty string. Thus, to defeat
25300 the authentication, all a client has to do is to supply a non-existent user
25301 name and an empty password. The correct way of writing this test is:
25302 .code
25303 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25304   {${if eq{$value}{$auth3}}} {false}}
25305 .endd
25306 In this case, if the lookup succeeds, the result is checked; if the lookup
25307 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25308 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25309 always fails if its second argument is empty. However, the second way of
25310 writing the test makes the logic clearer.
25311
25312
25313 .section "The LOGIN authentication mechanism" "SECID173"
25314 .cindex "LOGIN authentication mechanism"
25315 .cindex "authentication" "LOGIN mechanism"
25316 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25317 in a number of programs. No data is sent with the AUTH command. Instead, a
25318 user name and password are supplied separately, in response to prompts. The
25319 plaintext authenticator can be configured to support this as in this example:
25320 .code
25321 fixed_login:
25322   driver = plaintext
25323   public_name = LOGIN
25324   server_prompts = User Name : Password
25325   server_condition = \
25326     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25327   server_set_id = $auth1
25328 .endd
25329 Because of the way plaintext operates, this authenticator accepts data supplied
25330 with the AUTH command (in contravention of the specification of LOGIN), but
25331 if the client does not supply it (as is the case for LOGIN clients), the prompt
25332 strings are used to obtain two data items.
25333
25334 Some clients are very particular about the precise text of the prompts. For
25335 example, Outlook Express is reported to recognize only &"Username:"& and
25336 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25337 strings. It uses the &%ldapauth%& expansion condition to check the user
25338 name and password by binding to an LDAP server:
25339 .code
25340 login:
25341   driver = plaintext
25342   public_name = LOGIN
25343   server_prompts = Username:: : Password::
25344   server_condition = ${if and{{ \
25345     !eq{}{$auth1} }{ \
25346     ldapauth{\
25347       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25348       pass=${quote:$auth2} \
25349       ldap://ldap.example.org/} }} }
25350   server_set_id = uid=$auth1,ou=people,o=example.org
25351 .endd
25352 We have to check that the username is not empty before using it, because LDAP
25353 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25354 operator to correctly quote the DN for authentication. However, the basic
25355 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25356 correct one to use for the password, because quoting is needed only to make
25357 the password conform to the Exim syntax. At the LDAP level, the password is an
25358 uninterpreted string.
25359
25360
25361 .section "Support for different kinds of authentication" "SECID174"
25362 A number of string expansion features are provided for the purpose of
25363 interfacing to different ways of user authentication. These include checking
25364 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25365 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25366 &<<SECTexpcond>>&.
25367
25368
25369
25370
25371 .section "Using plaintext in a client" "SECID175"
25372 .cindex "options" "&(plaintext)& authenticator (client)"
25373 The &(plaintext)& authenticator has two client options:
25374
25375 .option client_ignore_invalid_base64 plaintext boolean false
25376 If the client receives a server prompt that is not a valid base64 string,
25377 authentication is abandoned by default. However, if this option is set true,
25378 the error in the challenge is ignored and the client sends the response as
25379 usual.
25380
25381 .option client_send plaintext string&!! unset
25382 The string is a colon-separated list of authentication data strings. Each
25383 string is independently expanded before being sent to the server. The first
25384 string is sent with the AUTH command; any more strings are sent in response
25385 to prompts from the server. Before each string is expanded, the value of the
25386 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25387 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25388 way. Thus, the prompt that is received in response to sending the first string
25389 (with the AUTH command) can be used in the expansion of the second string, and
25390 so on. If an invalid base64 string is received when
25391 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25392 &$auth$&<&'n'&> variable.
25393
25394 &*Note*&: You cannot use expansion to create multiple strings, because
25395 splitting takes priority and happens first.
25396
25397 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25398 the data, further processing is applied to each string before it is sent. If
25399 there are any single circumflex characters in the string, they are converted to
25400 NULs. Should an actual circumflex be required as data, it must be doubled in
25401 the string.
25402
25403 This is an example of a client configuration that implements the PLAIN
25404 authentication mechanism with a fixed user name and password:
25405 .code
25406 fixed_plain:
25407   driver = plaintext
25408   public_name = PLAIN
25409   client_send = ^username^mysecret
25410 .endd
25411 The lack of colons means that the entire text is sent with the AUTH
25412 command, with the circumflex characters converted to NULs. A similar example
25413 that uses the LOGIN mechanism is:
25414 .code
25415 fixed_login:
25416   driver = plaintext
25417   public_name = LOGIN
25418   client_send = : username : mysecret
25419 .endd
25420 The initial colon means that the first string is empty, so no data is sent with
25421 the AUTH command itself. The remaining strings are sent in response to
25422 prompts.
25423 .ecindex IIDplaiauth1
25424 .ecindex IIDplaiauth2
25425
25426
25427
25428
25429 . ////////////////////////////////////////////////////////////////////////////
25430 . ////////////////////////////////////////////////////////////////////////////
25431
25432 .chapter "The cram_md5 authenticator" "CHID9"
25433 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25434 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25435 .cindex "CRAM-MD5 authentication mechanism"
25436 .cindex "authentication" "CRAM-MD5 mechanism"
25437 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25438 sends a challenge string to the client, and the response consists of a user
25439 name and the CRAM-MD5 digest of the challenge string combined with a secret
25440 string (password) which is known to both server and client. Thus, the secret
25441 is not sent over the network as plain text, which makes this authenticator more
25442 secure than &(plaintext)&. However, the downside is that the secret has to be
25443 available in plain text at either end.
25444
25445
25446 .section "Using cram_md5 as a server" "SECID176"
25447 .cindex "options" "&(cram_md5)& authenticator (server)"
25448 This authenticator has one server option, which must be set to configure the
25449 authenticator as a server:
25450
25451 .option server_secret cram_md5 string&!! unset
25452 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25453 When the server receives the client's response, the user name is placed in
25454 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25455 obtain the password for that user. The server then computes the CRAM-MD5 digest
25456 that the client should have sent, and checks that it received the correct
25457 string. If the expansion of &%server_secret%& is forced to fail, authentication
25458 fails. If the expansion fails for some other reason, a temporary error code is
25459 returned to the client.
25460
25461 For compatibility with previous releases of Exim, the user name is also placed
25462 in &$1$&. However, the use of this variables for this purpose is now
25463 deprecated, as it can lead to confusion in string expansions that also use
25464 numeric variables for other things.
25465
25466 For example, the following authenticator checks that the user name given by the
25467 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25468 user name, authentication fails.
25469 .code
25470 fixed_cram:
25471   driver = cram_md5
25472   public_name = CRAM-MD5
25473   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25474   server_set_id = $auth1
25475 .endd
25476 .vindex "&$authenticated_id$&"
25477 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25478 name in &$authenticated_id$&. A more typical configuration might look up the
25479 secret string in a file, using the user name as the key. For example:
25480 .code
25481 lookup_cram:
25482   driver = cram_md5
25483   public_name = CRAM-MD5
25484   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25485                   {$value}fail}
25486   server_set_id = $auth1
25487 .endd
25488 Note that this expansion explicitly forces failure if the lookup fails
25489 because &$auth1$& contains an unknown user name.
25490
25491 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25492 using the relevant libraries, you need to know the realm to specify in the
25493 lookup and then ask for the &"userPassword"& attribute for that user in that
25494 realm, with:
25495 .code
25496 cyrusless_crammd5:
25497   driver = cram_md5
25498   public_name = CRAM-MD5
25499   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25500                   dbmjz{/etc/sasldb2}}
25501   server_set_id = $auth1
25502 .endd
25503
25504 .section "Using cram_md5 as a client" "SECID177"
25505 .cindex "options" "&(cram_md5)& authenticator (client)"
25506 When used as a client, the &(cram_md5)& authenticator has two options:
25507
25508
25509
25510 .option client_name cram_md5 string&!! "the primary host name"
25511 This string is expanded, and the result used as the user name data when
25512 computing the response to the server's challenge.
25513
25514
25515 .option client_secret cram_md5 string&!! unset
25516 This option must be set for the authenticator to work as a client. Its value is
25517 expanded and the result used as the secret string when computing the response.
25518
25519
25520 .vindex "&$host$&"
25521 .vindex "&$host_address$&"
25522 Different user names and secrets can be used for different servers by referring
25523 to &$host$& or &$host_address$& in the options. Forced failure of either
25524 expansion string is treated as an indication that this authenticator is not
25525 prepared to handle this case. Exim moves on to the next configured client
25526 authenticator. Any other expansion failure causes Exim to give up trying to
25527 send the message to the current server.
25528
25529 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25530 strings, is:
25531 .code
25532 fixed_cram:
25533   driver = cram_md5
25534   public_name = CRAM-MD5
25535   client_name = ph10
25536   client_secret = secret
25537 .endd
25538 .ecindex IIDcramauth1
25539 .ecindex IIDcramauth2
25540
25541
25542
25543 . ////////////////////////////////////////////////////////////////////////////
25544 . ////////////////////////////////////////////////////////////////////////////
25545
25546 .chapter "The cyrus_sasl authenticator" "CHID10"
25547 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25548 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25549 .cindex "Cyrus" "SASL library"
25550 .cindex "Kerberos"
25551 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25552 Digital Ltd (&url(http://www.aldigital.co.uk)).
25553
25554 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25555 library implementation of the RFC 2222 (&"Simple Authentication and Security
25556 Layer"&). This library supports a number of authentication mechanisms,
25557 including PLAIN and LOGIN, but also several others that Exim does not support
25558 directly. In particular, there is support for Kerberos authentication.
25559
25560 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25561 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25562 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25563 name of the driver to determine which mechanism to support.
25564
25565 Where access to some kind of secret file is required, for example in GSSAPI
25566 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25567 user, and that the Cyrus SASL library has no way of escalating privileges
25568 by default. You may also find you need to set environment variables,
25569 depending on the driver you are using.
25570
25571 The application name provided by Exim is &"exim"&, so various SASL options may
25572 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25573 Kerberos, note that because of limitations in the GSSAPI interface,
25574 changing the server keytab might need to be communicated down to the Kerberos
25575 layer independently. The mechanism for doing so is dependent upon the Kerberos
25576 implementation.
25577
25578 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25579 may be set to point to an alternative keytab file. Exim will pass this
25580 variable through from its own inherited environment when started as root or the
25581 Exim user. The keytab file needs to be readable by the Exim user.
25582 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25583 environment variable.  In practice, for those releases, the Cyrus authenticator
25584 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25585 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25586
25587
25588 .section "Using cyrus_sasl as a server" "SECID178"
25589 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25590 (on a successful authentication) into &$auth1$&. For compatibility with
25591 previous releases of Exim, the username is also placed in &$1$&. However, the
25592 use of this variable for this purpose is now deprecated, as it can lead to
25593 confusion in string expansions that also use numeric variables for other
25594 things.
25595
25596
25597 .option server_hostname cyrus_sasl string&!! "see below"
25598 This option selects the hostname that is used when communicating with the
25599 library. The default value is &`$primary_hostname`&. It is up to the underlying
25600 SASL plug-in what it does with this data.
25601
25602
25603 .option server_mech cyrus_sasl string "see below"
25604 This option selects the authentication mechanism this driver should use. The
25605 default is the value of the generic &%public_name%& option. This option allows
25606 you to use a different underlying mechanism from the advertised name. For
25607 example:
25608 .code
25609 sasl:
25610   driver = cyrus_sasl
25611   public_name = X-ANYTHING
25612   server_mech = CRAM-MD5
25613   server_set_id = $auth1
25614 .endd
25615
25616 .option server_realm cyrus_sasl string&!! unset
25617 This specifies the SASL realm that the server claims to be in.
25618
25619
25620 .option server_service cyrus_sasl string &`smtp`&
25621 This is the SASL service that the server claims to implement.
25622
25623
25624 For straightforward cases, you do not need to set any of the authenticator's
25625 private options. All you need to do is to specify an appropriate mechanism as
25626 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25627 PLAIN, you could have two authenticators as follows:
25628 .code
25629 sasl_cram_md5:
25630   driver = cyrus_sasl
25631   public_name = CRAM-MD5
25632   server_set_id = $auth1
25633
25634 sasl_plain:
25635   driver = cyrus_sasl
25636   public_name = PLAIN
25637   server_set_id = $auth2
25638 .endd
25639 Cyrus SASL does implement the LOGIN authentication method, even though it is
25640 not a standard method. It is disabled by default in the source distribution,
25641 but it is present in many binary distributions.
25642 .ecindex IIDcyrauth1
25643 .ecindex IIDcyrauth2
25644
25645
25646
25647
25648 . ////////////////////////////////////////////////////////////////////////////
25649 . ////////////////////////////////////////////////////////////////////////////
25650 .chapter "The dovecot authenticator" "CHAPdovecot"
25651 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25652 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25653 This authenticator is an interface to the authentication facility of the
25654 Dovecot POP/IMAP server, which can support a number of authentication methods.
25655 Note that Dovecot must be configured to use auth-client not auth-userdb.
25656 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25657 to use the same mechanisms for SMTP authentication. This is a server
25658 authenticator only. There is only one option:
25659
25660 .option server_socket dovecot string unset
25661
25662 This option must specify the socket that is the interface to Dovecot
25663 authentication. The &%public_name%& option must specify an authentication
25664 mechanism that Dovecot is configured to support. You can have several
25665 authenticators for different mechanisms. For example:
25666 .code
25667 dovecot_plain:
25668   driver = dovecot
25669   public_name = PLAIN
25670   server_socket = /var/run/dovecot/auth-client
25671   server_set_id = $auth1
25672
25673 dovecot_ntlm:
25674   driver = dovecot
25675   public_name = NTLM
25676   server_socket = /var/run/dovecot/auth-client
25677   server_set_id = $auth1
25678 .endd
25679 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25680 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25681 option is passed in the Dovecot authentication command. If, for a TLS
25682 connection, a client certificate has been verified, the &"valid-client-cert"&
25683 option is passed. When authentication succeeds, the identity of the user
25684 who authenticated is placed in &$auth1$&.
25685 .ecindex IIDdcotauth1
25686 .ecindex IIDdcotauth2
25687
25688
25689 . ////////////////////////////////////////////////////////////////////////////
25690 . ////////////////////////////////////////////////////////////////////////////
25691 .chapter "The gsasl authenticator" "CHAPgsasl"
25692 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25693 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25694 .cindex "authentication" "GNU SASL"
25695 .cindex "authentication" "SASL"
25696 .cindex "authentication" "EXTERNAL"
25697 .cindex "authentication" "ANONYMOUS"
25698 .cindex "authentication" "PLAIN"
25699 .cindex "authentication" "LOGIN"
25700 .cindex "authentication" "DIGEST-MD5"
25701 .cindex "authentication" "CRAM-MD5"
25702 .cindex "authentication" "SCRAM-SHA-1"
25703 The &(gsasl)& authenticator provides server integration for the GNU SASL
25704 library and the mechanisms it provides.  This is new as of the 4.80 release
25705 and there are a few areas where the library does not let Exim smoothly
25706 scale to handle future authentication mechanisms, so no guarantee can be
25707 made that any particular new authentication mechanism will be supported
25708 without code changes in Exim.
25709
25710
25711 .option server_channelbinding gsasl boolean false
25712 Some authentication mechanisms are able to use external context at both ends
25713 of the session to bind the authentication to that context, and fail the
25714 authentication process if that context differs.  Specifically, some TLS
25715 ciphersuites can provide identifying information about the cryptographic
25716 context.
25717
25718 This means that certificate identity and verification becomes a non-issue,
25719 as a man-in-the-middle attack will cause the correct client and server to
25720 see different identifiers and authentication will fail.
25721
25722 This is currently only supported when using the GnuTLS library.  This is
25723 only usable by mechanisms which support "channel binding"; at time of
25724 writing, that's the SCRAM family.
25725
25726 This defaults off to ensure smooth upgrade across Exim releases, in case
25727 this option causes some clients to start failing.  Some future release
25728 of Exim may switch the default to be true.
25729
25730
25731 .option server_hostname gsasl string&!! "see below"
25732 This option selects the hostname that is used when communicating with the
25733 library. The default value is &`$primary_hostname`&.
25734 Some mechanisms will use this data.
25735
25736
25737 .option server_mech gsasl string "see below"
25738 This option selects the authentication mechanism this driver should use. The
25739 default is the value of the generic &%public_name%& option. This option allows
25740 you to use a different underlying mechanism from the advertised name. For
25741 example:
25742 .code
25743 sasl:
25744   driver = gsasl
25745   public_name = X-ANYTHING
25746   server_mech = CRAM-MD5
25747   server_set_id = $auth1
25748 .endd
25749
25750
25751 .option server_password gsasl string&!! unset
25752 Various mechanisms need access to the cleartext password on the server, so
25753 that proof-of-possession can be demonstrated on the wire, without sending
25754 the password itself.
25755
25756 The data available for lookup varies per mechanism.
25757 In all cases, &$auth1$& is set to the &'authentication id'&.
25758 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25759 if available, else the empty string.
25760 The &$auth3$& variable will always be the &'realm'& if available,
25761 else the empty string.
25762
25763 A forced failure will cause authentication to defer.
25764
25765 If using this option, it may make sense to set the &%server_condition%&
25766 option to be simply "true".
25767
25768
25769 .option server_realm gsasl string&!! unset
25770 This specifies the SASL realm that the server claims to be in.
25771 Some mechanisms will use this data.
25772
25773
25774 .option server_scram_iter gsasl string&!! unset
25775 This option provides data for the SCRAM family of mechanisms.
25776 &$auth1$& is not available at evaluation time.
25777 (This may change, as we receive feedback on use)
25778
25779
25780 .option server_scram_salt gsasl string&!! unset
25781 This option provides data for the SCRAM family of mechanisms.
25782 &$auth1$& is not available at evaluation time.
25783 (This may change, as we receive feedback on use)
25784
25785
25786 .option server_service gsasl string &`smtp`&
25787 This is the SASL service that the server claims to implement.
25788 Some mechanisms will use this data.
25789
25790
25791 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25792 .vindex "&$auth1$&, &$auth2$&, etc"
25793 These may be set when evaluating specific options, as detailed above.
25794 They will also be set when evaluating &%server_condition%&.
25795
25796 Unless otherwise stated below, the &(gsasl)& integration will use the following
25797 meanings for these variables:
25798
25799 .ilist
25800 .vindex "&$auth1$&"
25801 &$auth1$&: the &'authentication id'&
25802 .next
25803 .vindex "&$auth2$&"
25804 &$auth2$&: the &'authorization id'&
25805 .next
25806 .vindex "&$auth3$&"
25807 &$auth3$&: the &'realm'&
25808 .endlist
25809
25810 On a per-mechanism basis:
25811
25812 .ilist
25813 .cindex "authentication" "EXTERNAL"
25814 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25815 the &%server_condition%& option must be present.
25816 .next
25817 .cindex "authentication" "ANONYMOUS"
25818 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25819 the &%server_condition%& option must be present.
25820 .next
25821 .cindex "authentication" "GSSAPI"
25822 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25823 &$auth2$& will be set to the &'authorization id'&,
25824 the &%server_condition%& option must be present.
25825 .endlist
25826
25827 An &'anonymous token'& is something passed along as an unauthenticated
25828 identifier; this is analogous to FTP anonymous authentication passing an
25829 email address, or software-identifier@, as the "password".
25830
25831
25832 An example showing the password having the realm specified in the callback
25833 and demonstrating a Cyrus SASL to GSASL migration approach is:
25834 .code
25835 gsasl_cyrusless_crammd5:
25836   driver = gsasl
25837   public_name = CRAM-MD5
25838   server_realm = imap.example.org
25839   server_password = ${lookup{$auth1:$auth3:userPassword}\
25840                     dbmjz{/etc/sasldb2}{$value}fail}
25841   server_set_id = ${quote:$auth1}
25842   server_condition = yes
25843 .endd
25844
25845
25846 . ////////////////////////////////////////////////////////////////////////////
25847 . ////////////////////////////////////////////////////////////////////////////
25848
25849 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25850 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25851 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25852 .cindex "authentication" "GSSAPI"
25853 .cindex "authentication" "Kerberos"
25854 The &(heimdal_gssapi)& authenticator provides server integration for the
25855 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25856 reliably.
25857
25858 .option server_hostname heimdal_gssapi string&!! "see below"
25859 This option selects the hostname that is used, with &%server_service%&,
25860 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25861 identifier.  The default value is &`$primary_hostname`&.
25862
25863 .option server_keytab heimdal_gssapi string&!! unset
25864 If set, then Heimdal will not use the system default keytab (typically
25865 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25866 The value should be a pathname, with no &"file:"& prefix.
25867
25868 .option server_service heimdal_gssapi string&!! "smtp"
25869 This option specifies the service identifier used, in conjunction with
25870 &%server_hostname%&, for building the identifer for finding credentials
25871 from the keytab.
25872
25873
25874 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25875 Beware that these variables will typically include a realm, thus will appear
25876 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25877 not verified, so a malicious client can set it to anything.
25878
25879 The &$auth1$& field should be safely trustable as a value from the Key
25880 Distribution Center.  Note that these are not quite email addresses.
25881 Each identifier is for a role, and so the left-hand-side may include a
25882 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25883
25884 .vindex "&$auth1$&, &$auth2$&, etc"
25885 .ilist
25886 .vindex "&$auth1$&"
25887 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25888 .next
25889 .vindex "&$auth2$&"
25890 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25891 authentication.  If that was empty, this will also be set to the
25892 GSS Display Name.
25893 .endlist
25894
25895
25896 . ////////////////////////////////////////////////////////////////////////////
25897 . ////////////////////////////////////////////////////////////////////////////
25898
25899 .chapter "The spa authenticator" "CHAPspa"
25900 .scindex IIDspaauth1 "&(spa)& authenticator"
25901 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25902 .cindex "authentication" "Microsoft Secure Password"
25903 .cindex "authentication" "NTLM"
25904 .cindex "Microsoft Secure Password Authentication"
25905 .cindex "NTLM authentication"
25906 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25907 Password Authentication'& mechanism,
25908 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25909 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25910 taken from the Samba project (&url(http://www.samba.org)). The code for the
25911 server side was subsequently contributed by Tom Kistner. The mechanism works as
25912 follows:
25913
25914 .ilist
25915 After the AUTH command has been accepted, the client sends an SPA
25916 authentication request based on the user name and optional domain.
25917 .next
25918 The server sends back a challenge.
25919 .next
25920 The client builds a challenge response which makes use of the user's password
25921 and sends it to the server, which then accepts or rejects it.
25922 .endlist
25923
25924 Encryption is used to protect the password in transit.
25925
25926
25927
25928 .section "Using spa as a server" "SECID179"
25929 .cindex "options" "&(spa)& authenticator (server)"
25930 The &(spa)& authenticator has just one server option:
25931
25932 .option server_password spa string&!! unset
25933 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25934 This option is expanded, and the result must be the cleartext password for the
25935 authenticating user, whose name is at this point in &$auth1$&. For
25936 compatibility with previous releases of Exim, the user name is also placed in
25937 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25938 it can lead to confusion in string expansions that also use numeric variables
25939 for other things. For example:
25940 .code
25941 spa:
25942   driver = spa
25943   public_name = NTLM
25944   server_password = \
25945     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25946 .endd
25947 If the expansion is forced to fail, authentication fails. Any other expansion
25948 failure causes a temporary error code to be returned.
25949
25950
25951
25952
25953
25954 .section "Using spa as a client" "SECID180"
25955 .cindex "options" "&(spa)& authenticator (client)"
25956 The &(spa)& authenticator has the following client options:
25957
25958
25959
25960 .option client_domain spa string&!! unset
25961 This option specifies an optional domain for the authentication.
25962
25963
25964 .option client_password spa string&!! unset
25965 This option specifies the user's password, and must be set.
25966
25967
25968 .option client_username spa string&!! unset
25969 This option specifies the user name, and must be set. Here is an example of a
25970 configuration of this authenticator for use with the mail servers at
25971 &'msn.com'&:
25972 .code
25973 msn:
25974   driver = spa
25975   public_name = MSN
25976   client_username = msn/msn_username
25977   client_password = msn_plaintext_password
25978   client_domain = DOMAIN_OR_UNSET
25979 .endd
25980 .ecindex IIDspaauth1
25981 .ecindex IIDspaauth2
25982
25983
25984
25985
25986
25987 . ////////////////////////////////////////////////////////////////////////////
25988 . ////////////////////////////////////////////////////////////////////////////
25989
25990 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25991          "Encrypted SMTP connections"
25992 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25993 .scindex IIDencsmtp2 "SMTP" "encryption"
25994 .cindex "TLS" "on SMTP connection"
25995 .cindex "OpenSSL"
25996 .cindex "GnuTLS"
25997 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25998 Sockets Layer), is implemented by making use of the OpenSSL library or the
25999 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26000 cryptographic code in the Exim distribution itself for implementing TLS. In
26001 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26002 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26003 You also need to understand the basic concepts of encryption at a managerial
26004 level, and in particular, the way that public keys, private keys, and
26005 certificates are used.
26006
26007 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26008 connection is established, the client issues a STARTTLS command. If the
26009 server accepts this, the client and the server negotiate an encryption
26010 mechanism. If the negotiation succeeds, the data that subsequently passes
26011 between them is encrypted.
26012
26013 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26014 and if so, what cipher suite is in use, whether the client supplied a
26015 certificate, and whether or not that certificate was verified. This makes it
26016 possible for an Exim server to deny or accept certain commands based on the
26017 encryption state.
26018
26019 &*Warning*&: Certain types of firewall and certain anti-virus products can
26020 disrupt TLS connections. You need to turn off SMTP scanning for these products
26021 in order to get TLS to work.
26022
26023
26024
26025 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26026          "SECID284"
26027 .cindex "ssmtp protocol"
26028 .cindex "smtps protocol"
26029 .cindex "SMTP" "ssmtp protocol"
26030 .cindex "SMTP" "smtps protocol"
26031 Early implementations of encrypted SMTP used a different TCP port from normal
26032 SMTP, and expected an encryption negotiation to start immediately, instead of
26033 waiting for a STARTTLS command from the client using the standard SMTP
26034 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26035 allocated for this purpose.
26036
26037 This approach was abandoned when encrypted SMTP was standardized, but there are
26038 still some legacy clients that use it. Exim supports these clients by means of
26039 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26040 numbers; the most common use is expected to be:
26041 .code
26042 tls_on_connect_ports = 465
26043 .endd
26044 The port numbers specified by this option apply to all SMTP connections, both
26045 via the daemon and via &'inetd'&. You still need to specify all the ports that
26046 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26047 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26048 an extra port &-- rather, it specifies different behaviour on a port that is
26049 defined elsewhere.
26050
26051 There is also a &%-tls-on-connect%& command line option. This overrides
26052 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26053
26054
26055
26056
26057
26058
26059 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26060 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26061 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26062 followed later, when the first versions of GnuTLS were released. To build Exim
26063 to use GnuTLS, you need to set
26064 .code
26065 USE_GNUTLS=yes
26066 .endd
26067 in Local/Makefile, in addition to
26068 .code
26069 SUPPORT_TLS=yes
26070 .endd
26071 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26072 include files and libraries for GnuTLS can be found.
26073
26074 There are some differences in usage when using GnuTLS instead of OpenSSL:
26075
26076 .ilist
26077 The &%tls_verify_certificates%& option
26078 cannot be the path of a directory
26079 for GnuTLS versions before 3.3.6
26080 (for later versions, or OpenSSL, it can be either).
26081 .next
26082 The default value for &%tls_dhparam%& differs for historical reasons.
26083 .next
26084 .vindex "&$tls_in_peerdn$&"
26085 .vindex "&$tls_out_peerdn$&"
26086 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26087 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26088 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26089 .next
26090 OpenSSL identifies cipher suites using hyphens as separators, for example:
26091 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26092 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26093 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26094 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26095 to handle its own older variants) when processing lists of cipher suites in the
26096 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26097 option).
26098 .next
26099 The &%tls_require_ciphers%& options operate differently, as described in the
26100 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26101 .next
26102 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26103 When using OpenSSL, this option is ignored.
26104 (If an API is found to let OpenSSL be configured in this way,
26105 let the Exim Maintainers know and we'll likely use it).
26106 .next
26107 Some other recently added features may only be available in one or the other.
26108 This should be documented with the feature.  If the documentation does not
26109 explicitly state that the feature is infeasible in the other TLS
26110 implementation, then patches are welcome.
26111 .endlist
26112
26113
26114 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26115 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26116 an explicit path; if the latter, then the text about generation still applies,
26117 but not the chosen filename.
26118 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26119 See the documentation of &%tls_dhparam%& for more information.
26120
26121 GnuTLS uses D-H parameters that may take a substantial amount of time
26122 to compute. It is unreasonable to re-compute them for every TLS session.
26123 Therefore, Exim keeps this data in a file in its spool directory, called
26124 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26125 of bits requested.
26126 The file is owned by the Exim user and is readable only by
26127 its owner. Every Exim process that start up GnuTLS reads the D-H
26128 parameters from this file. If the file does not exist, the first Exim process
26129 that needs it computes the data and writes it to a temporary file which is
26130 renamed once it is complete. It does not matter if several Exim processes do
26131 this simultaneously (apart from wasting a few resources). Once a file is in
26132 place, new Exim processes immediately start using it.
26133
26134 For maximum security, the parameters that are stored in this file should be
26135 recalculated periodically, the frequency depending on your paranoia level.
26136 If you are avoiding using the fixed D-H primes published in RFCs, then you
26137 are concerned about some advanced attacks and will wish to do this; if you do
26138 not regenerate then you might as well stick to the standard primes.
26139
26140 Arranging this is easy in principle; just delete the file when you want new
26141 values to be computed. However, there may be a problem. The calculation of new
26142 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26143 If the system is not very active, &_/dev/random_& may delay returning data
26144 until enough randomness (entropy) is available. This may cause Exim to hang for
26145 a substantial amount of time, causing timeouts on incoming connections.
26146
26147 The solution is to generate the parameters externally to Exim. They are stored
26148 in &_gnutls-params-N_& in PEM format, which means that they can be
26149 generated externally using the &(certtool)& command that is part of GnuTLS.
26150
26151 To replace the parameters with new ones, instead of deleting the file
26152 and letting Exim re-create it, you can generate new parameters using
26153 &(certtool)& and, when this has been done, replace Exim's cache file by
26154 renaming. The relevant commands are something like this:
26155 .code
26156 # ls
26157 [ look for file; assume gnutls-params-2236 is the most recent ]
26158 # rm -f new-params
26159 # touch new-params
26160 # chown exim:exim new-params
26161 # chmod 0600 new-params
26162 # certtool --generate-dh-params --bits 2236 >>new-params
26163 # openssl dhparam -noout -text -in new-params | head
26164 [ check the first line, make sure it's not more than 2236;
26165   if it is, then go back to the start ("rm") and repeat
26166   until the size generated is at most the size requested ]
26167 # chmod 0400 new-params
26168 # mv new-params gnutls-params-2236
26169 .endd
26170 If Exim never has to generate the parameters itself, the possibility of
26171 stalling is removed.
26172
26173 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26174 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26175 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26176 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26177 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26178 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26179 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26180 which applies to all D-H usage, client or server.  If the value returned by
26181 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26182 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26183 limit, which is still much higher than Exim historically used.
26184
26185 The filename and bits used will change as the GnuTLS maintainers change the
26186 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26187 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26188 2432 bits, while NSS is limited to 2236 bits.
26189
26190 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26191 increase the chance of the generated prime actually being within acceptable
26192 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26193 procedure above.  There is no sane procedure available to Exim to double-check
26194 the size of the generated prime, so it might still be too large.
26195
26196
26197 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26198 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26199 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26200 There is a function in the OpenSSL library that can be passed a list of cipher
26201 suites before the cipher negotiation takes place. This specifies which ciphers
26202 are acceptable. The list is colon separated and may contain names like
26203 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26204 directly to this function call.
26205 Many systems will install the OpenSSL manual-pages, so you may have
26206 &'ciphers(1)'& available to you.
26207 The following quotation from the OpenSSL
26208 documentation specifies what forms of item are allowed in the cipher string:
26209
26210 .ilist
26211 It can consist of a single cipher suite such as RC4-SHA.
26212 .next
26213 It can represent a list of cipher suites containing a certain algorithm,
26214 or cipher suites of a certain type. For example SHA1 represents all
26215 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26216 SSL v3 algorithms.
26217 .next
26218 Lists of cipher suites can be combined in a single cipher string using
26219 the + character. This is used as a logical and operation. For example
26220 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26221 algorithms.
26222 .endlist
26223
26224 Each cipher string can be optionally preceded by one of the characters &`!`&,
26225 &`-`& or &`+`&.
26226 .ilist
26227 If &`!`& is used, the ciphers are permanently deleted from the list. The
26228 ciphers deleted can never reappear in the list even if they are explicitly
26229 stated.
26230 .next
26231 If &`-`& is used, the ciphers are deleted from the list, but some or all
26232 of the ciphers can be added again by later options.
26233 .next
26234 If &`+`& is used, the ciphers are moved to the end of the list. This
26235 option does not add any new ciphers; it just moves matching existing ones.
26236 .endlist
26237
26238 If none of these characters is present, the string is interpreted as
26239 a list of ciphers to be appended to the current preference list. If the list
26240 includes any ciphers already present they will be ignored: that is, they will
26241 not be moved to the end of the list.
26242 .endlist
26243
26244 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26245 string:
26246 .code
26247 # note single-quotes to get ! past any shell history expansion
26248 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26249 .endd
26250
26251 This example will let the library defaults be permitted on the MX port, where
26252 there's probably no identity verification anyway, but ups the ante on the
26253 submission ports where the administrator might have some influence on the
26254 choice of clients used:
26255 .code
26256 # OpenSSL variant; see man ciphers(1)
26257 tls_require_ciphers = ${if =={$received_port}{25}\
26258                            {DEFAULT}\
26259                            {HIGH:!MD5:!SHA1}}
26260 .endd
26261
26262
26263
26264 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26265          "SECTreqciphgnu"
26266 .cindex "GnuTLS" "specifying parameters for"
26267 .cindex "TLS" "specifying ciphers (GnuTLS)"
26268 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26269 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26270 .cindex "TLS" "specifying protocols (GnuTLS)"
26271 .cindex "TLS" "specifying priority string (GnuTLS)"
26272 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26273 The GnuTLS library allows the caller to provide a "priority string", documented
26274 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26275 ciphersuite specification in OpenSSL.
26276
26277 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26278 and controls both protocols and ciphers.
26279
26280 The &%tls_require_ciphers%& option is available both as an global option,
26281 controlling how Exim behaves as a server, and also as an option of the
26282 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26283 the value is string expanded.  The resulting string is not an Exim list and
26284 the string is given to the GnuTLS library, so that Exim does not need to be
26285 aware of future feature enhancements of GnuTLS.
26286
26287 Documentation of the strings accepted may be found in the GnuTLS manual, under
26288 "Priority strings".  This is online as
26289 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26290 but beware that this relates to GnuTLS 3, which may be newer than the version
26291 installed on your system.  If you are using GnuTLS 3,
26292 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26293 on that site can be used to test a given string.
26294
26295 For example:
26296 .code
26297 # Disable older versions of protocols
26298 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26299 .endd
26300
26301 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26302 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26303 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26304
26305 This example will let the library defaults be permitted on the MX port, where
26306 there's probably no identity verification anyway, and lowers security further
26307 by increasing compatibility; but this ups the ante on the submission ports
26308 where the administrator might have some influence on the choice of clients
26309 used:
26310 .code
26311 # GnuTLS variant
26312 tls_require_ciphers = ${if =={$received_port}{25}\
26313                            {NORMAL:%COMPAT}\
26314                            {SECURE128}}
26315 .endd
26316
26317
26318 .section "Configuring an Exim server to use TLS" "SECID182"
26319 .cindex "TLS" "configuring an Exim server"
26320 When Exim has been built with TLS support, it advertises the availability of
26321 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26322 but not to any others. The default value of this option is unset, which means
26323 that STARTTLS is not advertised at all. This default is chosen because you
26324 need to set some other options in order to make TLS available, and also it is
26325 sensible for systems that want to use TLS only as a client.
26326
26327 If a client issues a STARTTLS command and there is some configuration
26328 problem in the server, the command is rejected with a 454 error. If the client
26329 persists in trying to issue SMTP commands, all except QUIT are rejected
26330 with the error
26331 .code
26332 554 Security failure
26333 .endd
26334 If a STARTTLS command is issued within an existing TLS session, it is
26335 rejected with a 554 error code.
26336
26337 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26338 match some hosts. You can, of course, set it to * to match all hosts.
26339 However, this is not all you need to do. TLS sessions to a server won't work
26340 without some further configuration at the server end.
26341
26342 It is rumoured that all existing clients that support TLS/SSL use RSA
26343 encryption. To make this work you need to set, in the server,
26344 .code
26345 tls_certificate = /some/file/name
26346 tls_privatekey = /some/file/name
26347 .endd
26348 These options are, in fact, expanded strings, so you can make them depend on
26349 the identity of the client that is connected if you wish. The first file
26350 contains the server's X509 certificate, and the second contains the private key
26351 that goes with it. These files need to be
26352 PEM format and readable by the Exim user, and must
26353 always be given as full path names.
26354 The key must not be password-protected.
26355 They can be the same file if both the
26356 certificate and the key are contained within it. If &%tls_privatekey%& is not
26357 set, or if its expansion is forced to fail or results in an empty string, this
26358 is assumed to be the case. The certificate file may also contain intermediate
26359 certificates that need to be sent to the client to enable it to authenticate
26360 the server's certificate.
26361
26362 If you do not understand about certificates and keys, please try to find a
26363 source of this background information, which is not Exim-specific. (There are a
26364 few comments below in section &<<SECTcerandall>>&.)
26365
26366 &*Note*&: These options do not apply when Exim is operating as a client &--
26367 they apply only in the case of a server. If you need to use a certificate in an
26368 Exim client, you must set the options of the same names in an &(smtp)&
26369 transport.
26370
26371 With just these options, an Exim server will be able to use TLS. It does not
26372 require the client to have a certificate (but see below for how to insist on
26373 this). There is one other option that may be needed in other situations. If
26374 .code
26375 tls_dhparam = /some/file/name
26376 .endd
26377 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26378 with the parameters contained in the file.
26379 Set this to &`none`& to disable use of DH entirely, by making no prime
26380 available:
26381 .code
26382 tls_dhparam = none
26383 .endd
26384 This may also be set to a string identifying a standard prime to be used for
26385 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26386 used is &`ike23`&.  There are a few standard primes available, see the
26387 documentation for &%tls_dhparam%& for the complete list.
26388
26389 See the command
26390 .code
26391 openssl dhparam
26392 .endd
26393 for a way of generating file data.
26394
26395 The strings supplied for these three options are expanded every time a client
26396 host connects. It is therefore possible to use different certificates and keys
26397 for different hosts, if you so wish, by making use of the client's IP address
26398 in &$sender_host_address$& to control the expansion. If a string expansion is
26399 forced to fail, Exim behaves as if the option is not set.
26400
26401 .cindex "cipher" "logging"
26402 .cindex "log" "TLS cipher"
26403 .vindex "&$tls_in_cipher$&"
26404 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26405 an incoming TLS connection. It is included in the &'Received:'& header of an
26406 incoming message (by default &-- you can, of course, change this), and it is
26407 also included in the log line that records a message's arrival, keyed by
26408 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26409 condition can be used to test for specific cipher suites in ACLs.
26410
26411 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26412 can check the name of the cipher suite and vary their actions accordingly. The
26413 cipher suite names vary, depending on which TLS library is being used. For
26414 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26415 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26416 documentation for more details.
26417
26418 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26419 (again depending on the &%tls_cipher%& log selector).
26420
26421
26422 .section "Requesting and verifying client certificates" "SECID183"
26423 .cindex "certificate" "verification of client"
26424 .cindex "TLS" "client certificate verification"
26425 If you want an Exim server to request a certificate when negotiating a TLS
26426 session with a client, you must set either &%tls_verify_hosts%& or
26427 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26428 apply to all TLS connections. For any host that matches one of these options,
26429 Exim requests a certificate as part of the setup of the TLS session. The
26430 contents of the certificate are verified by comparing it with a list of
26431 expected certificates.
26432 .new
26433 These may be the system default set (depending on library version),
26434 .wen
26435 an explicit file or,
26436 depending on library version, a directory, identified by
26437 &%tls_verify_certificates%&.
26438
26439 A file can contain multiple certificates, concatenated end to end. If a
26440 directory is used
26441 (OpenSSL only),
26442 each certificate must be in a separate file, with a name (or a symbolic link)
26443 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26444 certificate. You can compute the relevant hash by running the command
26445 .code
26446 openssl x509 -hash -noout -in /cert/file
26447 .endd
26448 where &_/cert/file_& contains a single certificate.
26449
26450 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26451 what happens if the client does not supply a certificate, or if the certificate
26452 does not match any of the certificates in the collection named by
26453 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26454 attempt to set up a TLS session is aborted, and the incoming connection is
26455 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26456 session continues. ACLs that run for subsequent SMTP commands can detect the
26457 fact that no certificate was verified, and vary their actions accordingly. For
26458 example, you can insist on a certificate before accepting a message for
26459 relaying, but not when the message is destined for local delivery.
26460
26461 .vindex "&$tls_in_peerdn$&"
26462 When a client supplies a certificate (whether it verifies or not), the value of
26463 the Distinguished Name of the certificate is made available in the variable
26464 &$tls_in_peerdn$& during subsequent processing of the message.
26465
26466 .cindex "log" "distinguished name"
26467 Because it is often a long text string, it is not included in the log line or
26468 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26469 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26470 &%received_header_text%& to change the &'Received:'& header. When no
26471 certificate is supplied, &$tls_in_peerdn$& is empty.
26472
26473
26474 .section "Revoked certificates" "SECID184"
26475 .cindex "TLS" "revoked certificates"
26476 .cindex "revocation list"
26477 .cindex "certificate" "revocation list"
26478 .cindex "OCSP" "stapling"
26479 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26480 certificates are revoked. If you have such a list, you can pass it to an Exim
26481 server using the global option called &%tls_crl%& and to an Exim client using
26482 an identically named option for the &(smtp)& transport. In each case, the value
26483 of the option is expanded and must then be the name of a file that contains a
26484 CRL in PEM format.
26485 The downside is that clients have to periodically re-download a potentially huge
26486 file from every certificate authority they know of.
26487
26488 The way with most moving parts at query time is Online Certificate
26489 Status Protocol (OCSP), where the client verifies the certificate
26490 against an OCSP server run by the CA.  This lets the CA track all
26491 usage of the certs.  It requires running software with access to the
26492 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26493 is based on HTTP and can be proxied accordingly.
26494
26495 The only widespread OCSP server implementation (known to this writer)
26496 comes as part of OpenSSL and aborts on an invalid request, such as
26497 connecting to the port and then disconnecting.  This requires
26498 re-entering the passphrase each time some random client does this.
26499
26500 The third way is OCSP Stapling; in this, the server using a certificate
26501 issued by the CA periodically requests an OCSP proof of validity from
26502 the OCSP server, then serves it up inline as part of the TLS
26503 negotiation.   This approach adds no extra round trips, does not let the
26504 CA track users, scales well with number of certs issued by the CA and is
26505 resilient to temporary OCSP server failures, as long as the server
26506 starts retrying to fetch an OCSP proof some time before its current
26507 proof expires.  The downside is that it requires server support.
26508
26509 Unless Exim is built with the support disabled,
26510 or with GnuTLS earlier than version 3.1.3,
26511 support for OCSP stapling is included.
26512
26513 There is a global option called &%tls_ocsp_file%&.
26514 The file specified therein is expected to be in DER format, and contain
26515 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26516 option will be re-expanded for SNI, if the &%tls_certificate%& option
26517 contains &`tls_in_sni`&, as per other TLS options.
26518
26519 Exim does not at this time implement any support for fetching a new OCSP
26520 proof.  The burden is on the administrator to handle this, outside of
26521 Exim.  The file specified should be replaced atomically, so that the
26522 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26523 on each connection, so a new file will be handled transparently on the
26524 next connection.
26525
26526 When built with OpenSSL Exim will check for a valid next update timestamp
26527 in the OCSP proof; if not present, or if the proof has expired, it will be
26528 ignored.
26529
26530 For the client to be able to verify the stapled OCSP the server must
26531 also supply, in its stapled information, any intermediate
26532 certificates for the chain leading to the OCSP proof from the signer
26533 of the server certificate.  There may be zero or one such. These
26534 intermediate certificates should be added to the server OCSP stapling
26535 file named by &%tls_ocsp_file%&.
26536
26537 Note that the proof only covers the terminal server certificate,
26538 not any of the chain from CA to it.
26539
26540 There is no current way to staple a proof for a client certificate.
26541
26542 .code
26543   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26544   OCSP server is supplied.  The server URL may be included in the
26545   server certificate, if the CA is helpful.
26546
26547   One failure mode seen was the OCSP Signer cert expiring before the end
26548   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26549   noted this as invalid overall, but the re-fetch script did not.
26550 .endd
26551
26552
26553
26554
26555 .section "Configuring an Exim client to use TLS" "SECID185"
26556 .cindex "cipher" "logging"
26557 .cindex "log" "TLS cipher"
26558 .cindex "log" "distinguished name"
26559 .cindex "TLS" "configuring an Exim client"
26560 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26561 deliveries as well as to incoming, the latter one causing logging of the
26562 server certificate's DN. The remaining client configuration for TLS is all
26563 within the &(smtp)& transport.
26564
26565 It is not necessary to set any options to have TLS work in the &(smtp)&
26566 transport. If Exim is built with TLS support, and TLS is advertised by a
26567 server, the &(smtp)& transport always tries to start a TLS session. However,
26568 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26569 transport) to a list of server hosts for which TLS should not be used.
26570
26571 If you do not want Exim to attempt to send messages unencrypted when an attempt
26572 to set up an encrypted connection fails in any way, you can set
26573 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26574 those hosts, delivery is always deferred if an encrypted connection cannot be
26575 set up. If there are any other hosts for the address, they are tried in the
26576 usual way.
26577
26578 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26579 the message unencrypted. It always does this if the response to STARTTLS is
26580 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26581 session after a success response code, what happens is controlled by the
26582 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26583 delivery to this host is deferred, and other hosts (if available) are tried. If
26584 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26585 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26586 negotiation fails, Exim closes the current connection (because it is in an
26587 unknown state), opens a new one to the same host, and then tries the delivery
26588 unencrypted.
26589
26590 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26591 transport provide the client with a certificate, which is passed to the server
26592 if it requests it. If the server is Exim, it will request a certificate only if
26593 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26594
26595 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26596 specifies a collection of expected server certificates.
26597 .new
26598 These may be the system default set (depending on library version),
26599 .wen
26600 a file or,
26601 depnding on liibrary version, a directory,
26602 must name a file or,
26603 for OpenSSL only (not GnuTLS), a directory.
26604 The client verifies the server's certificate
26605 against this collection, taking into account any revoked certificates that are
26606 in the list defined by &%tls_crl%&.
26607 Failure to verify fails the TLS connection unless either of the
26608 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26609
26610 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26611 certificate verification to the listed servers.  Verification either must
26612 or need not succeed respectively.
26613
26614 The &(smtp)& transport has two OCSP-related options:
26615 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26616 is requested and required for the connection to proceed.  The default
26617 value is empty.
26618 &%hosts_request_ocsp%&; a host-list for which (additionally)
26619 a Certificate Status is requested (but not necessarily verified).  The default
26620 value is "*" meaning that requests are made unless configured
26621 otherwise.
26622
26623 The host(s) should also be in &%hosts_require_tls%&, and
26624 &%tls_verify_certificates%& configured for the transport,
26625 for OCSP to be relevant.
26626
26627 If
26628 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26629 list of permitted cipher suites. If either of these checks fails, delivery to
26630 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26631 alternative hosts, if any.
26632
26633  &*Note*&:
26634 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26635 is operating as a client. Exim does not assume that a server certificate (set
26636 by the global options of the same name) should also be used when operating as a
26637 client.
26638
26639 .vindex "&$host$&"
26640 .vindex "&$host_address$&"
26641 All the TLS options in the &(smtp)& transport are expanded before use, with
26642 &$host$& and &$host_address$& containing the name and address of the server to
26643 which the client is connected. Forced failure of an expansion causes Exim to
26644 behave as if the relevant option were unset.
26645
26646 .vindex &$tls_out_bits$&
26647 .vindex &$tls_out_cipher$&
26648 .vindex &$tls_out_peerdn$&
26649 .vindex &$tls_out_sni$&
26650 Before an SMTP connection is established, the
26651 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26652 variables are emptied. (Until the first connection, they contain the values
26653 that were set when the message was received.) If STARTTLS is subsequently
26654 successfully obeyed, these variables are set to the relevant values for the
26655 outgoing connection.
26656
26657
26658
26659 .section "Use of TLS Server Name Indication" "SECTtlssni"
26660 .cindex "TLS" "Server Name Indication"
26661 .vindex "&$tls_in_sni$&"
26662 .oindex "&%tls_in_sni%&"
26663 With TLS1.0 or above, there is an extension mechanism by which extra
26664 information can be included at various points in the protocol.  One of these
26665 extensions, documented in RFC 6066 (and before that RFC 4366) is
26666 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26667 client in the initial handshake, so that the server can examine the servername
26668 within and possibly choose to use different certificates and keys (and more)
26669 for this session.
26670
26671 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26672 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26673 address.
26674
26675 With SMTP to MX, there are the same problems here as in choosing the identity
26676 against which to validate a certificate: you can't rely on insecure DNS to
26677 provide the identity which you then cryptographically verify.  So this will
26678 be of limited use in that environment.
26679
26680 With SMTP to Submission, there is a well-defined hostname which clients are
26681 connecting to and can validate certificates against.  Thus clients &*can*&
26682 choose to include this information in the TLS negotiation.  If this becomes
26683 wide-spread, then hosters can choose to present different certificates to
26684 different clients.  Or even negotiate different cipher suites.
26685
26686 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26687 if not empty, will be sent on a TLS session as part of the handshake.  There's
26688 nothing more to it.  Choosing a sensible value not derived insecurely is the
26689 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26690 for the lifetime of the client connection (including during authentication).
26691
26692 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26693 received from a client.
26694 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26695
26696 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26697 option (prior to expansion) then the following options will be re-expanded
26698 during TLS session handshake, to permit alternative values to be chosen:
26699
26700 .ilist
26701 .vindex "&%tls_certificate%&"
26702 &%tls_certificate%&
26703 .next
26704 .vindex "&%tls_crl%&"
26705 &%tls_crl%&
26706 .next
26707 .vindex "&%tls_privatekey%&"
26708 &%tls_privatekey%&
26709 .next
26710 .vindex "&%tls_verify_certificates%&"
26711 &%tls_verify_certificates%&
26712 .next
26713 .vindex "&%tls_ocsp_file%&"
26714 &%tls_ocsp_file%&
26715 .endlist
26716
26717 Great care should be taken to deal with matters of case, various injection
26718 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26719 can always be referenced; it is important to remember that &$tls_sni$& is
26720 arbitrary unverified data provided prior to authentication.
26721
26722 The Exim developers are proceeding cautiously and so far no other TLS options
26723 are re-expanded.
26724
26725 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26726 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26727 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26728 see &`-servername`& in the output, then OpenSSL has support.
26729
26730 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26731 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26732 built, then you have SNI support).
26733
26734
26735
26736 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26737          "SECTmulmessam"
26738 .cindex "multiple SMTP deliveries with TLS"
26739 .cindex "TLS" "multiple message deliveries"
26740 Exim sends multiple messages down the same TCP/IP connection by starting up
26741 an entirely new delivery process for each message, passing the socket from
26742 one process to the next. This implementation does not fit well with the use
26743 of TLS, because there is quite a lot of state information associated with a TLS
26744 connection, not just a socket identification. Passing all the state information
26745 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26746 session before passing the socket to a new process. The new process may then
26747 try to start a new TLS session, and if successful, may try to re-authenticate
26748 if AUTH is in use, before sending the next message.
26749
26750 The RFC is not clear as to whether or not an SMTP session continues in clear
26751 after TLS has been shut down, or whether TLS may be restarted again later, as
26752 just described. However, if the server is Exim, this shutdown and
26753 reinitialization works. It is not known which (if any) other servers operate
26754 successfully if the client closes a TLS session and continues with unencrypted
26755 SMTP, but there are certainly some that do not work. For such servers, Exim
26756 should not pass the socket to another process, because the failure of the
26757 subsequent attempt to use it would cause Exim to record a temporary host error,
26758 and delay other deliveries to that host.
26759
26760 To test for this case, Exim sends an EHLO command to the server after
26761 closing down the TLS session. If this fails in any way, the connection is
26762 closed instead of being passed to a new delivery process, but no retry
26763 information is recorded.
26764
26765 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26766 &(smtp)& transport to match those hosts for which Exim should not pass
26767 connections to new processes if TLS has been used.
26768
26769
26770
26771
26772 .section "Certificates and all that" "SECTcerandall"
26773 .cindex "certificate" "references to discussion"
26774 In order to understand fully how TLS works, you need to know about
26775 certificates, certificate signing, and certificate authorities. This is not the
26776 place to give a tutorial, especially as I do not know very much about it
26777 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26778 to Apache, currently at
26779 .display
26780 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26781 .endd
26782 Other parts of the &'modssl'& documentation are also helpful, and have
26783 links to further files.
26784 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26785 0-201-61598-3), contains both introductory and more in-depth descriptions.
26786 Some sample programs taken from the book are available from
26787 .display
26788 &url(http://www.rtfm.com/openssl-examples/)
26789 .endd
26790
26791
26792 .section "Certificate chains" "SECID186"
26793 The file named by &%tls_certificate%& may contain more than one
26794 certificate. This is useful in the case where the certificate that is being
26795 sent is validated by an intermediate certificate which the other end does
26796 not have. Multiple certificates must be in the correct order in the file.
26797 First the host's certificate itself, then the first intermediate
26798 certificate to validate the issuer of the host certificate, then the next
26799 intermediate certificate to validate the issuer of the first intermediate
26800 certificate, and so on, until finally (optionally) the root certificate.
26801 The root certificate must already be trusted by the recipient for
26802 validation to succeed, of course, but if it's not preinstalled, sending the
26803 root certificate along with the rest makes it available for the user to
26804 install if the receiving end is a client MUA that can interact with a user.
26805
26806 Note that certificates using MD5 are unlikely to work on today's Internet;
26807 even if your libraries allow loading them for use in Exim when acting as a
26808 server, increasingly clients will not accept such certificates.  The error
26809 diagnostics in such a case can be frustratingly vague.
26810
26811
26812
26813 .section "Self-signed certificates" "SECID187"
26814 .cindex "certificate" "self-signed"
26815 You can create a self-signed certificate using the &'req'& command provided
26816 with OpenSSL, like this:
26817 . ==== Do not shorten the duration here without reading and considering
26818 . ==== the text below.  Please leave it at 9999 days.
26819 .code
26820 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26821             -days 9999 -nodes
26822 .endd
26823 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26824 delimited and so can be identified independently. The &%-days%& option
26825 specifies a period for which the certificate is valid. The &%-nodes%& option is
26826 important: if you do not set it, the key is encrypted with a passphrase
26827 that you are prompted for, and any use that is made of the key causes more
26828 prompting for the passphrase. This is not helpful if you are going to use
26829 this certificate and key in an MTA, where prompting is not possible.
26830
26831 . ==== I expect to still be working 26 years from now.  The less technical
26832 . ==== debt I create, in terms of storing up trouble for my later years, the
26833 . ==== happier I will be then.  We really have reached the point where we
26834 . ==== should start, at the very least, provoking thought and making folks
26835 . ==== pause before proceeding, instead of leaving all the fixes until two
26836 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26837 . ==== -pdp, 2012
26838 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26839 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26840 the above command might produce a date in the past.  Think carefully about
26841 the lifetime of the systems you're deploying, and either reduce the duration
26842 of the certificate or reconsider your platform deployment.  (At time of
26843 writing, reducing the duration is the most likely choice, but the inexorable
26844 progression of time takes us steadily towards an era where this will not
26845 be a sensible resolution).
26846
26847 A self-signed certificate made in this way is sufficient for testing, and
26848 may be adequate for all your requirements if you are mainly interested in
26849 encrypting transfers, and not in secure identification.
26850
26851 However, many clients require that the certificate presented by the server be a
26852 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26853 certificate. In this situation, the self-signed certificate described above
26854 must be installed on the client host as a trusted root &'certification
26855 authority'& (CA), and the certificate used by Exim must be a user certificate
26856 signed with that self-signed certificate.
26857
26858 For information on creating self-signed CA certificates and using them to sign
26859 user certificates, see the &'General implementation overview'& chapter of the
26860 Open-source PKI book, available online at
26861 &url(http://ospkibook.sourceforge.net/).
26862 .ecindex IIDencsmtp1
26863 .ecindex IIDencsmtp2
26864
26865
26866
26867 . ////////////////////////////////////////////////////////////////////////////
26868 . ////////////////////////////////////////////////////////////////////////////
26869
26870 .chapter "Access control lists" "CHAPACL"
26871 .scindex IIDacl "&ACL;" "description"
26872 .cindex "control of incoming mail"
26873 .cindex "message" "controlling incoming"
26874 .cindex "policy control" "access control lists"
26875 Access Control Lists (ACLs) are defined in a separate section of the run time
26876 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26877 name, terminated by a colon. Here is a complete ACL section that contains just
26878 one very small ACL:
26879 .code
26880 begin acl
26881 small_acl:
26882   accept   hosts = one.host.only
26883 .endd
26884 You can have as many lists as you like in the ACL section, and the order in
26885 which they appear does not matter. The lists are self-terminating.
26886
26887 The majority of ACLs are used to control Exim's behaviour when it receives
26888 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26889 when a local process submits a message using SMTP by specifying the &%-bs%&
26890 option. The most common use is for controlling which recipients are accepted
26891 in incoming messages. In addition, you can define an ACL that is used to check
26892 local non-SMTP messages. The default configuration file contains an example of
26893 a realistic ACL for checking RCPT commands. This is discussed in chapter
26894 &<<CHAPdefconfil>>&.
26895
26896
26897 .section "Testing ACLs" "SECID188"
26898 The &%-bh%& command line option provides a way of testing your ACL
26899 configuration locally by running a fake SMTP session with which you interact.
26900 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26901 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26902
26903
26904
26905 .section "Specifying when ACLs are used" "SECID189"
26906 .cindex "&ACL;" "options for specifying"
26907 In order to cause an ACL to be used, you have to name it in one of the relevant
26908 options in the main part of the configuration. These options are:
26909 .cindex "AUTH" "ACL for"
26910 .cindex "DATA" "ACLs for"
26911 .cindex "ETRN" "ACL for"
26912 .cindex "EXPN" "ACL for"
26913 .cindex "HELO" "ACL for"
26914 .cindex "EHLO" "ACL for"
26915 .cindex "MAIL" "ACL for"
26916 .cindex "QUIT, ACL for"
26917 .cindex "RCPT" "ACL for"
26918 .cindex "STARTTLS, ACL for"
26919 .cindex "VRFY" "ACL for"
26920 .cindex "SMTP" "connection, ACL for"
26921 .cindex "non-SMTP messages" "ACLs for"
26922 .cindex "MIME content scanning" "ACL for"
26923 .cindex "PRDR" "ACL for"
26924
26925 .table2 140pt
26926 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26927 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26928 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26929 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26930 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26931 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26932 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26933 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26934 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26935 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26936 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26937 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26938 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26939 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26940 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26941 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26942 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26943 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26944 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26945 .endtable
26946
26947 For example, if you set
26948 .code
26949 acl_smtp_rcpt = small_acl
26950 .endd
26951 the little ACL defined above is used whenever Exim receives a RCPT command
26952 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26953 done when RCPT commands arrive. A rejection of RCPT should cause the
26954 sending MTA to give up on the recipient address contained in the RCPT
26955 command, whereas rejection at other times may cause the client MTA to keep on
26956 trying to deliver the message. It is therefore recommended that you do as much
26957 testing as possible at RCPT time.
26958
26959
26960 .section "The non-SMTP ACLs" "SECID190"
26961 .cindex "non-SMTP messages" "ACLs for"
26962 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26963 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26964 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26965 the state of the SMTP connection such as encryption and authentication) are not
26966 relevant and are forbidden in these ACLs. However, the sender and recipients
26967 are known, so the &%senders%& and &%sender_domains%& conditions and the
26968 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26969 &$authenticated_sender$& are also available. You can specify added header lines
26970 in any of these ACLs.
26971
26972 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26973 non-SMTP message, before any of the message has been read. (This is the
26974 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26975 batched SMTP input, it runs after the DATA command has been reached. The
26976 result of this ACL is ignored; it cannot be used to reject a message. If you
26977 really need to, you could set a value in an ACL variable here and reject based
26978 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26979 controls, and in particular, it can be used to set
26980 .code
26981 control = suppress_local_fixups
26982 .endd
26983 This cannot be used in the other non-SMTP ACLs because by the time they are
26984 run, it is too late.
26985
26986 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26987 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26988
26989 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26990 kind of rejection is treated as permanent, because there is no way of sending a
26991 temporary error for these kinds of message.
26992
26993
26994 .section "The SMTP connect ACL" "SECID191"
26995 .cindex "SMTP" "connection, ACL for"
26996 .oindex &%smtp_banner%&
26997 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26998 session, after the test specified by &%host_reject_connection%& (which is now
26999 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27000 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27001 the message override the banner message that is otherwise specified by the
27002 &%smtp_banner%& option.
27003
27004
27005 .section "The EHLO/HELO ACL" "SECID192"
27006 .cindex "EHLO" "ACL for"
27007 .cindex "HELO" "ACL for"
27008 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27009 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27010 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27011 Note that a client may issue more than one EHLO or HELO command in an SMTP
27012 session, and indeed is required to issue a new EHLO or HELO after successfully
27013 setting up encryption following a STARTTLS command.
27014
27015 If the command is accepted by an &%accept%& verb that has a &%message%&
27016 modifier, the message may not contain more than one line (it will be truncated
27017 at the first newline and a panic logged if it does). Such a message cannot
27018 affect the EHLO options that are listed on the second and subsequent lines of
27019 an EHLO response.
27020
27021
27022 .section "The DATA ACLs" "SECID193"
27023 .cindex "DATA" "ACLs for"
27024 Two ACLs are associated with the DATA command, because it is two-stage
27025 command, with two responses being sent to the client.
27026 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27027 is obeyed. This gives you control after all the RCPT commands, but before
27028 the message itself is received. It offers the opportunity to give a negative
27029 response to the DATA command before the data is transmitted. Header lines
27030 added by MAIL or RCPT ACLs are not visible at this time, but any that
27031 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27032
27033 You cannot test the contents of the message, for example, to verify addresses
27034 in the headers, at RCPT time or when the DATA command is received. Such
27035 tests have to appear in the ACL that is run after the message itself has been
27036 received, before the final response to the DATA command is sent. This is
27037 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27038 associated with the DATA command.
27039
27040 For both of these ACLs, it is not possible to reject individual recipients. An
27041 error response rejects the entire message. Unfortunately, it is known that some
27042 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27043 before or after the data) correctly &-- they keep the message on their queues
27044 and try again later, but that is their problem, though it does waste some of
27045 your resources.
27046
27047 The &%acl_smtp_data%& ACL is run after
27048 the &%acl_smtp_data_prdr%&,
27049 the &%acl_smtp_dkim%&
27050 and the &%acl_smtp_mime%& ACLs.
27051
27052 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27053 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27054 enabled (which is the default).
27055
27056 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27057 received, and is executed for each DKIM signature found in a message.  If not
27058 otherwise specified, the default action is to accept.
27059
27060 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27061
27062 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27063
27064
27065 .section "The SMTP MIME ACL" "SECID194"
27066 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27067 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27068
27069 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27070
27071
27072 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27073 .cindex "PRDR" "ACL for"
27074 .oindex "&%prdr_enable%&"
27075 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27076 with PRDR support enabled (which is the default).
27077 It becomes active only when the PRDR feature is negotiated between
27078 client and server for a message, and more than one recipient
27079 has been accepted.
27080
27081 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27082 has been recieved, and is executed once for each recipient of the message
27083 with &$local_part$& and &$domain$& valid.
27084 The test may accept, defer or deny for inividual recipients.
27085 The &%acl_smtp_data%& will still be called after this ACL and
27086 can reject the message overall, even if this ACL has accepted it
27087 for some or all recipients.
27088
27089 PRDR may be used to support per-user content filtering.  Without it
27090 one must defer any recipient after the first that has a different
27091 content-filter configuration.  With PRDR, the RCPT-time check
27092 for this can be disabled when the MAIL-time $smtp_command included
27093 "PRDR".  Any required difference in behaviour of the main DATA-time
27094 ACL should however depend on the PRDR-time ACL having run, as Exim
27095 will avoid doing so in some situations (eg.  single-recipient mails).
27096
27097 See also the &%prdr_enable%& global option
27098 and the &%hosts_try_prdr%& smtp transport option.
27099
27100 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27101 If the ACL is not defined, processing completes as if
27102 the feature was not requested by the client.
27103
27104 .section "The QUIT ACL" "SECTQUITACL"
27105 .cindex "QUIT, ACL for"
27106 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27107 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27108 does not in fact control any access. For this reason, the only verbs that are
27109 permitted are &%accept%& and &%warn%&.
27110
27111 This ACL can be used for tasks such as custom logging at the end of an SMTP
27112 session. For example, you can use ACL variables in other ACLs to count
27113 messages, recipients, etc., and log the totals at QUIT time using one or
27114 more &%logwrite%& modifiers on a &%warn%& verb.
27115
27116 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27117 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27118
27119 You do not need to have a final &%accept%&, but if you do, you can use a
27120 &%message%& modifier to specify custom text that is sent as part of the 221
27121 response to QUIT.
27122
27123 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27124 failure (for example, failure to open a log file, or when Exim is bombing out
27125 because it has detected an unrecoverable error), all SMTP commands from the
27126 client are given temporary error responses until QUIT is received or the
27127 connection is closed. In these special cases, the QUIT ACL does not run.
27128
27129
27130 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27131 .vindex &$acl_smtp_notquit$&
27132 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27133 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27134 trouble, such as being unable to write to its log files, this ACL is not run,
27135 because it might try to do things (such as write to log files) that make the
27136 situation even worse.
27137
27138 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27139 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27140 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27141 and &%warn%&.
27142
27143 .vindex &$smtp_notquit_reason$&
27144 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27145 to a string that indicates the reason for the termination of the SMTP
27146 connection. The possible values are:
27147 .table2
27148 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27149 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27150 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27151 .irow &`connection-lost`&          "The SMTP connection has been lost"
27152 .irow &`data-timeout`&             "Timeout while reading message data"
27153 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27154 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27155 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27156 .irow &`synchronization-error`&    "SMTP synchronization error"
27157 .irow &`tls-failed`&               "TLS failed to start"
27158 .endtable
27159 In most cases when an SMTP connection is closed without having received QUIT,
27160 Exim sends an SMTP response message before actually closing the connection.
27161 With the exception of the &`acl-drop`& case, the default message can be
27162 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27163 &%drop%& verb in another ACL, it is the message from the other ACL that is
27164 used.
27165
27166
27167 .section "Finding an ACL to use" "SECID195"
27168 .cindex "&ACL;" "finding which to use"
27169 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27170 you can use different ACLs in different circumstances. For example,
27171 .code
27172 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27173                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27174 .endd
27175 In the default configuration file there are some example settings for
27176 providing an RFC 4409 message submission service on port 587 and a
27177 non-standard &"smtps"& service on port 465. You can use a string
27178 expansion like this to choose an ACL for MUAs on these ports which is
27179 more appropriate for this purpose than the default ACL on port 25.
27180
27181 The expanded string does not have to be the name of an ACL in the
27182 configuration file; there are other possibilities. Having expanded the
27183 string, Exim searches for an ACL as follows:
27184
27185 .ilist
27186 If the string begins with a slash, Exim uses it as a file name, and reads its
27187 contents as an ACL. The lines are processed in the same way as lines in the
27188 Exim configuration file. In particular, continuation lines are supported, blank
27189 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27190 If the file does not exist or cannot be read, an error occurs (typically
27191 causing a temporary failure of whatever caused the ACL to be run). For example:
27192 .code
27193 acl_smtp_data = /etc/acls/\
27194   ${lookup{$sender_host_address}lsearch\
27195   {/etc/acllist}{$value}{default}}
27196 .endd
27197 This looks up an ACL file to use on the basis of the host's IP address, falling
27198 back to a default if the lookup fails. If an ACL is successfully read from a
27199 file, it is retained in memory for the duration of the Exim process, so that it
27200 can be re-used without having to re-read the file.
27201 .next
27202 If the string does not start with a slash, and does not contain any spaces,
27203 Exim searches the ACL section of the configuration for an ACL whose name
27204 matches the string.
27205 .next
27206 If no named ACL is found, or if the string contains spaces, Exim parses
27207 the string as an inline ACL. This can save typing in cases where you just
27208 want to have something like
27209 .code
27210 acl_smtp_vrfy = accept
27211 .endd
27212 in order to allow free use of the VRFY command. Such a string may contain
27213 newlines; it is processed in the same way as an ACL that is read from a file.
27214 .endlist
27215
27216
27217
27218
27219 .section "ACL return codes" "SECID196"
27220 .cindex "&ACL;" "return codes"
27221 Except for the QUIT ACL, which does not affect the SMTP return code (see
27222 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27223 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27224 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27225 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27226 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27227 This also causes a 4&'xx'& return code.
27228
27229 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27230 &"deny"&, because there is no mechanism for passing temporary errors to the
27231 submitters of non-SMTP messages.
27232
27233
27234 ACLs that are relevant to message reception may also return &"discard"&. This
27235 has the effect of &"accept"&, but causes either the entire message or an
27236 individual recipient address to be discarded. In other words, it is a
27237 blackholing facility. Use it with care.
27238
27239 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27240 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27241 RCPT ACL is to discard just the one recipient address. If there are no
27242 recipients left when the message's data is received, the DATA ACL is not
27243 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27244 remaining recipients. The &"discard"& return is not permitted for the
27245 &%acl_smtp_predata%& ACL.
27246
27247
27248 .cindex "&[local_scan()]& function" "when all recipients discarded"
27249 The &[local_scan()]& function is always run, even if there are no remaining
27250 recipients; it may create new recipients.
27251
27252
27253
27254 .section "Unset ACL options" "SECID197"
27255 .cindex "&ACL;" "unset options"
27256 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27257 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27258 not defined at all. For any defined ACL, the default action when control
27259 reaches the end of the ACL statements is &"deny"&.
27260
27261 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27262 these two are ACLs that are used only for their side effects. They cannot be
27263 used to accept or reject anything.
27264
27265 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27266 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27267 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27268 when the ACL is not defined is &"accept"&.
27269
27270 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27271 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27272 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27273 messages over an SMTP connection. For an example, see the ACL in the default
27274 configuration file.
27275
27276
27277
27278
27279 .section "Data for message ACLs" "SECID198"
27280 .cindex "&ACL;" "data for message ACL"
27281 .vindex &$domain$&
27282 .vindex &$local_part$&
27283 .vindex &$sender_address$&
27284 .vindex &$sender_host_address$&
27285 .vindex &$smtp_command$&
27286 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27287 that contain information about the host and the message's sender (for example,
27288 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27289 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27290 &$local_part$& are set from the argument address. The entire SMTP command
27291 is available in &$smtp_command$&.
27292
27293 When an ACL for the AUTH parameter of MAIL is running, the variables that
27294 contain information about the host are set, but &$sender_address$& is not yet
27295 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27296 how it is used.
27297
27298 .vindex "&$message_size$&"
27299 The &$message_size$& variable is set to the value of the SIZE parameter on
27300 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27301 that parameter is not given. The value is updated to the true message size by
27302 the time the final DATA ACL is run (after the message data has been
27303 received).
27304
27305 .vindex "&$rcpt_count$&"
27306 .vindex "&$recipients_count$&"
27307 The &$rcpt_count$& variable increases by one for each RCPT command received.
27308 The &$recipients_count$& variable increases by one each time a RCPT command is
27309 accepted, so while an ACL for RCPT is being processed, it contains the number
27310 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27311 &$rcpt_count$& contains the total number of RCPT commands, and
27312 &$recipients_count$& contains the total number of accepted recipients.
27313
27314
27315
27316
27317
27318 .section "Data for non-message ACLs" "SECTdatfornon"
27319 .cindex "&ACL;" "data for non-message ACL"
27320 .vindex &$smtp_command_argument$&
27321 .vindex &$smtp_command$&
27322 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27323 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27324 and the entire SMTP command is available in &$smtp_command$&.
27325 These variables can be tested using a &%condition%& condition. For example,
27326 here is an ACL for use with AUTH, which insists that either the session is
27327 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27328 does not permit authentication methods that use cleartext passwords on
27329 unencrypted connections.
27330 .code
27331 acl_check_auth:
27332   accept encrypted = *
27333   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27334                      {CRAM-MD5}}
27335   deny   message   = TLS encryption or CRAM-MD5 required
27336 .endd
27337 (Another way of applying this restriction is to arrange for the authenticators
27338 that use cleartext passwords not to be advertised when the connection is not
27339 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27340 option to do this.)
27341
27342
27343
27344 .section "Format of an ACL" "SECID199"
27345 .cindex "&ACL;" "format of"
27346 .cindex "&ACL;" "verbs, definition of"
27347 An individual ACL consists of a number of statements. Each statement starts
27348 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27349 Modifiers can change the way the verb operates, define error and log messages,
27350 set variables, insert delays, and vary the processing of accepted messages.
27351
27352 If all the conditions are met, the verb is obeyed. The same condition may be
27353 used (with different arguments) more than once in the same statement. This
27354 provides a means of specifying an &"and"& conjunction between conditions. For
27355 example:
27356 .code
27357 deny  dnslists = list1.example
27358 dnslists = list2.example
27359 .endd
27360 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27361 the conditions and modifiers when it reaches a condition that fails. What
27362 happens then depends on the verb (and in one case, on a special modifier). Not
27363 all the conditions make sense at every testing point. For example, you cannot
27364 test a sender address in the ACL that is run for a VRFY command.
27365
27366
27367 .section "ACL verbs" "SECID200"
27368 The ACL verbs are as follows:
27369
27370 .ilist
27371 .cindex "&%accept%& ACL verb"
27372 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27373 of the conditions are not met, what happens depends on whether &%endpass%&
27374 appears among the conditions (for syntax see below). If the failing condition
27375 is before &%endpass%&, control is passed to the next ACL statement; if it is
27376 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27377 check a RCPT command:
27378 .code
27379 accept domains = +local_domains
27380 endpass
27381 verify = recipient
27382 .endd
27383 If the recipient domain does not match the &%domains%& condition, control
27384 passes to the next statement. If it does match, the recipient is verified, and
27385 the command is accepted if verification succeeds. However, if verification
27386 fails, the ACL yields &"deny"&, because the failing condition is after
27387 &%endpass%&.
27388
27389 The &%endpass%& feature has turned out to be confusing to many people, so its
27390 use is not recommended nowadays. It is always possible to rewrite an ACL so
27391 that &%endpass%& is not needed, and it is no longer used in the default
27392 configuration.
27393
27394 .cindex "&%message%& ACL modifier" "with &%accept%&"
27395 If a &%message%& modifier appears on an &%accept%& statement, its action
27396 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27397 (when an &%accept%& verb either accepts or passes control to the next
27398 statement), &%message%& can be used to vary the message that is sent when an
27399 SMTP command is accepted. For example, in a RCPT ACL you could have:
27400 .display
27401 &`accept  `&<&'some conditions'&>
27402 &`        message = OK, I will allow you through today`&
27403 .endd
27404 You can specify an SMTP response code, optionally followed by an &"extended
27405 response code"& at the start of the message, but the first digit must be the
27406 same as would be sent by default, which is 2 for an &%accept%& verb.
27407
27408 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27409 an error message that is used when access is denied. This behaviour is retained
27410 for backward compatibility, but current &"best practice"& is to avoid the use
27411 of &%endpass%&.
27412
27413
27414 .next
27415 .cindex "&%defer%& ACL verb"
27416 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27417 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27418 &%defer%& is the same as &%deny%&, because there is no way of sending a
27419 temporary error. For a RCPT command, &%defer%& is much the same as using a
27420 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27421 be used in any ACL, and even for a recipient it might be a simpler approach.
27422
27423
27424 .next
27425 .cindex "&%deny%& ACL verb"
27426 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27427 the conditions are not met, control is passed to the next ACL statement. For
27428 example,
27429 .code
27430 deny dnslists = blackholes.mail-abuse.org
27431 .endd
27432 rejects commands from hosts that are on a DNS black list.
27433
27434
27435 .next
27436 .cindex "&%discard%& ACL verb"
27437 &%discard%&: This verb behaves like &%accept%&, except that it returns
27438 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27439 that are concerned with receiving messages. When all the conditions are true,
27440 the sending entity receives a &"success"& response. However, &%discard%& causes
27441 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27442 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27443 message's recipients are discarded. Recipients that are discarded before DATA
27444 do not appear in the log line when the &%received_recipients%& log selector is set.
27445
27446 If the &%log_message%& modifier is set when &%discard%& operates,
27447 its contents are added to the line that is automatically written to the log.
27448 The &%message%& modifier operates exactly as it does for &%accept%&.
27449
27450
27451 .next
27452 .cindex "&%drop%& ACL verb"
27453 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27454 forcibly closed after the 5&'xx'& error message has been sent. For example:
27455 .code
27456 drop   message   = I don't take more than 20 RCPTs
27457        condition = ${if > {$rcpt_count}{20}}
27458 .endd
27459 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27460 The connection is always dropped after sending a 550 response.
27461
27462 .next
27463 .cindex "&%require%& ACL verb"
27464 &%require%&: If all the conditions are met, control is passed to the next ACL
27465 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27466 example, when checking a RCPT command,
27467 .code
27468 require message = Sender did not verify
27469         verify  = sender
27470 .endd
27471 passes control to subsequent statements only if the message's sender can be
27472 verified. Otherwise, it rejects the command. Note the positioning of the
27473 &%message%& modifier, before the &%verify%& condition. The reason for this is
27474 discussed in section &<<SECTcondmodproc>>&.
27475
27476 .next
27477 .cindex "&%warn%& ACL verb"
27478 &%warn%&: If all the conditions are true, a line specified by the
27479 &%log_message%& modifier is written to Exim's main log. Control always passes
27480 to the next ACL statement. If any condition is false, the log line is not
27481 written. If an identical log line is requested several times in the same
27482 message, only one copy is actually written to the log. If you want to force
27483 duplicates to be written, use the &%logwrite%& modifier instead.
27484
27485 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27486 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27487 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27488 first failing condition. There is more about adding header lines in section
27489 &<<SECTaddheadacl>>&.
27490
27491 If any condition on a &%warn%& statement cannot be completed (that is, there is
27492 some sort of defer), the log line specified by &%log_message%& is not written.
27493 This does not include the case of a forced failure from a lookup, which
27494 is considered to be a successful completion. After a defer, no further
27495 conditions or modifiers in the &%warn%& statement are processed. The incident
27496 is logged, and the ACL continues to be processed, from the next statement
27497 onwards.
27498
27499
27500 .vindex "&$acl_verify_message$&"
27501 When one of the &%warn%& conditions is an address verification that fails, the
27502 text of the verification failure message is in &$acl_verify_message$&. If you
27503 want this logged, you must set it up explicitly. For example:
27504 .code
27505 warn   !verify = sender
27506        log_message = sender verify failed: $acl_verify_message
27507 .endd
27508 .endlist
27509
27510 At the end of each ACL there is an implicit unconditional &%deny%&.
27511
27512 As you can see from the examples above, the conditions and modifiers are
27513 written one to a line, with the first one on the same line as the verb, and
27514 subsequent ones on following lines. If you have a very long condition, you can
27515 continue it onto several physical lines by the usual backslash continuation
27516 mechanism. It is conventional to align the conditions vertically.
27517
27518
27519
27520 .section "ACL variables" "SECTaclvariables"
27521 .cindex "&ACL;" "variables"
27522 There are some special variables that can be set during ACL processing. They
27523 can be used to pass information between different ACLs, different invocations
27524 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27525 transports, and filters that are used to deliver a message. The names of these
27526 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27527 an underscore, but the remainder of the name can be any sequence of
27528 alphanumeric characters and underscores that you choose. There is no limit on
27529 the number of ACL variables. The two sets act as follows:
27530 .ilist
27531 The values of those variables whose names begin with &$acl_c$& persist
27532 throughout an SMTP connection. They are never reset. Thus, a value that is set
27533 while receiving one message is still available when receiving the next message
27534 on the same SMTP connection.
27535 .next
27536 The values of those variables whose names begin with &$acl_m$& persist only
27537 while a message is being received. They are reset afterwards. They are also
27538 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27539 .endlist
27540
27541 When a message is accepted, the current values of all the ACL variables are
27542 preserved with the message and are subsequently made available at delivery
27543 time. The ACL variables are set by a modifier called &%set%&. For example:
27544 .code
27545 accept hosts = whatever
27546        set acl_m4 = some value
27547 accept authenticated = *
27548        set acl_c_auth = yes
27549 .endd
27550 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27551 be set. If you want to set a variable without taking any action, you can use a
27552 &%warn%& verb without any other modifiers or conditions.
27553
27554 .oindex &%strict_acl_vars%&
27555 What happens if a syntactically valid but undefined ACL variable is
27556 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27557 false (the default), an empty string is substituted; if it is true, an
27558 error is generated.
27559
27560 Versions of Exim before 4.64 have a limited set of numbered variables, but
27561 their names are compatible, so there is no problem with upgrading.
27562
27563
27564 .section "Condition and modifier processing" "SECTcondmodproc"
27565 .cindex "&ACL;" "conditions; processing"
27566 .cindex "&ACL;" "modifiers; processing"
27567 An exclamation mark preceding a condition negates its result. For example:
27568 .code
27569 deny   domains = *.dom.example
27570       !verify  = recipient
27571 .endd
27572 causes the ACL to return &"deny"& if the recipient domain ends in
27573 &'dom.example'& and the recipient address cannot be verified. Sometimes
27574 negation can be used on the right-hand side of a condition. For example, these
27575 two statements are equivalent:
27576 .code
27577 deny  hosts = !192.168.3.4
27578 deny !hosts =  192.168.3.4
27579 .endd
27580 However, for many conditions (&%verify%& being a good example), only left-hand
27581 side negation of the whole condition is possible.
27582
27583 The arguments of conditions and modifiers are expanded. A forced failure
27584 of an expansion causes a condition to be ignored, that is, it behaves as if the
27585 condition is true. Consider these two statements:
27586 .code
27587 accept  senders = ${lookup{$host_name}lsearch\
27588                   {/some/file}{$value}fail}
27589 accept  senders = ${lookup{$host_name}lsearch\
27590                   {/some/file}{$value}{}}
27591 .endd
27592 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27593 the returned list is searched, but if the lookup fails the behaviour is
27594 different in the two cases. The &%fail%& in the first statement causes the
27595 condition to be ignored, leaving no further conditions. The &%accept%& verb
27596 therefore succeeds. The second statement, however, generates an empty list when
27597 the lookup fails. No sender can match an empty list, so the condition fails,
27598 and therefore the &%accept%& also fails.
27599
27600 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27601 specify actions that are taken as the conditions for a statement are checked;
27602 others specify text for messages that are used when access is denied or a
27603 warning is generated. The &%control%& modifier affects the way an incoming
27604 message is handled.
27605
27606 The positioning of the modifiers in an ACL statement is important, because the
27607 processing of a verb ceases as soon as its outcome is known. Only those
27608 modifiers that have already been encountered will take effect. For example,
27609 consider this use of the &%message%& modifier:
27610 .code
27611 require message = Can't verify sender
27612         verify  = sender
27613         message = Can't verify recipient
27614         verify  = recipient
27615         message = This message cannot be used
27616 .endd
27617 If sender verification fails, Exim knows that the result of the statement is
27618 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27619 so its text is used as the error message. If sender verification succeeds, but
27620 recipient verification fails, the second message is used. If recipient
27621 verification succeeds, the third message becomes &"current"&, but is never used
27622 because there are no more conditions to cause failure.
27623
27624 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27625 modifier that is used, because all the conditions must be true for rejection to
27626 happen. Specifying more than one &%message%& modifier does not make sense, and
27627 the message can even be specified after all the conditions. For example:
27628 .code
27629 deny   hosts = ...
27630       !senders = *@my.domain.example
27631        message = Invalid sender from client host
27632 .endd
27633 The &"deny"& result does not happen until the end of the statement is reached,
27634 by which time Exim has set up the message.
27635
27636
27637
27638 .section "ACL modifiers" "SECTACLmodi"
27639 .cindex "&ACL;" "modifiers; list of"
27640 The ACL modifiers are as follows:
27641
27642 .vlist
27643 .vitem &*add_header*&&~=&~<&'text'&>
27644 This modifier specifies one or more header lines that are to be added to an
27645 incoming message, assuming, of course, that the message is ultimately
27646 accepted. For details, see section &<<SECTaddheadacl>>&.
27647
27648 .vitem &*continue*&&~=&~<&'text'&>
27649 .cindex "&%continue%& ACL modifier"
27650 .cindex "database" "updating in ACL"
27651 This modifier does nothing of itself, and processing of the ACL always
27652 continues with the next condition or modifier. The value of &%continue%& is in
27653 the side effects of expanding its argument. Typically this could be used to
27654 update a database. It is really just a syntactic tidiness, to avoid having to
27655 write rather ugly lines like this:
27656 .display
27657 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27658 .endd
27659 Instead, all you need is
27660 .display
27661 &`continue = `&<&'some expansion'&>
27662 .endd
27663
27664 .vitem &*control*&&~=&~<&'text'&>
27665 .cindex "&%control%& ACL modifier"
27666 This modifier affects the subsequent processing of the SMTP connection or of an
27667 incoming message that is accepted. The effect of the first type of control
27668 lasts for the duration of the connection, whereas the effect of the second type
27669 lasts only until the current message has been received. The message-specific
27670 controls always apply to the whole message, not to individual recipients,
27671 even if the &%control%& modifier appears in a RCPT ACL.
27672
27673 As there are now quite a few controls that can be applied, they are described
27674 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27675 in several different ways. For example:
27676
27677 . ==== As this is a nested list, any displays it contains must be indented
27678 . ==== as otherwise they are too far to the left. That comment applies only
27679 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27680 . ==== way.
27681
27682 .ilist
27683 It can be at the end of an &%accept%& statement:
27684 .code
27685     accept  ...some conditions
27686             control = queue_only
27687 .endd
27688 In this case, the control is applied when this statement yields &"accept"&, in
27689 other words, when the conditions are all true.
27690
27691 .next
27692 It can be in the middle of an &%accept%& statement:
27693 .code
27694     accept  ...some conditions...
27695             control = queue_only
27696             ...some more conditions...
27697 .endd
27698 If the first set of conditions are true, the control is applied, even if the
27699 statement does not accept because one of the second set of conditions is false.
27700 In this case, some subsequent statement must yield &"accept"& for the control
27701 to be relevant.
27702
27703 .next
27704 It can be used with &%warn%& to apply the control, leaving the
27705 decision about accepting or denying to a subsequent verb. For
27706 example:
27707 .code
27708     warn    ...some conditions...
27709             control = freeze
27710     accept  ...
27711 .endd
27712 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27713 &%logwrite%&, so it does not add anything to the message and does not write a
27714 log entry.
27715
27716 .next
27717 If you want to apply a control unconditionally, you can use it with a
27718 &%require%& verb. For example:
27719 .code
27720     require  control = no_multiline_responses
27721 .endd
27722 .endlist
27723
27724 .vitem &*delay*&&~=&~<&'time'&>
27725 .cindex "&%delay%& ACL modifier"
27726 .oindex "&%-bh%&"
27727 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27728 the time interval before proceeding. However, when testing Exim using the
27729 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27730 output instead). The time is given in the usual Exim notation, and the delay
27731 happens as soon as the modifier is processed. In an SMTP session, pending
27732 output is flushed before the delay is imposed.
27733
27734 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27735 example:
27736 .code
27737 deny    ...some conditions...
27738         delay = 30s
27739 .endd
27740 The delay happens if all the conditions are true, before the statement returns
27741 &"deny"&. Compare this with:
27742 .code
27743 deny    delay = 30s
27744         ...some conditions...
27745 .endd
27746 which waits for 30s before processing the conditions. The &%delay%& modifier
27747 can also be used with &%warn%& and together with &%control%&:
27748 .code
27749 warn    ...some conditions...
27750         delay = 2m
27751         control = freeze
27752 accept  ...
27753 .endd
27754
27755 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27756 responses to several commands are no longer buffered and sent in one packet (as
27757 they would normally be) because all output is flushed before imposing the
27758 delay. This optimization is disabled so that a number of small delays do not
27759 appear to the client as one large aggregated delay that might provoke an
27760 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27761 using a &%control%& modifier to set &%no_delay_flush%&.
27762
27763
27764 .vitem &*endpass*&
27765 .cindex "&%endpass%& ACL modifier"
27766 This modifier, which has no argument, is recognized only in &%accept%& and
27767 &%discard%& statements. It marks the boundary between the conditions whose
27768 failure causes control to pass to the next statement, and the conditions whose
27769 failure causes the ACL to return &"deny"&. This concept has proved to be
27770 confusing to some people, so the use of &%endpass%& is no longer recommended as
27771 &"best practice"&. See the description of &%accept%& above for more details.
27772
27773
27774 .vitem &*log_message*&&~=&~<&'text'&>
27775 .cindex "&%log_message%& ACL modifier"
27776 This modifier sets up a message that is used as part of the log message if the
27777 ACL denies access or a &%warn%& statement's conditions are true. For example:
27778 .code
27779 require log_message = wrong cipher suite $tls_in_cipher
27780         encrypted   = DES-CBC3-SHA
27781 .endd
27782 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27783 example:
27784 .display
27785 &`discard `&<&'some conditions'&>
27786 &`        log_message = Discarded $local_part@$domain because...`&
27787 .endd
27788 When access is denied, &%log_message%& adds to any underlying error message
27789 that may exist because of a condition failure. For example, while verifying a
27790 recipient address, a &':fail:'& redirection might have already set up a
27791 message.
27792
27793 The message may be defined before the conditions to which it applies, because
27794 the string expansion does not happen until Exim decides that access is to be
27795 denied. This means that any variables that are set by the condition are
27796 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27797 variables are set after a DNS black list lookup succeeds. If the expansion of
27798 &%log_message%& fails, or if the result is an empty string, the modifier is
27799 ignored.
27800
27801 .vindex "&$acl_verify_message$&"
27802 If you want to use a &%warn%& statement to log the result of an address
27803 verification, you can use &$acl_verify_message$& to include the verification
27804 error message.
27805
27806 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27807 the start of the logged message. If the same warning log message is requested
27808 more than once while receiving  a single email message, only one copy is
27809 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27810 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27811 is logged for a successful &%warn%& statement.
27812
27813 If &%log_message%& is not present and there is no underlying error message (for
27814 example, from the failure of address verification), but &%message%& is present,
27815 the &%message%& text is used for logging rejections. However, if any text for
27816 logging contains newlines, only the first line is logged. In the absence of
27817 both &%log_message%& and &%message%&, a default built-in message is used for
27818 logging rejections.
27819
27820
27821 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27822 .cindex "&%log_reject_target%& ACL modifier"
27823 .cindex "logging in ACL" "specifying which log"
27824 This modifier makes it possible to specify which logs are used for messages
27825 about ACL rejections. Its argument is a colon-separated list of words that can
27826 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27827 may be empty, in which case a rejection is not logged at all. For example, this
27828 ACL fragment writes no logging information when access is denied:
27829 .display
27830 &`deny `&<&'some conditions'&>
27831 &`     log_reject_target =`&
27832 .endd
27833 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27834 permanent and temporary rejections. Its effect lasts for the rest of the
27835 current ACL.
27836
27837
27838 .vitem &*logwrite*&&~=&~<&'text'&>
27839 .cindex "&%logwrite%& ACL modifier"
27840 .cindex "logging in ACL" "immediate"
27841 This modifier writes a message to a log file as soon as it is encountered when
27842 processing an ACL. (Compare &%log_message%&, which, except in the case of
27843 &%warn%& and &%discard%&, is used only if the ACL statement denies
27844 access.) The &%logwrite%& modifier can be used to log special incidents in
27845 ACLs. For example:
27846 .display
27847 &`accept `&<&'some special conditions'&>
27848 &`       control  = freeze`&
27849 &`       logwrite = froze message because ...`&
27850 .endd
27851 By default, the message is written to the main log. However, it may begin
27852 with a colon, followed by a comma-separated list of log names, and then
27853 another colon, to specify exactly which logs are to be written. For
27854 example:
27855 .code
27856 logwrite = :main,reject: text for main and reject logs
27857 logwrite = :panic: text for panic log only
27858 .endd
27859
27860
27861 .vitem &*message*&&~=&~<&'text'&>
27862 .cindex "&%message%& ACL modifier"
27863 This modifier sets up a text string that is expanded and used as a response
27864 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27865 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27866 there is some complication if &%endpass%& is involved; see the description of
27867 &%accept%& for details.)
27868
27869 The expansion of the message happens at the time Exim decides that the ACL is
27870 to end, not at the time it processes &%message%&. If the expansion fails, or
27871 generates an empty string, the modifier is ignored. Here is an example where
27872 &%message%& must be specified first, because the ACL ends with a rejection if
27873 the &%hosts%& condition fails:
27874 .code
27875 require  message = Host not recognized
27876          hosts = 10.0.0.0/8
27877 .endd
27878 (Once a condition has failed, no further conditions or modifiers are
27879 processed.)
27880
27881 .cindex "SMTP" "error codes"
27882 .oindex "&%smtp_banner%&
27883 For ACLs that are triggered by SMTP commands, the message is returned as part
27884 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27885 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27886 is accepted. In the case of the connect ACL, accepting with a message modifier
27887 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27888 accept message may not contain more than one line (otherwise it will be
27889 truncated at the first newline and a panic logged), and it cannot affect the
27890 EHLO options.
27891
27892 When SMTP is involved, the message may begin with an overriding response code,
27893 consisting of three digits optionally followed by an &"extended response code"&
27894 of the form &'n.n.n'&, each code being followed by a space. For example:
27895 .code
27896 deny  message = 599 1.2.3 Host not welcome
27897       hosts = 192.168.34.0/24
27898 .endd
27899 The first digit of the supplied response code must be the same as would be sent
27900 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27901 access, but for the predata ACL, note that the default success code is 354, not
27902 2&'xx'&.
27903
27904 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27905 the message modifier cannot override the 221 response code.
27906
27907 The text in a &%message%& modifier is literal; any quotes are taken as
27908 literals, but because the string is expanded, backslash escapes are processed
27909 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27910 response.
27911
27912 .vindex "&$acl_verify_message$&"
27913 For ACLs that are called by an &%acl =%& ACL condition, the message is
27914 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27915
27916 If &%message%& is used on a statement that verifies an address, the message
27917 specified overrides any message that is generated by the verification process.
27918 However, the original message is available in the variable
27919 &$acl_verify_message$&, so you can incorporate it into your message if you
27920 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27921 routers to be passed back as part of the SMTP response, you should either not
27922 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27923
27924 For compatibility with previous releases of Exim, a &%message%& modifier that
27925 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27926 modifier, but this usage is now deprecated. However, &%message%& acts only when
27927 all the conditions are true, wherever it appears in an ACL command, whereas
27928 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27929 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27930 effect.
27931
27932
27933 .vitem &*remove_header*&&~=&~<&'text'&>
27934 This modifier specifies one or more header names in a colon-separated list
27935  that are to be removed from an incoming message, assuming, of course, that
27936 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27937
27938
27939 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27940 .cindex "&%set%& ACL modifier"
27941 This modifier puts a value into one of the ACL variables (see section
27942 &<<SECTaclvariables>>&).
27943
27944
27945 .vitem &*udpsend*&&~=&~<&'parameters'&>
27946 This modifier sends a UDP packet, for purposes such as statistics
27947 collection or behaviour monitoring. The parameters are expanded, and
27948 the result of the expansion must be a colon-separated list consisting
27949 of a destination server, port number, and the packet contents. The
27950 server can be specified as a host name or IPv4 or IPv6 address. The
27951 separator can be changed with the usual angle bracket syntax. For
27952 example, you might want to collect information on which hosts connect
27953 when:
27954 .code
27955 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27956              $tod_zulu $sender_host_address
27957 .endd
27958 .endlist
27959
27960
27961
27962
27963 .section "Use of the control modifier" "SECTcontrols"
27964 .cindex "&%control%& ACL modifier"
27965 The &%control%& modifier supports the following settings:
27966
27967 .vlist
27968 .vitem &*control&~=&~allow_auth_unadvertised*&
27969 This modifier allows a client host to use the SMTP AUTH command even when it
27970 has not been advertised in response to EHLO. Furthermore, because there are
27971 apparently some really broken clients that do this, Exim will accept AUTH after
27972 HELO (rather than EHLO) when this control is set. It should be used only if you
27973 really need it, and you should limit its use to those broken clients that do
27974 not work without it. For example:
27975 .code
27976 warn hosts   = 192.168.34.25
27977      control = allow_auth_unadvertised
27978 .endd
27979 Normally, when an Exim server receives an AUTH command, it checks the name of
27980 the authentication mechanism that is given in the command to ensure that it
27981 matches an advertised mechanism. When this control is set, the check that a
27982 mechanism has been advertised is bypassed. Any configured mechanism can be used
27983 by the client. This control is permitted only in the connection and HELO ACLs.
27984
27985
27986 .vitem &*control&~=&~caseful_local_part*& &&&
27987        &*control&~=&~caselower_local_part*&
27988 .cindex "&ACL;" "case of local part in"
27989 .cindex "case of local parts"
27990 .vindex "&$local_part$&"
27991 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27992 (that is, during RCPT processing). By default, the contents of &$local_part$&
27993 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27994 any uppercase letters in the original local part are restored in &$local_part$&
27995 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27996 is encountered.
27997
27998 These controls affect only the current recipient. Moreover, they apply only to
27999 local part handling that takes place directly in the ACL (for example, as a key
28000 in lookups). If a test to verify the recipient is obeyed, the case-related
28001 handling of the local part during the verification is controlled by the router
28002 configuration (see the &%caseful_local_part%& generic router option).
28003
28004 This facility could be used, for example, to add a spam score to local parts
28005 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28006 spam score:
28007 .code
28008 warn  control = caseful_local_part
28009       set acl_m4 = ${eval:\
28010                      $acl_m4 + \
28011                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28012                     }
28013       control = caselower_local_part
28014 .endd
28015 Notice that we put back the lower cased version afterwards, assuming that
28016 is what is wanted for subsequent tests.
28017
28018
28019 .vitem &*control&~=&~cutthrough_delivery*&
28020 .cindex "&ACL;" "cutthrough routing"
28021 .cindex "cutthrough" "requesting"
28022 This option requests delivery be attempted while the item is being received.
28023
28024 The option is usable in the RCPT ACL.
28025 If enabled for a message recieved via smtp and routed to an smtp transport,
28026 and only one transport, interface, destination host and port combination
28027 is used for all recipients of the message,
28028 then the delivery connection is made while the receiving connection is open
28029 and data is copied from one to the other.
28030
28031 An attempt to set this option for any recipient but the first
28032 for a mail will be quietly ignored.
28033 If a recipient-verify callout connection is subsequently
28034 requested in the same ACL it is held open and used for
28035 any subsequent receipients and the data,
28036 otherwise one is made after the initial RCPT ACL completes.
28037
28038 Note that routers are used in verify mode,
28039 and cannot depend on content of received headers.
28040 Note also that headers cannot be
28041 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28042 Headers may be modified by routers (subject to the above) and transports.
28043
28044 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28045 of outgoing messages is done, because it sends data to the ultimate destination
28046 before the entire message has been received from the source.
28047 It is not supported for messages recieved with the SMTP PRDR option in use.
28048
28049 Should the ultimate destination system positively accept or reject the mail,
28050 a corresponding indication is given to the source system and nothing is queued.
28051 If there is a temporary error the item is queued for later delivery in the
28052 usual fashion. If the item is successfully delivered in cutthrough mode
28053 the delivery log lines are tagged with ">>" rather than "=>" and appear
28054 before the acceptance "<=" line.
28055
28056 Delivery in this mode avoids the generation of a bounce mail to a
28057 (possibly faked)
28058 sender when the destination system is doing content-scan based rejection.
28059
28060
28061 .vitem &*control&~=&~debug/*&<&'options'&>
28062 .cindex "&ACL;" "enabling debug logging"
28063 .cindex "debugging" "enabling from an ACL"
28064 This control turns on debug logging, almost as though Exim had been invoked
28065 with &`-d`&, with the output going to a new logfile, by default called
28066 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28067 may access any variables already defined.  The logging may be adjusted with
28068 the &'opts'& option, which takes the same values as the &`-d`& command-line
28069 option.  Some examples (which depend on variables that don't exist in all
28070 contexts):
28071 .code
28072       control = debug
28073       control = debug/tag=.$sender_host_address
28074       control = debug/opts=+expand+acl
28075       control = debug/tag=.$message_exim_id/opts=+expand
28076 .endd
28077
28078
28079 .vitem &*control&~=&~dkim_disable_verify*&
28080 .cindex "disable DKIM verify"
28081 .cindex "DKIM" "disable verify"
28082 This control turns off DKIM verification processing entirely.  For details on
28083 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28084
28085
28086 .vitem &*control&~=&~dscp/*&<&'value'&>
28087 .cindex "&ACL;" "setting DSCP value"
28088 .cindex "DSCP" "inbound"
28089 This option causes the DSCP value associated with the socket for the inbound
28090 connection to be adjusted to a given value, given as one of a number of fixed
28091 strings or to numeric value.
28092 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28093 Common values include &`throughput`&, &`mincost`&, and on newer systems
28094 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28095
28096 The outbound packets from Exim will be marked with this value in the header
28097 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28098 that these values will have any effect, not be stripped by networking
28099 equipment, or do much of anything without cooperation with your Network
28100 Engineer and those of all network operators between the source and destination.
28101
28102
28103 .vitem &*control&~=&~enforce_sync*& &&&
28104        &*control&~=&~no_enforce_sync*&
28105 .cindex "SMTP" "synchronization checking"
28106 .cindex "synchronization checking in SMTP"
28107 These controls make it possible to be selective about when SMTP synchronization
28108 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28109 state of the switch (it is true by default). See the description of this option
28110 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28111
28112 The effect of these two controls lasts for the remainder of the SMTP
28113 connection. They can appear in any ACL except the one for the non-SMTP
28114 messages. The most straightforward place to put them is in the ACL defined by
28115 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28116 before the first synchronization check. The expected use is to turn off the
28117 synchronization checks for badly-behaved hosts that you nevertheless need to
28118 work with.
28119
28120
28121 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28122 .cindex "fake defer"
28123 .cindex "defer, fake"
28124 This control works in exactly the same way as &%fakereject%& (described below)
28125 except that it causes an SMTP 450 response after the message data instead of a
28126 550 response. You must take care when using &%fakedefer%& because it causes the
28127 messages to be duplicated when the sender retries. Therefore, you should not
28128 use &%fakedefer%& if the message is to be delivered normally.
28129
28130 .vitem &*control&~=&~fakereject/*&<&'message'&>
28131 .cindex "fake rejection"
28132 .cindex "rejection, fake"
28133 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28134 words, only when an SMTP message is being received. If Exim accepts the
28135 message, instead the final 250 response, a 550 rejection message is sent.
28136 However, Exim proceeds to deliver the message as normal. The control applies
28137 only to the current message, not to any subsequent ones that may be received in
28138 the same SMTP connection.
28139
28140 The text for the 550 response is taken from the &%control%& modifier. If no
28141 message is supplied, the following is used:
28142 .code
28143 550-Your message has been rejected but is being
28144 550-kept for evaluation.
28145 550-If it was a legitimate message, it may still be
28146 550 delivered to the target recipient(s).
28147 .endd
28148 This facility should be used with extreme caution.
28149
28150 .vitem &*control&~=&~freeze*&
28151 .cindex "frozen messages" "forcing in ACL"
28152 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28153 other words, only when a message is being received. If the message is accepted,
28154 it is placed on Exim's queue and frozen. The control applies only to the
28155 current message, not to any subsequent ones that may be received in the same
28156 SMTP connection.
28157
28158 This modifier can optionally be followed by &`/no_tell`&. If the global option
28159 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28160 is told about the freezing), provided all the &*control=freeze*& modifiers that
28161 are obeyed for the current message have the &`/no_tell`& option.
28162
28163 .vitem &*control&~=&~no_delay_flush*&
28164 .cindex "SMTP" "output flushing, disabling for delay"
28165 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28166 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28167 use. This control, as long as it is encountered before the &%delay%& modifier,
28168 disables such output flushing.
28169
28170 .vitem &*control&~=&~no_callout_flush*&
28171 .cindex "SMTP" "output flushing, disabling for callout"
28172 Exim normally flushes SMTP output before performing a callout in an ACL, to
28173 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28174 use. This control, as long as it is encountered before the &%verify%& condition
28175 that causes the callout, disables such output flushing.
28176
28177 .vitem &*control&~=&~no_mbox_unspool*&
28178 This control is available when Exim is compiled with the content scanning
28179 extension. Content scanning may require a copy of the current message, or parts
28180 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28181 or spam scanner. Normally, such copies are deleted when they are no longer
28182 needed. If this control is set, the copies are not deleted. The control applies
28183 only to the current message, not to any subsequent ones that may be received in
28184 the same SMTP connection. It is provided for debugging purposes and is unlikely
28185 to be useful in production.
28186
28187 .vitem &*control&~=&~no_multiline_responses*&
28188 .cindex "multiline responses, suppressing"
28189 This control is permitted for any ACL except the one for non-SMTP messages.
28190 It seems that there are broken clients in use that cannot handle multiline
28191 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28192
28193 If this control is set, multiline SMTP responses from ACL rejections are
28194 suppressed. One way of doing this would have been to put out these responses as
28195 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28196 (&"use multiline responses for more"& it says &-- ha!), and some of the
28197 responses might get close to that. So this facility, which is after all only a
28198 sop to broken clients, is implemented by doing two very easy things:
28199
28200 .ilist
28201 Extra information that is normally output as part of a rejection caused by
28202 sender verification failure is omitted. Only the final line (typically &"sender
28203 verification failed"&) is sent.
28204 .next
28205 If a &%message%& modifier supplies a multiline response, only the first
28206 line is output.
28207 .endlist
28208
28209 The setting of the switch can, of course, be made conditional on the
28210 calling host. Its effect lasts until the end of the SMTP connection.
28211
28212 .vitem &*control&~=&~no_pipelining*&
28213 .cindex "PIPELINING" "suppressing advertising"
28214 This control turns off the advertising of the PIPELINING extension to SMTP in
28215 the current session. To be useful, it must be obeyed before Exim sends its
28216 response to an EHLO command. Therefore, it should normally appear in an ACL
28217 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28218 &%pipelining_advertise_hosts%&.
28219
28220 .vitem &*control&~=&~queue_only*&
28221 .oindex "&%queue_only%&"
28222 .cindex "queueing incoming messages"
28223 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28224 other words, only when a message is being received. If the message is accepted,
28225 it is placed on Exim's queue and left there for delivery by a subsequent queue
28226 runner. No immediate delivery process is started. In other words, it has the
28227 effect as the &%queue_only%& global option. However, the control applies only
28228 to the current message, not to any subsequent ones that may be received in the
28229 same SMTP connection.
28230
28231 .vitem &*control&~=&~submission/*&<&'options'&>
28232 .cindex "message" "submission"
28233 .cindex "submission mode"
28234 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28235 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28236 the current message is a submission from a local MUA. In this case, Exim
28237 operates in &"submission mode"&, and applies certain fixups to the message if
28238 necessary. For example, it adds a &'Date:'& header line if one is not present.
28239 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28240 late (the message has already been created).
28241
28242 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28243 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28244 submission mode; the available options for this control are described there.
28245 The control applies only to the current message, not to any subsequent ones
28246 that may be received in the same SMTP connection.
28247
28248 .vitem &*control&~=&~suppress_local_fixups*&
28249 .cindex "submission fixups, suppressing"
28250 This control applies to locally submitted (non TCP/IP) messages, and is the
28251 complement of &`control = submission`&. It disables the fixups that are
28252 normally applied to locally-submitted messages. Specifically:
28253
28254 .ilist
28255 Any &'Sender:'& header line is left alone (in this respect, it is a
28256 dynamic version of &%local_sender_retain%&).
28257 .next
28258 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28259 .next
28260 There is no check that &'From:'& corresponds to the actual sender.
28261 .endlist ilist
28262
28263 This control may be useful when a remotely-originated message is accepted,
28264 passed to some scanning program, and then re-submitted for delivery. It can be
28265 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28266 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28267 data is read.
28268
28269 &*Note:*& This control applies only to the current message, not to any others
28270 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28271 .endlist vlist
28272
28273
28274 .section "Summary of message fixup control" "SECTsummesfix"
28275 All four possibilities for message fixups can be specified:
28276
28277 .ilist
28278 Locally submitted, fixups applied: the default.
28279 .next
28280 Locally submitted, no fixups applied: use
28281 &`control = suppress_local_fixups`&.
28282 .next
28283 Remotely submitted, no fixups applied: the default.
28284 .next
28285 Remotely submitted, fixups applied: use &`control = submission`&.
28286 .endlist
28287
28288
28289
28290 .section "Adding header lines in ACLs" "SECTaddheadacl"
28291 .cindex "header lines" "adding in an ACL"
28292 .cindex "header lines" "position of added lines"
28293 .cindex "&%add_header%& ACL modifier"
28294 The &%add_header%& modifier can be used to add one or more extra header lines
28295 to an incoming message, as in this example:
28296 .code
28297 warn dnslists = sbl.spamhaus.org : \
28298                 dialup.mail-abuse.org
28299      add_header = X-blacklisted-at: $dnslist_domain
28300 .endd
28301 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28302 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28303 receiving a message). The message must ultimately be accepted for
28304 &%add_header%& to have any significant effect. You can use &%add_header%& with
28305 any ACL verb, including &%deny%& (though this is potentially useful only in a
28306 RCPT ACL).
28307
28308 Headers will not be added to the message if the modifier is used in
28309 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28310
28311 Leading and trailing newlines are removed from
28312 the data for the &%add_header%& modifier; if it then
28313 contains one or more newlines that
28314 are not followed by a space or a tab, it is assumed to contain multiple header
28315 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28316 front of any line that is not a valid header line.
28317
28318 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28319 They are added to the message before processing the DATA and MIME ACLs.
28320 However, if an identical header line is requested more than once, only one copy
28321 is actually added to the message. Further header lines may be accumulated
28322 during the DATA and MIME ACLs, after which they are added to the message, again
28323 with duplicates suppressed. Thus, it is possible to add two identical header
28324 lines to an SMTP message, but only if one is added before DATA and one after.
28325 In the case of non-SMTP messages, new headers are accumulated during the
28326 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28327 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28328 are included in the entry that is written to the reject log.
28329
28330 .cindex "header lines" "added; visibility of"
28331 Header lines are not visible in string expansions
28332 of message headers
28333 until they are added to the
28334 message. It follows that header lines defined in the MAIL, RCPT, and predata
28335 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28336 header lines that are added by the DATA or MIME ACLs are not visible in those
28337 ACLs. Because of this restriction, you cannot use header lines as a way of
28338 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28339 this, you can use ACL variables, as described in section
28340 &<<SECTaclvariables>>&.
28341
28342 The list of headers yet to be added is given by the &%$headers_added%& variable.
28343
28344 The &%add_header%& modifier acts immediately as it is encountered during the
28345 processing of an ACL. Notice the difference between these two cases:
28346 .display
28347 &`accept add_header = ADDED: some text`&
28348 &`       `&<&'some condition'&>
28349
28350 &`accept `&<&'some condition'&>
28351 &`       add_header = ADDED: some text`&
28352 .endd
28353 In the first case, the header line is always added, whether or not the
28354 condition is true. In the second case, the header line is added only if the
28355 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28356 ACL statement. All those that are encountered before a condition fails are
28357 honoured.
28358
28359 .cindex "&%warn%& ACL verb"
28360 For compatibility with previous versions of Exim, a &%message%& modifier for a
28361 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28362 effect only if all the conditions are true, even if it appears before some of
28363 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28364 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28365 are present on a &%warn%& verb, both are processed according to their
28366 specifications.
28367
28368 By default, new header lines are added to a message at the end of the existing
28369 header lines. However, you can specify that any particular header line should
28370 be added right at the start (before all the &'Received:'& lines), immediately
28371 after the first block of &'Received:'& lines, or immediately before any line
28372 that is not a &'Received:'& or &'Resent-something:'& header.
28373
28374 This is done by specifying &":at_start:"&, &":after_received:"&, or
28375 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28376 header line, respectively. (Header text cannot start with a colon, as there has
28377 to be a header name first.) For example:
28378 .code
28379 warn add_header = \
28380        :after_received:X-My-Header: something or other...
28381 .endd
28382 If more than one header line is supplied in a single &%add_header%& modifier,
28383 each one is treated independently and can therefore be placed differently. If
28384 you add more than one line at the start, or after the Received: block, they end
28385 up in reverse order.
28386
28387 &*Warning*&: This facility currently applies only to header lines that are
28388 added in an ACL. It does NOT work for header lines that are added in a
28389 system filter or in a router or transport.
28390
28391
28392
28393 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28394 .cindex "header lines" "removing in an ACL"
28395 .cindex "header lines" "position of removed lines"
28396 .cindex "&%remove_header%& ACL modifier"
28397 The &%remove_header%& modifier can be used to remove one or more header lines
28398 from an incoming message, as in this example:
28399 .code
28400 warn   message        = Remove internal headers
28401        remove_header  = x-route-mail1 : x-route-mail2
28402 .endd
28403 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28404 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28405 receiving a message). The message must ultimately be accepted for
28406 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28407 with any ACL verb, including &%deny%&, though this is really not useful for
28408 any verb that doesn't result in a delivered message.
28409
28410 Headers will not be removed to the message if the modifier is used in
28411 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28412
28413 More than one header can be removed at the same time by using a colon separated
28414 list of header names. The header matching is case insensitive. Wildcards are
28415 not permitted, nor is list expansion performed, so you cannot use hostlists to
28416 create a list of headers, however both connection and message variable expansion
28417 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28418 .code
28419 warn   hosts           = +internal_hosts
28420        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28421 warn   message         = Remove internal headers
28422        remove_header   = $acl_c_ihdrs
28423 .endd
28424 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28425 They are removed from the message before processing the DATA and MIME ACLs.
28426 There is no harm in attempting to remove the same header twice nor is removing
28427 a non-existent header. Further header lines to be removed may be accumulated
28428 during the DATA and MIME ACLs, after which they are removed from the message,
28429 if present. In the case of non-SMTP messages, headers to be removed are
28430 accumulated during the non-SMTP ACLs, and are removed from the message after
28431 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28432 ACL, there really is no effect because there is no logging of what headers
28433 would have been removed.
28434
28435 .cindex "header lines" "removed; visibility of"
28436 Header lines are not visible in string expansions until the DATA phase when it
28437 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28438 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28439 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28440 this restriction, you cannot use header lines as a way of controlling data
28441 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28442 you should instead use ACL variables, as described in section
28443 &<<SECTaclvariables>>&.
28444
28445 The &%remove_header%& modifier acts immediately as it is encountered during the
28446 processing of an ACL. Notice the difference between these two cases:
28447 .display
28448 &`accept remove_header = X-Internal`&
28449 &`       `&<&'some condition'&>
28450
28451 &`accept `&<&'some condition'&>
28452 &`       remove_header = X-Internal`&
28453 .endd
28454 In the first case, the header line is always removed, whether or not the
28455 condition is true. In the second case, the header line is removed only if the
28456 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28457 same ACL statement. All those that are encountered before a condition fails
28458 are honoured.
28459
28460 &*Warning*&: This facility currently applies only to header lines that are
28461 present during ACL processing. It does NOT remove header lines that are added
28462 in a system filter or in a router or transport.
28463
28464
28465
28466
28467 .section "ACL conditions" "SECTaclconditions"
28468 .cindex "&ACL;" "conditions; list of"
28469 Some of the conditions listed in this section are available only when Exim is
28470 compiled with the content-scanning extension. They are included here briefly
28471 for completeness. More detailed descriptions can be found in the discussion on
28472 content scanning in chapter &<<CHAPexiscan>>&.
28473
28474 Not all conditions are relevant in all circumstances. For example, testing
28475 senders and recipients does not make sense in an ACL that is being run as the
28476 result of the arrival of an ETRN command, and checks on message headers can be
28477 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28478 can use the same condition (with different parameters) more than once in the
28479 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28480 The conditions are as follows:
28481
28482
28483 .vlist
28484 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28485 .cindex "&ACL;" "nested"
28486 .cindex "&ACL;" "indirect"
28487 .cindex "&ACL;" "arguments"
28488 .cindex "&%acl%& ACL condition"
28489 The possible values of the argument are the same as for the
28490 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28491 &"accept"& the condition is true; if it returns &"deny"& the condition is
28492 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28493 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28494 condition false. This means that further processing of the &%warn%& verb
28495 ceases, but processing of the ACL continues.
28496
28497 If the argument is a named ACL, up to nine space-separated optional values
28498 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28499 and $acl_narg is set to the count of values.
28500 Previous values of these variables are restored after the call returns.
28501 The name and values are expanded separately.
28502 Note that spaces in complex expansions which are used as arguments
28503 will act as argument separators.
28504
28505 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28506 the connection is dropped. If it returns &"discard"&, the verb must be
28507 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28508 conditions are tested.
28509
28510 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28511 loops. This condition allows you to use different ACLs in different
28512 circumstances. For example, different ACLs can be used to handle RCPT commands
28513 for different local users or different local domains.
28514
28515 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28516 .cindex "&%authenticated%& ACL condition"
28517 .cindex "authentication" "ACL checking"
28518 .cindex "&ACL;" "testing for authentication"
28519 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28520 the name of the authenticator is tested against the list. To test for
28521 authentication by any authenticator, you can set
28522 .code
28523 authenticated = *
28524 .endd
28525
28526 .vitem &*condition&~=&~*&<&'string'&>
28527 .cindex "&%condition%& ACL condition"
28528 .cindex "customizing" "ACL condition"
28529 .cindex "&ACL;" "customized test"
28530 .cindex "&ACL;" "testing, customized"
28531 This feature allows you to make up custom conditions. If the result of
28532 expanding the string is an empty string, the number zero, or one of the strings
28533 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28534 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28535 any other value, some error is assumed to have occurred, and the ACL returns
28536 &"defer"&. However, if the expansion is forced to fail, the condition is
28537 ignored. The effect is to treat it as true, whether it is positive or
28538 negative.
28539
28540 .vitem &*decode&~=&~*&<&'location'&>
28541 .cindex "&%decode%& ACL condition"
28542 This condition is available only when Exim is compiled with the
28543 content-scanning extension, and it is allowed only in the ACL defined by
28544 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28545 If all goes well, the condition is true. It is false only if there are
28546 problems such as a syntax error or a memory shortage. For more details, see
28547 chapter &<<CHAPexiscan>>&.
28548
28549 .vitem &*demime&~=&~*&<&'extension&~list'&>
28550 .cindex "&%demime%& ACL condition"
28551 This condition is available only when Exim is compiled with the
28552 content-scanning extension. Its use is described in section
28553 &<<SECTdemimecond>>&.
28554
28555 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28556 .cindex "&%dnslists%& ACL condition"
28557 .cindex "DNS list" "in ACL"
28558 .cindex "black list (DNS)"
28559 .cindex "&ACL;" "testing a DNS list"
28560 This condition checks for entries in DNS black lists. These are also known as
28561 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28562 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28563 different variants of this condition to describe briefly here. See sections
28564 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28565
28566 .vitem &*domains&~=&~*&<&'domain&~list'&>
28567 .cindex "&%domains%& ACL condition"
28568 .cindex "domain" "ACL checking"
28569 .cindex "&ACL;" "testing a recipient domain"
28570 .vindex "&$domain_data$&"
28571 This condition is relevant only after a RCPT command. It checks that the domain
28572 of the recipient address is in the domain list. If percent-hack processing is
28573 enabled, it is done before this test is done. If the check succeeds with a
28574 lookup, the result of the lookup is placed in &$domain_data$& until the next
28575 &%domains%& test.
28576
28577 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28578 use &%domains%& in a DATA ACL.
28579
28580
28581 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28582 .cindex "&%encrypted%& ACL condition"
28583 .cindex "encryption" "checking in an ACL"
28584 .cindex "&ACL;" "testing for encryption"
28585 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28586 name of the cipher suite in use is tested against the list. To test for
28587 encryption without testing for any specific cipher suite(s), set
28588 .code
28589 encrypted = *
28590 .endd
28591
28592
28593 .vitem &*hosts&~=&~*&<&'host&~list'&>
28594 .cindex "&%hosts%& ACL condition"
28595 .cindex "host" "ACL checking"
28596 .cindex "&ACL;" "testing the client host"
28597 This condition tests that the calling host matches the host list. If you have
28598 name lookups or wildcarded host names and IP addresses in the same host list,
28599 you should normally put the IP addresses first. For example, you could have:
28600 .code
28601 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28602 .endd
28603 The lookup in this example uses the host name for its key. This is implied by
28604 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28605 and it wouldn't matter which way round you had these two items.)
28606
28607 The reason for the problem with host names lies in the left-to-right way that
28608 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28609 but when it reaches an item that requires a host name, it fails if it cannot
28610 find a host name to compare with the pattern. If the above list is given in the
28611 opposite order, the &%accept%& statement fails for a host whose name cannot be
28612 found, even if its IP address is 10.9.8.7.
28613
28614 If you really do want to do the name check first, and still recognize the IP
28615 address even if the name lookup fails, you can rewrite the ACL like this:
28616 .code
28617 accept hosts = dbm;/etc/friendly/hosts
28618 accept hosts = 10.9.8.7
28619 .endd
28620 The default action on failing to find the host name is to assume that the host
28621 is not in the list, so the first &%accept%& statement fails. The second
28622 statement can then check the IP address.
28623
28624 .vindex "&$host_data$&"
28625 If a &%hosts%& condition is satisfied by means of a lookup, the result
28626 of the lookup is made available in the &$host_data$& variable. This
28627 allows you, for example, to set up a statement like this:
28628 .code
28629 deny  hosts = net-lsearch;/some/file
28630 message = $host_data
28631 .endd
28632 which gives a custom error message for each denied host.
28633
28634 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28635 .cindex "&%local_parts%& ACL condition"
28636 .cindex "local part" "ACL checking"
28637 .cindex "&ACL;" "testing a local part"
28638 .vindex "&$local_part_data$&"
28639 This condition is relevant only after a RCPT command. It checks that the local
28640 part of the recipient address is in the list. If percent-hack processing is
28641 enabled, it is done before this test. If the check succeeds with a lookup, the
28642 result of the lookup is placed in &$local_part_data$&, which remains set until
28643 the next &%local_parts%& test.
28644
28645 .vitem &*malware&~=&~*&<&'option'&>
28646 .cindex "&%malware%& ACL condition"
28647 .cindex "&ACL;" "virus scanning"
28648 .cindex "&ACL;" "scanning for viruses"
28649 This condition is available only when Exim is compiled with the
28650 content-scanning extension. It causes the incoming message to be scanned for
28651 viruses. For details, see chapter &<<CHAPexiscan>>&.
28652
28653 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28654 .cindex "&%mime_regex%& ACL condition"
28655 .cindex "&ACL;" "testing by regex matching"
28656 This condition is available only when Exim is compiled with the
28657 content-scanning extension, and it is allowed only in the ACL defined by
28658 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28659 with any of the regular expressions. For details, see chapter
28660 &<<CHAPexiscan>>&.
28661
28662 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28663 .cindex "rate limiting"
28664 This condition can be used to limit the rate at which a user or host submits
28665 messages. Details are given in section &<<SECTratelimiting>>&.
28666
28667 .vitem &*recipients&~=&~*&<&'address&~list'&>
28668 .cindex "&%recipients%& ACL condition"
28669 .cindex "recipient" "ACL checking"
28670 .cindex "&ACL;" "testing a recipient"
28671 This condition is relevant only after a RCPT command. It checks the entire
28672 recipient address against a list of recipients.
28673
28674 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28675 .cindex "&%regex%& ACL condition"
28676 .cindex "&ACL;" "testing by regex matching"
28677 This condition is available only when Exim is compiled with the
28678 content-scanning extension, and is available only in the DATA, MIME, and
28679 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28680 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28681
28682 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28683 .cindex "&%sender_domains%& ACL condition"
28684 .cindex "sender" "ACL checking"
28685 .cindex "&ACL;" "testing a sender domain"
28686 .vindex "&$domain$&"
28687 .vindex "&$sender_address_domain$&"
28688 This condition tests the domain of the sender of the message against the given
28689 domain list. &*Note*&: The domain of the sender address is in
28690 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28691 of this condition. This is an exception to the general rule for testing domain
28692 lists. It is done this way so that, if this condition is used in an ACL for a
28693 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28694 influence the sender checking.
28695
28696 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28697 relaying, because sender addresses are easily, and commonly, forged.
28698
28699 .vitem &*senders&~=&~*&<&'address&~list'&>
28700 .cindex "&%senders%& ACL condition"
28701 .cindex "sender" "ACL checking"
28702 .cindex "&ACL;" "testing a sender"
28703 This condition tests the sender of the message against the given list. To test
28704 for a bounce message, which has an empty sender, set
28705 .code
28706 senders = :
28707 .endd
28708 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28709 relaying, because sender addresses are easily, and commonly, forged.
28710
28711 .vitem &*spam&~=&~*&<&'username'&>
28712 .cindex "&%spam%& ACL condition"
28713 .cindex "&ACL;" "scanning for spam"
28714 This condition is available only when Exim is compiled with the
28715 content-scanning extension. It causes the incoming message to be scanned by
28716 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28717
28718 .vitem &*verify&~=&~certificate*&
28719 .cindex "&%verify%& ACL condition"
28720 .cindex "TLS" "client certificate verification"
28721 .cindex "certificate" "verification of client"
28722 .cindex "&ACL;" "certificate verification"
28723 .cindex "&ACL;" "testing a TLS certificate"
28724 This condition is true in an SMTP session if the session is encrypted, and a
28725 certificate was received from the client, and the certificate was verified. The
28726 server requests a certificate only if the client matches &%tls_verify_hosts%&
28727 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28728
28729 .vitem &*verify&~=&~csa*&
28730 .cindex "CSA verification"
28731 This condition checks whether the sending host (the client) is authorized to
28732 send email. Details of how this works are given in section
28733 &<<SECTverifyCSA>>&.
28734
28735 .vitem &*verify&~=&~header_names_ascii*&
28736 .cindex "&%verify%& ACL condition"
28737 .cindex "&ACL;" "verifying header names only ASCII"
28738 .cindex "header lines" "verifying header names only ASCII"
28739 .cindex "verifying" "header names only ASCII"
28740 This condition is relevant only in an ACL that is run after a message has been
28741 received, that is, in an ACL specified by &%acl_smtp_data%& or
28742 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28743 there are no non-ASCII characters, also excluding control characters.  The
28744 allowable characters are decimal ASCII values 33 through 126.
28745
28746 Exim itself will handle headers with non-ASCII characters, but it can cause
28747 problems for downstream applications, so this option will allow their
28748 detection and rejection in the DATA ACL's.
28749
28750 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28751 .cindex "&%verify%& ACL condition"
28752 .cindex "&ACL;" "verifying sender in the header"
28753 .cindex "header lines" "verifying the sender in"
28754 .cindex "sender" "verifying in header"
28755 .cindex "verifying" "sender in header"
28756 This condition is relevant only in an ACL that is run after a message has been
28757 received, that is, in an ACL specified by &%acl_smtp_data%& or
28758 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28759 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28760 is loosely thought of as a &"sender"& address (hence the name of the test).
28761 However, an address that appears in one of these headers need not be an address
28762 that accepts bounce messages; only sender addresses in envelopes are required
28763 to accept bounces. Therefore, if you use the callout option on this check, you
28764 might want to arrange for a non-empty address in the MAIL command.
28765
28766 Details of address verification and the options are given later, starting at
28767 section &<<SECTaddressverification>>& (callouts are described in section
28768 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28769 condition to restrict it to bounce messages only:
28770 .code
28771 deny    senders = :
28772         message = A valid sender header is required for bounces
28773        !verify  = header_sender
28774 .endd
28775
28776 .vitem &*verify&~=&~header_syntax*&
28777 .cindex "&%verify%& ACL condition"
28778 .cindex "&ACL;" "verifying header syntax"
28779 .cindex "header lines" "verifying syntax"
28780 .cindex "verifying" "header syntax"
28781 This condition is relevant only in an ACL that is run after a message has been
28782 received, that is, in an ACL specified by &%acl_smtp_data%& or
28783 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28784 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28785 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28786 permitted only in locally generated messages and from hosts that match
28787 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28788 appropriate.
28789
28790 Note that this condition is a syntax check only. However, a common spamming
28791 ploy used to be to send syntactically invalid headers such as
28792 .code
28793 To: @
28794 .endd
28795 and this condition can be used to reject such messages, though they are not as
28796 common as they used to be.
28797
28798 .vitem &*verify&~=&~helo*&
28799 .cindex "&%verify%& ACL condition"
28800 .cindex "&ACL;" "verifying HELO/EHLO"
28801 .cindex "HELO" "verifying"
28802 .cindex "EHLO" "verifying"
28803 .cindex "verifying" "EHLO"
28804 .cindex "verifying" "HELO"
28805 This condition is true if a HELO or EHLO command has been received from the
28806 client host, and its contents have been verified. If there has been no previous
28807 attempt to verify the HELO/EHLO contents, it is carried out when this
28808 condition is encountered. See the description of the &%helo_verify_hosts%& and
28809 &%helo_try_verify_hosts%& options for details of how to request verification
28810 independently of this condition.
28811
28812 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28813 option), this condition is always true.
28814
28815
28816 .vitem &*verify&~=&~not_blind*&
28817 .cindex "verifying" "not blind"
28818 .cindex "bcc recipients, verifying none"
28819 This condition checks that there are no blind (bcc) recipients in the message.
28820 Every envelope recipient must appear either in a &'To:'& header line or in a
28821 &'Cc:'& header line for this condition to be true. Local parts are checked
28822 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28823 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28824 used only in a DATA or non-SMTP ACL.
28825
28826 There are, of course, many legitimate messages that make use of blind (bcc)
28827 recipients. This check should not be used on its own for blocking messages.
28828
28829
28830 .vitem &*verify&~=&~recipient/*&<&'options'&>
28831 .cindex "&%verify%& ACL condition"
28832 .cindex "&ACL;" "verifying recipient"
28833 .cindex "recipient" "verifying"
28834 .cindex "verifying" "recipient"
28835 .vindex "&$address_data$&"
28836 This condition is relevant only after a RCPT command. It verifies the current
28837 recipient. Details of address verification are given later, starting at section
28838 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28839 of &$address_data$& is the last value that was set while routing the address.
28840 This applies even if the verification fails. When an address that is being
28841 verified is redirected to a single address, verification continues with the new
28842 address, and in that case, the subsequent value of &$address_data$& is the
28843 value for the child address.
28844
28845 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
28846 .cindex "&%verify%& ACL condition"
28847 .cindex "&ACL;" "verifying host reverse lookup"
28848 .cindex "host" "verifying reverse lookup"
28849 This condition ensures that a verified host name has been looked up from the IP
28850 address of the client host. (This may have happened already if the host name
28851 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28852 Verification ensures that the host name obtained from a reverse DNS lookup, or
28853 one of its aliases, does, when it is itself looked up in the DNS, yield the
28854 original IP address.
28855
28856 There is one possible option, &`defer_ok`&.  If this is present and a
28857 DNS operation returns a temporary error, the verify condition succeeds.
28858
28859 If this condition is used for a locally generated message (that is, when there
28860 is no client host involved), it always succeeds.
28861
28862 .vitem &*verify&~=&~sender/*&<&'options'&>
28863 .cindex "&%verify%& ACL condition"
28864 .cindex "&ACL;" "verifying sender"
28865 .cindex "sender" "verifying"
28866 .cindex "verifying" "sender"
28867 This condition is relevant only after a MAIL or RCPT command, or after a
28868 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28869 the message's sender is empty (that is, this is a bounce message), the
28870 condition is true. Otherwise, the sender address is verified.
28871
28872 .vindex "&$address_data$&"
28873 .vindex "&$sender_address_data$&"
28874 If there is data in the &$address_data$& variable at the end of routing, its
28875 value is placed in &$sender_address_data$& at the end of verification. This
28876 value can be used in subsequent conditions and modifiers in the same ACL
28877 statement. It does not persist after the end of the current statement. If you
28878 want to preserve the value for longer, you can save it in an ACL variable.
28879
28880 Details of verification are given later, starting at section
28881 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28882 to avoid doing it more than once per message.
28883
28884 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28885 .cindex "&%verify%& ACL condition"
28886 This is a variation of the previous option, in which a modified address is
28887 verified as a sender.
28888 .endlist
28889
28890
28891
28892 .section "Using DNS lists" "SECTmorednslists"
28893 .cindex "DNS list" "in ACL"
28894 .cindex "black list (DNS)"
28895 .cindex "&ACL;" "testing a DNS list"
28896 In its simplest form, the &%dnslists%& condition tests whether the calling host
28897 is on at least one of a number of DNS lists by looking up the inverted IP
28898 address in one or more DNS domains. (Note that DNS list domains are not mail
28899 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28900 special options instead.) For example, if the calling host's IP
28901 address is 192.168.62.43, and the ACL statement is
28902 .code
28903 deny dnslists = blackholes.mail-abuse.org : \
28904                 dialups.mail-abuse.org
28905 .endd
28906 the following records are looked up:
28907 .code
28908 43.62.168.192.blackholes.mail-abuse.org
28909 43.62.168.192.dialups.mail-abuse.org
28910 .endd
28911 As soon as Exim finds an existing DNS record, processing of the list stops.
28912 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28913 to test that a host is on more than one list (an &"and"& conjunction), you can
28914 use two separate conditions:
28915 .code
28916 deny dnslists = blackholes.mail-abuse.org
28917      dnslists = dialups.mail-abuse.org
28918 .endd
28919 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28920 behaves as if the host does not match the list item, that is, as if the DNS
28921 record does not exist. If there are further items in the DNS list, they are
28922 processed.
28923
28924 This is usually the required action when &%dnslists%& is used with &%deny%&
28925 (which is the most common usage), because it prevents a DNS failure from
28926 blocking mail. However, you can change this behaviour by putting one of the
28927 following special items in the list:
28928 .display
28929 &`+include_unknown `&   behave as if the item is on the list
28930 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28931 &`+defer_unknown   `&   give a temporary error
28932 .endd
28933 .cindex "&`+include_unknown`&"
28934 .cindex "&`+exclude_unknown`&"
28935 .cindex "&`+defer_unknown`&"
28936 Each of these applies to any subsequent items on the list. For example:
28937 .code
28938 deny dnslists = +defer_unknown : foo.bar.example
28939 .endd
28940 Testing the list of domains stops as soon as a match is found. If you want to
28941 warn for one list and block for another, you can use two different statements:
28942 .code
28943 deny  dnslists = blackholes.mail-abuse.org
28944 warn  message  = X-Warn: sending host is on dialups list
28945       dnslists = dialups.mail-abuse.org
28946 .endd
28947 DNS list lookups are cached by Exim for the duration of the SMTP session,
28948 so a lookup based on the IP address is done at most once for any incoming
28949 connection. Exim does not share information between multiple incoming
28950 connections (but your local name server cache should be active).
28951
28952
28953
28954 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28955 .cindex "DNS list" "keyed by explicit IP address"
28956 By default, the IP address that is used in a DNS list lookup is the IP address
28957 of the calling host. However, you can specify another IP address by listing it
28958 after the domain name, introduced by a slash. For example:
28959 .code
28960 deny dnslists = black.list.tld/192.168.1.2
28961 .endd
28962 This feature is not very helpful with explicit IP addresses; it is intended for
28963 use with IP addresses that are looked up, for example, the IP addresses of the
28964 MX hosts or nameservers of an email sender address. For an example, see section
28965 &<<SECTmulkeyfor>>& below.
28966
28967
28968
28969
28970 .section "DNS lists keyed on domain names" "SECID202"
28971 .cindex "DNS list" "keyed by domain name"
28972 There are some lists that are keyed on domain names rather than inverted IP
28973 addresses (see for example the &'domain based zones'& link at
28974 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28975 with these lists. You can change the name that is looked up in a DNS list by
28976 listing it after the domain name, introduced by a slash. For example,
28977 .code
28978 deny  message  = Sender's domain is listed at $dnslist_domain
28979       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28980 .endd
28981 This particular example is useful only in ACLs that are obeyed after the
28982 RCPT or DATA commands, when a sender address is available. If (for
28983 example) the message's sender is &'user@tld.example'& the name that is looked
28984 up by this example is
28985 .code
28986 tld.example.dsn.rfc-ignorant.org
28987 .endd
28988 A single &%dnslists%& condition can contain entries for both names and IP
28989 addresses. For example:
28990 .code
28991 deny dnslists = sbl.spamhaus.org : \
28992                 dsn.rfc-ignorant.org/$sender_address_domain
28993 .endd
28994 The first item checks the sending host's IP address; the second checks a domain
28995 name. The whole condition is true if either of the DNS lookups succeeds.
28996
28997
28998
28999
29000 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29001 .cindex "DNS list" "multiple keys for"
29002 The syntax described above for looking up explicitly-defined values (either
29003 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29004 name for the DNS list, what follows the slash can in fact be a list of items.
29005 As with all lists in Exim, the default separator is a colon. However, because
29006 this is a sublist within the list of DNS blacklist domains, it is necessary
29007 either to double the separators like this:
29008 .code
29009 dnslists = black.list.tld/name.1::name.2
29010 .endd
29011 or to change the separator character, like this:
29012 .code
29013 dnslists = black.list.tld/<;name.1;name.2
29014 .endd
29015 If an item in the list is an IP address, it is inverted before the DNS
29016 blacklist domain is appended. If it is not an IP address, no inversion
29017 occurs. Consider this condition:
29018 .code
29019 dnslists = black.list.tld/<;192.168.1.2;a.domain
29020 .endd
29021 The DNS lookups that occur are:
29022 .code
29023 2.1.168.192.black.list.tld
29024 a.domain.black.list.tld
29025 .endd
29026 Once a DNS record has been found (that matches a specific IP return
29027 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29028 are done. If there is a temporary DNS error, the rest of the sublist of domains
29029 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29030 only if no other DNS lookup in this sublist succeeds. In other words, a
29031 successful lookup for any of the items in the sublist overrides a temporary
29032 error for a previous item.
29033
29034 The ability to supply a list of items after the slash is in some sense just a
29035 syntactic convenience. These two examples have the same effect:
29036 .code
29037 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29038 dnslists = black.list.tld/a.domain::b.domain
29039 .endd
29040 However, when the data for the list is obtained from a lookup, the second form
29041 is usually much more convenient. Consider this example:
29042 .code
29043 deny message  = The mail servers for the domain \
29044                 $sender_address_domain \
29045                 are listed at $dnslist_domain ($dnslist_value); \
29046                 see $dnslist_text.
29047      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29048                                    ${lookup dnsdb {>|mxh=\
29049                                    $sender_address_domain} }} }
29050 .endd
29051 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29052 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29053 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29054 of expanding the condition might be something like this:
29055 .code
29056 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29057 .endd
29058 Thus, this example checks whether or not the IP addresses of the sender
29059 domain's mail servers are on the Spamhaus black list.
29060
29061 The key that was used for a successful DNS list lookup is put into the variable
29062 &$dnslist_matched$& (see section &<<SECID204>>&).
29063
29064
29065
29066
29067 .section "Data returned by DNS lists" "SECID203"
29068 .cindex "DNS list" "data returned from"
29069 DNS lists are constructed using address records in the DNS. The original RBL
29070 just used the address 127.0.0.1 on the right hand side of each record, but the
29071 RBL+ list and some other lists use a number of values with different meanings.
29072 The values used on the RBL+ list are:
29073 .display
29074 127.1.0.1  RBL
29075 127.1.0.2  DUL
29076 127.1.0.3  DUL and RBL
29077 127.1.0.4  RSS
29078 127.1.0.5  RSS and RBL
29079 127.1.0.6  RSS and DUL
29080 127.1.0.7  RSS and DUL and RBL
29081 .endd
29082 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29083 different values. Some DNS lists may return more than one address record;
29084 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29085
29086
29087 .section "Variables set from DNS lists" "SECID204"
29088 .cindex "expansion" "variables, set from DNS list"
29089 .cindex "DNS list" "variables set from"
29090 .vindex "&$dnslist_domain$&"
29091 .vindex "&$dnslist_matched$&"
29092 .vindex "&$dnslist_text$&"
29093 .vindex "&$dnslist_value$&"
29094 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29095 the name of the overall domain that matched (for example,
29096 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29097 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29098 the DNS record. When the key is an IP address, it is not reversed in
29099 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29100 cases, for example:
29101 .code
29102 deny dnslists = spamhaus.example
29103 .endd
29104 the key is also available in another variable (in this case,
29105 &$sender_host_address$&). In more complicated cases, however, this is not true.
29106 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29107 might generate a dnslists lookup like this:
29108 .code
29109 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29110 .endd
29111 If this condition succeeds, the value in &$dnslist_matched$& might be
29112 &`192.168.6.7`& (for example).
29113
29114 If more than one address record is returned by the DNS lookup, all the IP
29115 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29116 The variable &$dnslist_text$& contains the contents of any associated TXT
29117 record. For lists such as RBL+ the TXT record for a merged entry is often not
29118 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29119 information.
29120
29121 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29122 &-- although these appear before the condition in the ACL, they are not
29123 expanded until after it has failed. For example:
29124 .code
29125 deny    hosts = !+local_networks
29126         message = $sender_host_address is listed \
29127                   at $dnslist_domain
29128         dnslists = rbl-plus.mail-abuse.example
29129 .endd
29130
29131
29132
29133 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29134 .cindex "DNS list" "matching specific returned data"
29135 You can add an equals sign and an IP address after a &%dnslists%& domain name
29136 in order to restrict its action to DNS records with a matching right hand side.
29137 For example,
29138 .code
29139 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29140 .endd
29141 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29142 any address record is considered to be a match. For the moment, we assume
29143 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29144 describes how multiple records are handled.
29145
29146 More than one IP address may be given for checking, using a comma as a
29147 separator. These are alternatives &-- if any one of them matches, the
29148 &%dnslists%& condition is true. For example:
29149 .code
29150 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29151 .endd
29152 If you want to specify a constraining address list and also specify names or IP
29153 addresses to be looked up, the constraining address list must be specified
29154 first. For example:
29155 .code
29156 deny dnslists = dsn.rfc-ignorant.org\
29157                 =127.0.0.2/$sender_address_domain
29158 .endd
29159
29160 If the character &`&&`& is used instead of &`=`&, the comparison for each
29161 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29162 In other words, the listed addresses are used as bit masks. The comparison is
29163 true if all the bits in the mask are present in the address that is being
29164 tested. For example:
29165 .code
29166 dnslists = a.b.c&0.0.0.3
29167 .endd
29168 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29169 want to test whether one bit or another bit is present (as opposed to both
29170 being present), you must use multiple values. For example:
29171 .code
29172 dnslists = a.b.c&0.0.0.1,0.0.0.2
29173 .endd
29174 matches if the final component of the address is an odd number or two times
29175 an odd number.
29176
29177
29178
29179 .section "Negated DNS matching conditions" "SECID205"
29180 You can supply a negative list of IP addresses as part of a &%dnslists%&
29181 condition. Whereas
29182 .code
29183 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29184 .endd
29185 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29186 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29187 .code
29188 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29189 .endd
29190 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29191 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29192 words, the result of the test is inverted if an exclamation mark appears before
29193 the &`=`& (or the &`&&`&) sign.
29194
29195 &*Note*&: This kind of negation is not the same as negation in a domain,
29196 host, or address list (which is why the syntax is different).
29197
29198 If you are using just one list, the negation syntax does not gain you much. The
29199 previous example is precisely equivalent to
29200 .code
29201 deny  dnslists = a.b.c
29202      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29203 .endd
29204 However, if you are using multiple lists, the negation syntax is clearer.
29205 Consider this example:
29206 .code
29207 deny  dnslists = sbl.spamhaus.org : \
29208                  list.dsbl.org : \
29209                  dnsbl.njabl.org!=127.0.0.3 : \
29210                  relays.ordb.org
29211 .endd
29212 Using only positive lists, this would have to be:
29213 .code
29214 deny  dnslists = sbl.spamhaus.org : \
29215                  list.dsbl.org
29216 deny  dnslists = dnsbl.njabl.org
29217      !dnslists = dnsbl.njabl.org=127.0.0.3
29218 deny  dnslists = relays.ordb.org
29219 .endd
29220 which is less clear, and harder to maintain.
29221
29222
29223
29224
29225 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29226 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29227 thereby providing more than one IP address. When an item in a &%dnslists%& list
29228 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29229 the match to specific results from the DNS lookup, there are two ways in which
29230 the checking can be handled. For example, consider the condition:
29231 .code
29232 dnslists = a.b.c=127.0.0.1
29233 .endd
29234 What happens if the DNS lookup for the incoming IP address yields both
29235 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29236 condition true because at least one given value was found, or is it false
29237 because at least one of the found values was not listed? And how does this
29238 affect negated conditions? Both possibilities are provided for with the help of
29239 additional separators &`==`& and &`=&&`&.
29240
29241 .ilist
29242 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29243 IP addresses matches one of the listed addresses. For the example above, the
29244 condition is true because 127.0.0.1 matches.
29245 .next
29246 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29247 looked up IP addresses matches one of the listed addresses. If the condition is
29248 changed to:
29249 .code
29250 dnslists = a.b.c==127.0.0.1
29251 .endd
29252 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29253 false because 127.0.0.2 is not listed. You would need to have:
29254 .code
29255 dnslists = a.b.c==127.0.0.1,127.0.0.2
29256 .endd
29257 for the condition to be true.
29258 .endlist
29259
29260 When &`!`& is used to negate IP address matching, it inverts the result, giving
29261 the precise opposite of the behaviour above. Thus:
29262 .ilist
29263 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29264 addresses matches one of the listed addresses. Consider:
29265 .code
29266 dnslists = a.b.c!&0.0.0.1
29267 .endd
29268 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29269 false because 127.0.0.1 matches.
29270 .next
29271 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29272 looked up IP address that does not match. Consider:
29273 .code
29274 dnslists = a.b.c!=&0.0.0.1
29275 .endd
29276 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29277 true, because 127.0.0.2 does not match. You would need to have:
29278 .code
29279 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29280 .endd
29281 for the condition to be false.
29282 .endlist
29283 When the DNS lookup yields only a single IP address, there is no difference
29284 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29285
29286
29287
29288
29289 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29290 .cindex "DNS list" "information from merged"
29291 When the facility for restricting the matching IP values in a DNS list is used,
29292 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29293 the true reason for rejection. This happens when lists are merged and the IP
29294 address in the A record is used to distinguish them; unfortunately there is
29295 only one TXT record. One way round this is not to use merged lists, but that
29296 can be inefficient because it requires multiple DNS lookups where one would do
29297 in the vast majority of cases when the host of interest is not on any of the
29298 lists.
29299
29300 A less inefficient way of solving this problem is available. If
29301 two domain names, comma-separated, are given, the second is used first to
29302 do an initial check, making use of any IP value restrictions that are set.
29303 If there is a match, the first domain is used, without any IP value
29304 restrictions, to get the TXT record. As a byproduct of this, there is also
29305 a check that the IP being tested is indeed on the first list. The first
29306 domain is the one that is put in &$dnslist_domain$&. For example:
29307 .code
29308 reject message  = \
29309          rejected because $sender_host_address is blacklisted \
29310          at $dnslist_domain\n$dnslist_text
29311        dnslists = \
29312          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29313          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29314 .endd
29315 For the first blacklist item, this starts by doing a lookup in
29316 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29317 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29318 value, and as long as something is found, it looks for the corresponding TXT
29319 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29320 The second blacklist item is processed similarly.
29321
29322 If you are interested in more than one merged list, the same list must be
29323 given several times, but because the results of the DNS lookups are cached,
29324 the DNS calls themselves are not repeated. For example:
29325 .code
29326 reject dnslists = \
29327          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29328          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29329          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29330          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29331 .endd
29332 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29333 values matches (or if no record is found), this is the only lookup that is
29334 done. Only if there is a match is one of the more specific lists consulted.
29335
29336
29337
29338 .section "DNS lists and IPv6" "SECTmorednslistslast"
29339 .cindex "IPv6" "DNS black lists"
29340 .cindex "DNS list" "IPv6 usage"
29341 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29342 nibble by nibble. For example, if the calling host's IP address is
29343 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29344 .code
29345 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29346   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29347 .endd
29348 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29349 lists contain wildcard records, intended for IPv4, that interact badly with
29350 IPv6. For example, the DNS entry
29351 .code
29352 *.3.some.list.example.    A    127.0.0.1
29353 .endd
29354 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29355 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29356
29357 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29358 &%condition%& condition, as in this example:
29359 .code
29360 deny   condition = ${if isip4{$sender_host_address}}
29361        dnslists  = some.list.example
29362 .endd
29363
29364 If an explicit key is being used for a DNS lookup and it may be an IPv6
29365 address you should specify alternate list separators for both the outer
29366 (DNS list name) list and inner (lookup keys) list:
29367 .code
29368        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29369 .endd
29370
29371 .section "Rate limiting incoming messages" "SECTratelimiting"
29372 .cindex "rate limiting" "client sending"
29373 .cindex "limiting client sending rates"
29374 .oindex "&%smtp_ratelimit_*%&"
29375 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29376 which clients can send email. This is more powerful than the
29377 &%smtp_ratelimit_*%& options, because those options control the rate of
29378 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29379 works across all connections (concurrent and sequential) from the same client
29380 host. The syntax of the &%ratelimit%& condition is:
29381 .display
29382 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29383 .endd
29384 If the average client sending rate is less than &'m'& messages per time
29385 period &'p'& then the condition is false; otherwise it is true.
29386
29387 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29388 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29389 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29390 of &'p'&.
29391
29392 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29393 time interval, for example, &`8h`& for eight hours. A larger time constant
29394 means that it takes Exim longer to forget a client's past behaviour. The
29395 parameter &'m'& is the maximum number of messages that a client is permitted to
29396 send in each time interval. It also specifies the number of messages permitted
29397 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29398 constant, you can allow a client to send more messages in a burst without
29399 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29400 both small, messages must be sent at an even rate.
29401
29402 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29403 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29404 when deploying the &%ratelimit%& ACL condition. The script prints usage
29405 instructions when it is run with no arguments.
29406
29407 The key is used to look up the data for calculating the client's average
29408 sending rate. This data is stored in Exim's spool directory, alongside the
29409 retry and other hints databases. The default key is &$sender_host_address$&,
29410 which means Exim computes the sending rate of each client host IP address.
29411 By changing the key you can change how Exim identifies clients for the purpose
29412 of ratelimiting. For example, to limit the sending rate of each authenticated
29413 user, independent of the computer they are sending from, set the key to
29414 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29415 example, &$authenticated_id$& is only meaningful if the client has
29416 authenticated (which you can check with the &%authenticated%& ACL condition).
29417
29418 The lookup key does not have to identify clients: If you want to limit the
29419 rate at which a recipient receives messages, you can use the key
29420 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29421 ACL.
29422
29423 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29424 specifies what Exim measures the rate of, for example messages or recipients
29425 or bytes. You can adjust the measurement using the &%unique=%& and/or
29426 &%count=%& options. You can also control when Exim updates the recorded rate
29427 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29428 separated by a slash, like the other parameters. They may appear in any order.
29429
29430 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29431 any options that alter the meaning of the stored data. The limit &'m'& is not
29432 stored, so you can alter the configured maximum rate and Exim will still
29433 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29434 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29435 behaviour. The lookup key is not affected by changes to the update mode and
29436 the &%count=%& option.
29437
29438
29439 .section "Ratelimit options for what is being measured" "ratoptmea"
29440 .cindex "rate limiting" "per_* options"
29441 The &%per_conn%& option limits the client's connection rate. It is not
29442 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29443 &%acl_not_smtp_start%& ACLs.
29444
29445 The &%per_mail%& option limits the client's rate of sending messages. This is
29446 the default if none of the &%per_*%& options is specified. It can be used in
29447 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29448 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29449
29450 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29451 the same ACLs as the &%per_mail%& option, though it is best to use this option
29452 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29453 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29454 in its MAIL command, which may be inaccurate or completely missing. You can
29455 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29456 in kilobytes, megabytes, or gigabytes, respectively.
29457
29458 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29459 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29460 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29461 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29462 ACLs the rate is updated with the total recipient count in one go. Note that
29463 in either case the rate limiting engine will see a message with many
29464 recipients as a large high-speed burst.
29465
29466 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29467 number of different recipients that the client has sent messages to in the
29468 last time period. That is, if the client repeatedly sends messages to the same
29469 recipient, its measured rate is not increased. This option can only be used in
29470 &%acl_smtp_rcpt%&.
29471
29472 The &%per_cmd%& option causes Exim to recompute the rate every time the
29473 condition is processed. This can be used to limit the rate of any SMTP
29474 command. If it is used in multiple ACLs it can limit the aggregate rate of
29475 multiple different commands.
29476
29477 The &%count=%& option can be used to alter how much Exim adds to the client's
29478 measured rate. For example, the &%per_byte%& option is equivalent to
29479 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29480 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29481 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29482
29483 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29484
29485
29486 .section "Ratelimit update modes" "ratoptupd"
29487 .cindex "rate limiting" "reading data without updating"
29488 You can specify one of three options with the &%ratelimit%& condition to
29489 control when its database is updated. This section describes the &%readonly%&
29490 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29491
29492 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29493 previously-computed rate to check against the limit.
29494
29495 For example, you can test the client's sending rate and deny it access (when
29496 it is too fast) in the connect ACL. If the client passes this check then it
29497 can go on to send a message, in which case its recorded rate will be updated
29498 in the MAIL ACL. Subsequent connections from the same client will check this
29499 new rate.
29500 .code
29501 acl_check_connect:
29502  deny ratelimit = 100 / 5m / readonly
29503     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29504                   (max $sender_rate_limit)
29505 # ...
29506 acl_check_mail:
29507  warn ratelimit = 100 / 5m / strict
29508     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29509                   (max $sender_rate_limit)
29510 .endd
29511
29512 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29513 processing a message then it may increase the client's measured rate more than
29514 it should. For example, this will happen if you check the &%per_rcpt%& option
29515 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29516 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29517 multiple update problems by using the &%readonly%& option on later ratelimit
29518 checks.
29519
29520 The &%per_*%& options described above do not make sense in some ACLs. If you
29521 use a &%per_*%& option in an ACL where it is not normally permitted then the
29522 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29523 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29524 next section) so you must specify the &%readonly%& option explicitly.
29525
29526
29527 .section "Ratelimit options for handling fast clients" "ratoptfast"
29528 .cindex "rate limiting" "strict and leaky modes"
29529 If a client's average rate is greater than the maximum, the rate limiting
29530 engine can react in two possible ways, depending on the presence of the
29531 &%strict%& or &%leaky%& update modes. This is independent of the other
29532 counter-measures (such as rejecting the message) that may be specified by the
29533 rest of the ACL.
29534
29535 The &%leaky%& (default) option means that the client's recorded rate is not
29536 updated if it is above the limit. The effect of this is that Exim measures the
29537 client's average rate of successfully sent email, which cannot be greater than
29538 the maximum allowed. If the client is over the limit it may suffer some
29539 counter-measures (as specified in the ACL), but it will still be able to send
29540 email at the configured maximum rate, whatever the rate of its attempts. This
29541 is generally the better choice if you have clients that retry automatically.
29542 For example, it does not prevent a sender with an over-aggressive retry rate
29543 from getting any email through.
29544
29545 The &%strict%& option means that the client's recorded rate is always
29546 updated. The effect of this is that Exim measures the client's average rate
29547 of attempts to send email, which can be much higher than the maximum it is
29548 actually allowed. If the client is over the limit it may be subjected to
29549 counter-measures by the ACL. It must slow down and allow sufficient time to
29550 pass that its computed rate falls below the maximum before it can send email
29551 again. The time (the number of smoothing periods) it must wait and not
29552 attempt to send mail can be calculated with this formula:
29553 .code
29554         ln(peakrate/maxrate)
29555 .endd
29556
29557
29558 .section "Limiting the rate of different events" "ratoptuniq"
29559 .cindex "rate limiting" "counting unique events"
29560 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29561 rate of different events. For example, the &%per_addr%& option uses this
29562 mechanism to count the number of different recipients that the client has
29563 sent messages to in the last time period; it is equivalent to
29564 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29565 measure the rate that a client uses different sender addresses with the
29566 options &`per_mail/unique=$sender_address`&.
29567
29568 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29569 has seen for that key. The whole set is thrown away when it is older than the
29570 rate smoothing period &'p'&, so each different event is counted at most once
29571 per period. In the &%leaky%& update mode, an event that causes the client to
29572 go over the limit is not added to the set, in the same way that the client's
29573 recorded rate is not updated in the same situation.
29574
29575 When you combine the &%unique=%& and &%readonly%& options, the specific
29576 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29577 rate.
29578
29579 The &%unique=%& mechanism needs more space in the ratelimit database than the
29580 other &%ratelimit%& options in order to store the event set. The number of
29581 unique values is potentially as large as the rate limit, so the extra space
29582 required increases with larger limits.
29583
29584 The uniqueification is not perfect: there is a small probability that Exim
29585 will think a new event has happened before. If the sender's rate is less than
29586 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29587 the measured rate can go above the limit, in which case Exim may under-count
29588 events by a significant margin. Fortunately, if the rate is high enough (2.7
29589 times the limit) that the false positive rate goes above 9%, then Exim will
29590 throw away the over-full event set before the measured rate falls below the
29591 limit. Therefore the only harm should be that exceptionally high sending rates
29592 are logged incorrectly; any countermeasures you configure will be as effective
29593 as intended.
29594
29595
29596 .section "Using rate limiting" "useratlim"
29597 Exim's other ACL facilities are used to define what counter-measures are taken
29598 when the rate limit is exceeded. This might be anything from logging a warning
29599 (for example, while measuring existing sending rates in order to define
29600 policy), through time delays to slow down fast senders, up to rejecting the
29601 message. For example:
29602 .code
29603 # Log all senders' rates
29604 warn ratelimit = 0 / 1h / strict
29605      log_message = Sender rate $sender_rate / $sender_rate_period
29606
29607 # Slow down fast senders; note the need to truncate $sender_rate
29608 # at the decimal point.
29609 warn ratelimit = 100 / 1h / per_rcpt / strict
29610      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29611                    $sender_rate_limit }s
29612
29613 # Keep authenticated users under control
29614 deny authenticated = *
29615      ratelimit = 100 / 1d / strict / $authenticated_id
29616
29617 # System-wide rate limit
29618 defer message = Sorry, too busy. Try again later.
29619      ratelimit = 10 / 1s / $primary_hostname
29620
29621 # Restrict incoming rate from each host, with a default
29622 # set using a macro and special cases looked up in a table.
29623 defer message = Sender rate exceeds $sender_rate_limit \
29624                messages per $sender_rate_period
29625      ratelimit = ${lookup {$sender_host_address} \
29626                    cdb {DB/ratelimits.cdb} \
29627                    {$value} {RATELIMIT} }
29628 .endd
29629 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29630 especially with the &%per_rcpt%& option, you may suffer from a performance
29631 bottleneck caused by locking on the ratelimit hints database. Apart from
29632 making your ACLs less complicated, you can reduce the problem by using a
29633 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29634 this means that Exim will lose its hints data after a reboot (including retry
29635 hints, the callout cache, and ratelimit data).
29636
29637
29638
29639 .section "Address verification" "SECTaddressverification"
29640 .cindex "verifying address" "options for"
29641 .cindex "policy control" "address verification"
29642 Several of the &%verify%& conditions described in section
29643 &<<SECTaclconditions>>& cause addresses to be verified. Section
29644 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29645 The verification conditions can be followed by options that modify the
29646 verification process. The options are separated from the keyword and from each
29647 other by slashes, and some of them contain parameters. For example:
29648 .code
29649 verify = sender/callout
29650 verify = recipient/defer_ok/callout=10s,defer_ok
29651 .endd
29652 The first stage of address verification, which always happens, is to run the
29653 address through the routers, in &"verify mode"&. Routers can detect the
29654 difference between verification and routing for delivery, and their actions can
29655 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29656 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29657 The available options are as follows:
29658
29659 .ilist
29660 If the &%callout%& option is specified, successful routing to one or more
29661 remote hosts is followed by a &"callout"& to those hosts as an additional
29662 check. Callouts and their sub-options are discussed in the next section.
29663 .next
29664 If there is a defer error while doing verification routing, the ACL
29665 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29666 options, the condition is forced to be true instead. Note that this is a main
29667 verification option as well as a suboption for callouts.
29668 .next
29669 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29670 discusses the reporting of sender address verification failures.
29671 .next
29672 The &%success_on_redirect%& option causes verification always to succeed
29673 immediately after a successful redirection. By default, if a redirection
29674 generates just one address, that address is also verified. See further
29675 discussion in section &<<SECTredirwhilveri>>&.
29676 .endlist
29677
29678 .cindex "verifying address" "differentiating failures"
29679 .vindex "&$recipient_verify_failure$&"
29680 .vindex "&$sender_verify_failure$&"
29681 .vindex "&$acl_verify_message$&"
29682 After an address verification failure, &$acl_verify_message$& contains the
29683 error message that is associated with the failure. It can be preserved by
29684 coding like this:
29685 .code
29686 warn  !verify = sender
29687        set acl_m0 = $acl_verify_message
29688 .endd
29689 If you are writing your own custom rejection message or log message when
29690 denying access, you can use this variable to include information about the
29691 verification failure.
29692
29693 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29694 appropriate) contains one of the following words:
29695
29696 .ilist
29697 &%qualify%&: The address was unqualified (no domain), and the message
29698 was neither local nor came from an exempted host.
29699 .next
29700 &%route%&: Routing failed.
29701 .next
29702 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29703 occurred at or before the MAIL command (that is, on initial
29704 connection, HELO, or MAIL).
29705 .next
29706 &%recipient%&: The RCPT command in a callout was rejected.
29707 .next
29708 &%postmaster%&: The postmaster check in a callout was rejected.
29709 .endlist
29710
29711 The main use of these variables is expected to be to distinguish between
29712 rejections of MAIL and rejections of RCPT in callouts.
29713
29714
29715
29716
29717 .section "Callout verification" "SECTcallver"
29718 .cindex "verifying address" "by callout"
29719 .cindex "callout" "verification"
29720 .cindex "SMTP" "callout verification"
29721 For non-local addresses, routing verifies the domain, but is unable to do any
29722 checking of the local part. There are situations where some means of verifying
29723 the local part is desirable. One way this can be done is to make an SMTP
29724 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29725 a subsequent host for a recipient address, to see if the host accepts the
29726 address. We use the term &'callout'& to cover both cases. Note that for a
29727 sender address, the callback is not to the client host that is trying to
29728 deliver the message, but to one of the hosts that accepts incoming mail for the
29729 sender's domain.
29730
29731 Exim does not do callouts by default. If you want them to happen, you must
29732 request them by setting appropriate options on the &%verify%& condition, as
29733 described below. This facility should be used with care, because it can add a
29734 lot of resource usage to the cost of verifying an address. However, Exim does
29735 cache the results of callouts, which helps to reduce the cost. Details of
29736 caching are in section &<<SECTcallvercache>>&.
29737
29738 Recipient callouts are usually used only between hosts that are controlled by
29739 the same administration. For example, a corporate gateway host could use
29740 callouts to check for valid recipients on an internal mailserver. A successful
29741 callout does not guarantee that a real delivery to the address would succeed;
29742 on the other hand, a failing callout does guarantee that a delivery would fail.
29743
29744 If the &%callout%& option is present on a condition that verifies an address, a
29745 second stage of verification occurs if the address is successfully routed to
29746 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29747 &(manualroute)& router, where the router specifies the hosts. However, if a
29748 router that does not set up hosts routes to an &(smtp)& transport with a
29749 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29750 &%hosts_override%& set, its hosts are always used, whether or not the router
29751 supplies a host list.
29752 Callouts are only supported on &(smtp)& transports.
29753
29754 The port that is used is taken from the transport, if it is specified and is a
29755 remote transport. (For routers that do verification only, no transport need be
29756 specified.) Otherwise, the default SMTP port is used. If a remote transport
29757 specifies an outgoing interface, this is used; otherwise the interface is not
29758 specified. Likewise, the text that is used for the HELO command is taken from
29759 the transport's &%helo_data%& option; if there is no transport, the value of
29760 &$smtp_active_hostname$& is used.
29761
29762 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29763 test whether a bounce message could be delivered to the sender address. The
29764 following SMTP commands are sent:
29765 .display
29766 &`HELO `&<&'local host name'&>
29767 &`MAIL FROM:<>`&
29768 &`RCPT TO:`&<&'the address to be tested'&>
29769 &`QUIT`&
29770 .endd
29771 LHLO is used instead of HELO if the transport's &%protocol%& option is
29772 set to &"lmtp"&.
29773
29774 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29775 settings.
29776
29777 A recipient callout check is similar. By default, it also uses an empty address
29778 for the sender. This default is chosen because most hosts do not make use of
29779 the sender address when verifying a recipient. Using the same address means
29780 that a single cache entry can be used for each recipient. Some sites, however,
29781 do make use of the sender address when verifying. These are catered for by the
29782 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29783
29784 If the response to the RCPT command is a 2&'xx'& code, the verification
29785 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29786 Exim tries the next host, if any. If there is a problem with all the remote
29787 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29788 &%callout%& option is given, in which case the condition is forced to succeed.
29789
29790 .cindex "SMTP" "output flushing, disabling for callout"
29791 A callout may take a little time. For this reason, Exim normally flushes SMTP
29792 output before performing a callout in an ACL, to avoid unexpected timeouts in
29793 clients when the SMTP PIPELINING extension is in use. The flushing can be
29794 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29795
29796
29797
29798
29799 .section "Additional parameters for callouts" "CALLaddparcall"
29800 .cindex "callout" "additional parameters for"
29801 The &%callout%& option can be followed by an equals sign and a number of
29802 optional parameters, separated by commas. For example:
29803 .code
29804 verify = recipient/callout=10s,defer_ok
29805 .endd
29806 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29807 separate verify options, is retained for backwards compatibility, but is now
29808 deprecated. The additional parameters for &%callout%& are as follows:
29809
29810
29811 .vlist
29812 .vitem <&'a&~time&~interval'&>
29813 .cindex "callout" "timeout, specifying"
29814 This specifies the timeout that applies for the callout attempt to each host.
29815 For example:
29816 .code
29817 verify = sender/callout=5s
29818 .endd
29819 The default is 30 seconds. The timeout is used for each response from the
29820 remote host. It is also used for the initial connection, unless overridden by
29821 the &%connect%& parameter.
29822
29823
29824 .vitem &*connect&~=&~*&<&'time&~interval'&>
29825 .cindex "callout" "connection timeout, specifying"
29826 This parameter makes it possible to set a different (usually smaller) timeout
29827 for making the SMTP connection. For example:
29828 .code
29829 verify = sender/callout=5s,connect=1s
29830 .endd
29831 If not specified, this timeout defaults to the general timeout value.
29832
29833 .vitem &*defer_ok*&
29834 .cindex "callout" "defer, action on"
29835 When this parameter is present, failure to contact any host, or any other kind
29836 of temporary error, is treated as success by the ACL. However, the cache is not
29837 updated in this circumstance.
29838
29839 .vitem &*fullpostmaster*&
29840 .cindex "callout" "full postmaster check"
29841 This operates like the &%postmaster%& option (see below), but if the check for
29842 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29843 accordance with the specification in RFC 2821. The RFC states that the
29844 unqualified address &'postmaster'& should be accepted.
29845
29846
29847 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29848 .cindex "callout" "sender when verifying header"
29849 When verifying addresses in header lines using the &%header_sender%&
29850 verification option, Exim behaves by default as if the addresses are envelope
29851 sender addresses from a message. Callout verification therefore tests to see
29852 whether a bounce message could be delivered, by using an empty address in the
29853 MAIL command. However, it is arguable that these addresses might never be used
29854 as envelope senders, and could therefore justifiably reject bounce messages
29855 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29856 address to use in the MAIL command. For example:
29857 .code
29858 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29859 .endd
29860 This parameter is available only for the &%header_sender%& verification option.
29861
29862
29863 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29864 .cindex "callout" "overall timeout, specifying"
29865 This parameter sets an overall timeout for performing a callout verification.
29866 For example:
29867 .code
29868 verify = sender/callout=5s,maxwait=30s
29869 .endd
29870 This timeout defaults to four times the callout timeout for individual SMTP
29871 commands. The overall timeout applies when there is more than one host that can
29872 be tried. The timeout is checked before trying the next host. This prevents
29873 very long delays if there are a large number of hosts and all are timing out
29874 (for example, when network connections are timing out).
29875
29876
29877 .vitem &*no_cache*&
29878 .cindex "callout" "cache, suppressing"
29879 .cindex "caching callout, suppressing"
29880 When this parameter is given, the callout cache is neither read nor updated.
29881
29882 .vitem &*postmaster*&
29883 .cindex "callout" "postmaster; checking"
29884 When this parameter is set, a successful callout check is followed by a similar
29885 check for the local part &'postmaster'& at the same domain. If this address is
29886 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29887 the postmaster check is recorded in a cache record; if it is a failure, this is
29888 used to fail subsequent callouts for the domain without a connection being
29889 made, until the cache record expires.
29890
29891 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29892 The postmaster check uses an empty sender in the MAIL command by default.
29893 You can use this parameter to do a postmaster check using a different address.
29894 For example:
29895 .code
29896 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29897 .endd
29898 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29899 one overrides. The &%postmaster%& parameter is equivalent to this example:
29900 .code
29901 require  verify = sender/callout=postmaster_mailfrom=
29902 .endd
29903 &*Warning*&: The caching arrangements for postmaster checking do not take
29904 account of the sender address. It is assumed that either the empty address or
29905 a fixed non-empty address will be used. All that Exim remembers is that the
29906 postmaster check for the domain succeeded or failed.
29907
29908
29909 .vitem &*random*&
29910 .cindex "callout" "&""random""& check"
29911 When this parameter is set, before doing the normal callout check, Exim does a
29912 check for a &"random"& local part at the same domain. The local part is not
29913 really random &-- it is defined by the expansion of the option
29914 &%callout_random_local_part%&, which defaults to
29915 .code
29916 $primary_hostname-$tod_epoch-testing
29917 .endd
29918 The idea here is to try to determine whether the remote host accepts all local
29919 parts without checking. If it does, there is no point in doing callouts for
29920 specific local parts. If the &"random"& check succeeds, the result is saved in
29921 a cache record, and used to force the current and subsequent callout checks to
29922 succeed without a connection being made, until the cache record expires.
29923
29924 .vitem &*use_postmaster*&
29925 .cindex "callout" "sender for recipient check"
29926 This parameter applies to recipient callouts only. For example:
29927 .code
29928 deny  !verify = recipient/callout=use_postmaster
29929 .endd
29930 .vindex "&$qualify_domain$&"
29931 It causes a non-empty postmaster address to be used in the MAIL command when
29932 performing the callout for the recipient, and also for a &"random"& check if
29933 that is configured. The local part of the address is &`postmaster`& and the
29934 domain is the contents of &$qualify_domain$&.
29935
29936 .vitem &*use_sender*&
29937 This option applies to recipient callouts only. For example:
29938 .code
29939 require  verify = recipient/callout=use_sender
29940 .endd
29941 It causes the message's actual sender address to be used in the MAIL
29942 command when performing the callout, instead of an empty address. There is no
29943 need to use this option unless you know that the called hosts make use of the
29944 sender when checking recipients. If used indiscriminately, it reduces the
29945 usefulness of callout caching.
29946 .endlist
29947
29948 If you use any of the parameters that set a non-empty sender for the MAIL
29949 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29950 &%use_sender%&), you should think about possible loops. Recipient checking is
29951 usually done between two hosts that are under the same management, and the host
29952 that receives the callouts is not normally configured to do callouts itself.
29953 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29954 these circumstances.
29955
29956 However, if you use a non-empty sender address for a callout to an arbitrary
29957 host, there is the likelihood that the remote host will itself initiate a
29958 callout check back to your host. As it is checking what appears to be a message
29959 sender, it is likely to use an empty address in MAIL, thus avoiding a
29960 callout loop. However, to be on the safe side it would be best to set up your
29961 own ACLs so that they do not do sender verification checks when the recipient
29962 is the address you use for header sender or postmaster callout checking.
29963
29964 Another issue to think about when using non-empty senders for callouts is
29965 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29966 by the sender/recipient combination; thus, for any given recipient, many more
29967 actual callouts are performed than when an empty sender or postmaster is used.
29968
29969
29970
29971
29972 .section "Callout caching" "SECTcallvercache"
29973 .cindex "hints database" "callout cache"
29974 .cindex "callout" "cache, description of"
29975 .cindex "caching" "callout"
29976 Exim caches the results of callouts in order to reduce the amount of resources
29977 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29978 option. A hints database called &"callout"& is used for the cache. Two
29979 different record types are used: one records the result of a callout check for
29980 a specific address, and the other records information that applies to the
29981 entire domain (for example, that it accepts the local part &'postmaster'&).
29982
29983 When an original callout fails, a detailed SMTP error message is given about
29984 the failure. However, for subsequent failures use the cache data, this message
29985 is not available.
29986
29987 The expiry times for negative and positive address cache records are
29988 independent, and can be set by the global options &%callout_negative_expire%&
29989 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29990
29991 If a host gives a negative response to an SMTP connection, or rejects any
29992 commands up to and including
29993 .code
29994 MAIL FROM:<>
29995 .endd
29996 (but not including the MAIL command with a non-empty address),
29997 any callout attempt is bound to fail. Exim remembers such failures in a
29998 domain cache record, which it uses to fail callouts for the domain without
29999 making new connections, until the domain record times out. There are two
30000 separate expiry times for domain cache records:
30001 &%callout_domain_negative_expire%& (default 3h) and
30002 &%callout_domain_positive_expire%& (default 7d).
30003
30004 Domain records expire when the negative expiry time is reached if callouts
30005 cannot be made for the domain, or if the postmaster check failed.
30006 Otherwise, they expire when the positive expiry time is reached. This
30007 ensures that, for example, a host that stops accepting &"random"& local parts
30008 will eventually be noticed.
30009
30010 The callout caching mechanism is based on the domain of the address that is
30011 being tested. If the domain routes to several hosts, it is assumed that their
30012 behaviour will be the same.
30013
30014
30015
30016 .section "Sender address verification reporting" "SECTsenaddver"
30017 .cindex "verifying" "suppressing error details"
30018 See section &<<SECTaddressverification>>& for a general discussion of
30019 verification. When sender verification fails in an ACL, the details of the
30020 failure are given as additional output lines before the 550 response to the
30021 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30022 you might see:
30023 .code
30024 MAIL FROM:<xyz@abc.example>
30025 250 OK
30026 RCPT TO:<pqr@def.example>
30027 550-Verification failed for <xyz@abc.example>
30028 550-Called:   192.168.34.43
30029 550-Sent:     RCPT TO:<xyz@abc.example>
30030 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30031 550 Sender verification failed
30032 .endd
30033 If more than one RCPT command fails in the same way, the details are given
30034 only for the first of them. However, some administrators do not want to send
30035 out this much information. You can suppress the details by adding
30036 &`/no_details`& to the ACL statement that requests sender verification. For
30037 example:
30038 .code
30039 verify = sender/no_details
30040 .endd
30041
30042 .section "Redirection while verifying" "SECTredirwhilveri"
30043 .cindex "verifying" "redirection while"
30044 .cindex "address redirection" "while verifying"
30045 A dilemma arises when a local address is redirected by aliasing or forwarding
30046 during verification: should the generated addresses themselves be verified,
30047 or should the successful expansion of the original address be enough to verify
30048 it? By default, Exim takes the following pragmatic approach:
30049
30050 .ilist
30051 When an incoming address is redirected to just one child address, verification
30052 continues with the child address, and if that fails to verify, the original
30053 verification also fails.
30054 .next
30055 When an incoming address is redirected to more than one child address,
30056 verification does not continue. A success result is returned.
30057 .endlist
30058
30059 This seems the most reasonable behaviour for the common use of aliasing as a
30060 way of redirecting different local parts to the same mailbox. It means, for
30061 example, that a pair of alias entries of the form
30062 .code
30063 A.Wol:   aw123
30064 aw123:   :fail: Gone away, no forwarding address
30065 .endd
30066 work as expected, with both local parts causing verification failure. When a
30067 redirection generates more than one address, the behaviour is more like a
30068 mailing list, where the existence of the alias itself is sufficient for
30069 verification to succeed.
30070
30071 It is possible, however, to change the default behaviour so that all successful
30072 redirections count as successful verifications, however many new addresses are
30073 generated. This is specified by the &%success_on_redirect%& verification
30074 option. For example:
30075 .code
30076 require verify = recipient/success_on_redirect/callout=10s
30077 .endd
30078 In this example, verification succeeds if a router generates a new address, and
30079 the callout does not occur, because no address was routed to a remote host.
30080
30081 When verification is being tested via the &%-bv%& option, the treatment of
30082 redirections is as just described, unless the &%-v%& or any debugging option is
30083 also specified. In that case, full verification is done for every generated
30084 address and a report is output for each of them.
30085
30086
30087
30088 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30089 .cindex "CSA" "verifying"
30090 Client SMTP Authorization is a system that allows a site to advertise
30091 which machines are and are not permitted to send email. This is done by placing
30092 special SRV records in the DNS; these are looked up using the client's HELO
30093 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30094 Authorization checks in Exim are performed by the ACL condition:
30095 .code
30096 verify = csa
30097 .endd
30098 This fails if the client is not authorized. If there is a DNS problem, or if no
30099 valid CSA SRV record is found, or if the client is authorized, the condition
30100 succeeds. These three cases can be distinguished using the expansion variable
30101 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30102 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30103 be likely to cause problems for legitimate email.
30104
30105 The error messages produced by the CSA code include slightly more
30106 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30107 looking up the CSA SRV record, or problems looking up the CSA target
30108 address record. There are four reasons for &$csa_status$& being &"fail"&:
30109
30110 .ilist
30111 The client's host name is explicitly not authorized.
30112 .next
30113 The client's IP address does not match any of the CSA target IP addresses.
30114 .next
30115 The client's host name is authorized but it has no valid target IP addresses
30116 (for example, the target's addresses are IPv6 and the client is using IPv4).
30117 .next
30118 The client's host name has no CSA SRV record but a parent domain has asserted
30119 that all subdomains must be explicitly authorized.
30120 .endlist
30121
30122 The &%csa%& verification condition can take an argument which is the domain to
30123 use for the DNS query. The default is:
30124 .code
30125 verify = csa/$sender_helo_name
30126 .endd
30127 This implementation includes an extension to CSA. If the query domain
30128 is an address literal such as [192.0.2.95], or if it is a bare IP
30129 address, Exim searches for CSA SRV records in the reverse DNS as if
30130 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30131 meaningful to say:
30132 .code
30133 verify = csa/$sender_host_address
30134 .endd
30135 In fact, this is the check that Exim performs if the client does not say HELO.
30136 This extension can be turned off by setting the main configuration option
30137 &%dns_csa_use_reverse%& to be false.
30138
30139 If a CSA SRV record is not found for the domain itself, a search
30140 is performed through its parent domains for a record which might be
30141 making assertions about subdomains. The maximum depth of this search is limited
30142 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30143 default. Exim does not look for CSA SRV records in a top level domain, so the
30144 default settings handle HELO domains as long as seven
30145 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30146 of legitimate HELO domains.
30147
30148 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30149 direct SRV lookups, this is not sufficient because of the extra parent domain
30150 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30151 addresses into lookups in the reverse DNS space. The result of a successful
30152 lookup such as:
30153 .code
30154 ${lookup dnsdb {csa=$sender_helo_name}}
30155 .endd
30156 has two space-separated fields: an authorization code and a target host name.
30157 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30158 authorization required but absent, or &"?"& for unknown.
30159
30160
30161
30162
30163 .section "Bounce address tag validation" "SECTverifyPRVS"
30164 .cindex "BATV, verifying"
30165 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30166 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30167 Genuine incoming bounce messages should therefore always be addressed to
30168 recipients that have a valid tag. This scheme is a way of detecting unwanted
30169 bounce messages caused by sender address forgeries (often called &"collateral
30170 spam"&), because the recipients of such messages do not include valid tags.
30171
30172 There are two expansion items to help with the implementation of the BATV
30173 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30174 the original envelope sender address by using a simple key to add a hash of the
30175 address and some time-based randomizing information. The &%prvs%& expansion
30176 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30177 The syntax of these expansion items is described in section
30178 &<<SECTexpansionitems>>&.
30179
30180 As an example, suppose the secret per-address keys are stored in an MySQL
30181 database. A query to look up the key for an address could be defined as a macro
30182 like this:
30183 .code
30184 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30185                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30186                 }{$value}}
30187 .endd
30188 Suppose also that the senders who make use of BATV are defined by an address
30189 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30190 use this:
30191 .code
30192 # Bounces: drop unsigned addresses for BATV senders
30193 deny message = This address does not send an unsigned reverse path
30194      senders = :
30195      recipients = +batv_senders
30196
30197 # Bounces: In case of prvs-signed address, check signature.
30198 deny message = Invalid reverse path signature.
30199      senders = :
30200      condition  = ${prvscheck {$local_part@$domain}\
30201                   {PRVSCHECK_SQL}{1}}
30202      !condition = $prvscheck_result
30203 .endd
30204 The first statement rejects recipients for bounce messages that are addressed
30205 to plain BATV sender addresses, because it is known that BATV senders do not
30206 send out messages with plain sender addresses. The second statement rejects
30207 recipients that are prvs-signed, but with invalid signatures (either because
30208 the key is wrong, or the signature has timed out).
30209
30210 A non-prvs-signed address is not rejected by the second statement, because the
30211 &%prvscheck%& expansion yields an empty string if its first argument is not a
30212 prvs-signed address, thus causing the &%condition%& condition to be false. If
30213 the first argument is a syntactically valid prvs-signed address, the yield is
30214 the third string (in this case &"1"&), whether or not the cryptographic and
30215 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30216 of the checks (empty for failure, &"1"& for success).
30217
30218 There is one more issue you must consider when implementing prvs-signing:
30219 you have to ensure that the routers accept prvs-signed addresses and
30220 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30221 router to remove the signature with a configuration along these lines:
30222 .code
30223 batv_redirect:
30224   driver = redirect
30225   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30226 .endd
30227 This works because, if the third argument of &%prvscheck%& is empty, the result
30228 of the expansion of a prvs-signed address is the decoded value of the original
30229 address. This router should probably be the first of your routers that handles
30230 local addresses.
30231
30232 To create BATV-signed addresses in the first place, a transport of this form
30233 can be used:
30234 .code
30235 external_smtp_batv:
30236   driver = smtp
30237   return_path = ${prvs {$return_path} \
30238                        {${lookup mysql{SELECT \
30239                        secret FROM batv_prvs WHERE \
30240                        sender='${quote_mysql:$sender_address}'} \
30241                        {$value}fail}}}
30242 .endd
30243 If no key can be found for the existing return path, no signing takes place.
30244
30245
30246
30247 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30248 .cindex "&ACL;" "relay control"
30249 .cindex "relaying" "control by ACL"
30250 .cindex "policy control" "relay control"
30251 An MTA is said to &'relay'& a message if it receives it from some host and
30252 delivers it directly to another host as a result of a remote address contained
30253 within it. Redirecting a local address via an alias or forward file and then
30254 passing the message on to another host is not relaying,
30255 .cindex "&""percent hack""&"
30256 but a redirection as a result of the &"percent hack"& is.
30257
30258 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30259 A host which is acting as a gateway or an MX backup is concerned with incoming
30260 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30261 a host which is acting as a smart host for a number of clients is concerned
30262 with outgoing relaying from those clients to the Internet at large. Often the
30263 same host is fulfilling both functions,
30264 . ///
30265 . as illustrated in the diagram below,
30266 . ///
30267 but in principle these two kinds of relaying are entirely independent. What is
30268 not wanted is the transmission of mail from arbitrary remote hosts through your
30269 system to arbitrary domains.
30270
30271
30272 You can implement relay control by means of suitable statements in the ACL that
30273 runs for each RCPT command. For convenience, it is often easiest to use
30274 Exim's named list facility to define the domains and hosts involved. For
30275 example, suppose you want to do the following:
30276
30277 .ilist
30278 Deliver a number of domains to mailboxes on the local host (or process them
30279 locally in some other way). Let's say these are &'my.dom1.example'& and
30280 &'my.dom2.example'&.
30281 .next
30282 Relay mail for a number of other domains for which you are the secondary MX.
30283 These might be &'friend1.example'& and &'friend2.example'&.
30284 .next
30285 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30286 Suppose your LAN is 192.168.45.0/24.
30287 .endlist
30288
30289
30290 In the main part of the configuration, you put the following definitions:
30291 .code
30292 domainlist local_domains    = my.dom1.example : my.dom2.example
30293 domainlist relay_to_domains = friend1.example : friend2.example
30294 hostlist   relay_from_hosts = 192.168.45.0/24
30295 .endd
30296 Now you can use these definitions in the ACL that is run for every RCPT
30297 command:
30298 .code
30299 acl_check_rcpt:
30300   accept domains = +local_domains : +relay_to_domains
30301   accept hosts   = +relay_from_hosts
30302 .endd
30303 The first statement accepts any RCPT command that contains an address in
30304 the local or relay domains. For any other domain, control passes to the second
30305 statement, which accepts the command only if it comes from one of the relay
30306 hosts. In practice, you will probably want to make your ACL more sophisticated
30307 than this, for example, by including sender and recipient verification. The
30308 default configuration includes a more comprehensive example, which is described
30309 in chapter &<<CHAPdefconfil>>&.
30310
30311
30312
30313 .section "Checking a relay configuration" "SECTcheralcon"
30314 .cindex "relaying" "checking control of"
30315 You can check the relay characteristics of your configuration in the same way
30316 that you can test any ACL behaviour for an incoming SMTP connection, by using
30317 the &%-bh%& option to run a fake SMTP session with which you interact.
30318
30319 For specifically testing for unwanted relaying, the host
30320 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30321 host from the host on which Exim is running, using the normal telnet port, you
30322 will see a normal telnet connection message and then quite a long delay. Be
30323 patient. The remote host is making an SMTP connection back to your host, and
30324 trying a number of common probes to test for open relay vulnerability. The
30325 results of the tests will eventually appear on your terminal.
30326 .ecindex IIDacl
30327
30328
30329
30330 . ////////////////////////////////////////////////////////////////////////////
30331 . ////////////////////////////////////////////////////////////////////////////
30332
30333 .chapter "Content scanning at ACL time" "CHAPexiscan"
30334 .scindex IIDcosca "content scanning" "at ACL time"
30335 The extension of Exim to include content scanning at ACL time, formerly known
30336 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30337 was integrated into the main source for Exim release 4.50, and Tom continues to
30338 maintain it. Most of the wording of this chapter is taken from Tom's
30339 specification.
30340
30341 It is also possible to scan the content of messages at other times. The
30342 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30343 scanning after all the ACLs have run. A transport filter can be used to scan
30344 messages at delivery time (see the &%transport_filter%& option, described in
30345 chapter &<<CHAPtransportgeneric>>&).
30346
30347 If you want to include the ACL-time content-scanning features when you compile
30348 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30349 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30350
30351 .ilist
30352 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30353 for all MIME parts for SMTP and non-SMTP messages, respectively.
30354 .next
30355 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30356 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30357 run at the end of message reception (the &%acl_smtp_data%& ACL).
30358 .next
30359 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30360 of messages, or parts of messages, for debugging purposes.
30361 .next
30362 Additional expansion variables that are set in the new ACL and by the new
30363 conditions.
30364 .next
30365 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30366 .endlist
30367
30368 There is another content-scanning configuration option for &_Local/Makefile_&,
30369 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30370 condition is compiled, in addition to all the other content-scanning features.
30371
30372 Content-scanning is continually evolving, and new features are still being
30373 added. While such features are still unstable and liable to incompatible
30374 changes, they are made available in Exim by setting options whose names begin
30375 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30376 this manual. You can find out about them by reading the file called
30377 &_doc/experimental.txt_&.
30378
30379 All the content-scanning facilities work on a MBOX copy of the message that is
30380 temporarily created in a file called:
30381 .display
30382 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30383 .endd
30384 The &_.eml_& extension is a friendly hint to virus scanners that they can
30385 expect an MBOX-like structure inside that file. The file is created when the
30386 first content scanning facility is called. Subsequent calls to content
30387 scanning conditions open the same file again. The directory is recursively
30388 removed when the &%acl_smtp_data%& ACL has finished running, unless
30389 .code
30390 control = no_mbox_unspool
30391 .endd
30392 has been encountered. When the MIME ACL decodes files, they are put into the
30393 same directory by default.
30394
30395
30396
30397 .section "Scanning for viruses" "SECTscanvirus"
30398 .cindex "virus scanning"
30399 .cindex "content scanning" "for viruses"
30400 .cindex "content scanning" "the &%malware%& condition"
30401 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30402 It supports a &"generic"& interface to scanners called via the shell, and
30403 specialized interfaces for &"daemon"& type virus scanners, which are resident
30404 in memory and thus are much faster.
30405
30406 .new
30407 A timeout of 2 minutes is applied to a scanner call (by default);
30408 if it expires then a defer action is taken.
30409 .wen
30410
30411 .oindex "&%av_scanner%&"
30412 You can set the &%av_scanner%& option in the main part of the configuration
30413 to specify which scanner to use, together with any additional options that
30414 are needed. The basic syntax is as follows:
30415 .display
30416 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30417 .endd
30418 If you do not set &%av_scanner%&, it defaults to
30419 .code
30420 av_scanner = sophie:/var/run/sophie
30421 .endd
30422 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30423 before use.
30424 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30425 The following scanner types are supported in this release:
30426
30427 .vlist
30428 .new
30429 .vitem &%avast%&
30430 .cindex "virus scanners" "avast"
30431 This is the scanner daemon of Avast. It has been tested with Avast Core
30432 Security (currenty at version 1.1.7).
30433 You can get a trial version at &url(http://www.avast.com) or for Linux
30434 at &url(http://www.avast.com/linux-server-antivirus).
30435 This scanner type takes one option,
30436 which can be either a full path to a UNIX socket,
30437 or host and port specifiers separated by white space.
30438 The host may be a name or an IP address; the port is either a
30439 single number or a pair of numbers with a dash between.
30440 Any further options are given, on separate lines,
30441 to the daemon as options before the main scan command.
30442 For example:
30443 .code
30444 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30445 av_scanner = avast:192.168.2.22 5036
30446 .endd
30447 If you omit the argument, the default path
30448 &_/var/run/avast/scan.sock_&
30449 is used.
30450 If you use a remote host,
30451 you need to make Exim's spool directory available to it,
30452 as the scanner is passed a file path, not file contents.
30453 For information about available commands and their options you may use 
30454 .code
30455 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30456     FLAGS
30457     SENSITIVITY
30458     PACK
30459 .endd
30460 .wen
30461
30462
30463 .vitem &%aveserver%&
30464 .cindex "virus scanners" "Kaspersky"
30465 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30466 at &url(http://www.kaspersky.com). This scanner type takes one option,
30467 which is the path to the daemon's UNIX socket. The default is shown in this
30468 example:
30469 .code
30470 av_scanner = aveserver:/var/run/aveserver
30471 .endd
30472
30473
30474 .vitem &%clamd%&
30475 .cindex "virus scanners" "clamd"
30476 This daemon-type scanner is GPL and free. You can get it at
30477 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30478 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30479 in the MIME ACL. This is no longer believed to be necessary.
30480
30481 The options are a list of server specifiers, which may be
30482 a UNIX socket specification,
30483 a TCP socket specification,
30484 or a (global) option.
30485
30486 A socket specification consists of a space-separated list.
30487 For a Unix socket the first element is a full path for the socket,
30488 for a TCP socket the first element is the IP address
30489 and the second a port number,
30490 Any further elements are per-server (non-global) options.
30491 These per-server options are supported:
30492 .code
30493 retry=<timespec>        Retry on connect fail
30494 .endd
30495
30496 The &`retry`& option specifies a time after which a single retry for
30497 a failed connect is made.  The default is to not retry.
30498
30499 If a Unix socket file is specified, only one server is supported.
30500
30501 Examples:
30502 .code
30503 av_scanner = clamd:/opt/clamd/socket
30504 av_scanner = clamd:192.0.2.3 1234
30505 av_scanner = clamd:192.0.2.3 1234:local
30506 av_scanner = clamd:192.0.2.3 1234 retry=10s
30507 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30508 .endd
30509 If the value of av_scanner points to a UNIX socket file or contains the
30510 &`local`&
30511 option, then the ClamAV interface will pass a filename containing the data
30512 to be scanned, which will should normally result in less I/O happening and be
30513 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30514 Exim does not assume that there is a common filesystem with the remote host.
30515 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30516 you be running a version of ClamAV prior to 0.95.
30517
30518 The final example shows that multiple TCP targets can be specified.  Exim will
30519 randomly use one for each incoming email (i.e. it load balances them).  Note
30520 that only TCP targets may be used if specifying a list of scanners; a UNIX
30521 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30522 unavailable, Exim will try the remaining one(s) until it finds one that works.
30523 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30524 not keep track of scanner state between multiple messages, and the scanner
30525 selection is random, so the message will get logged in the mainlog for each
30526 email that the down scanner gets chosen first (message wrapped to be readable):
30527 .code
30528 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30529    clamd: connection to localhost, port 3310 failed
30530    (Connection refused)
30531 .endd
30532
30533 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30534 contributing the code for this scanner.
30535
30536 .vitem &%cmdline%&
30537 .cindex "virus scanners" "command line interface"
30538 This is the keyword for the generic command line scanner interface. It can be
30539 used to attach virus scanners that are invoked from the shell. This scanner
30540 type takes 3 mandatory options:
30541
30542 .olist
30543 The full path and name of the scanner binary, with all command line options,
30544 and a placeholder (&`%s`&) for the directory to scan.
30545
30546 .next
30547 A regular expression to match against the STDOUT and STDERR output of the
30548 virus scanner. If the expression matches, a virus was found. You must make
30549 absolutely sure that this expression matches on &"virus found"&. This is called
30550 the &"trigger"& expression.
30551
30552 .next
30553 Another regular expression, containing exactly one pair of parentheses, to
30554 match the name of the virus found in the scanners output. This is called the
30555 &"name"& expression.
30556 .endlist olist
30557
30558 For example, Sophos Sweep reports a virus on a line like this:
30559 .code
30560 Virus 'W32/Magistr-B' found in file ./those.bat
30561 .endd
30562 For the trigger expression, we can match the phrase &"found in file"&. For the
30563 name expression, we want to extract the W32/Magistr-B string, so we can match
30564 for the single quotes left and right of it. Altogether, this makes the
30565 configuration setting:
30566 .code
30567 av_scanner = cmdline:\
30568              /path/to/sweep -ss -all -rec -archive %s:\
30569              found in file:'(.+)'
30570 .endd
30571 .vitem &%drweb%&
30572 .cindex "virus scanners" "DrWeb"
30573 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30574 takes one option,
30575 either a full path to a UNIX socket,
30576 or host and port specifiers separated by white space.
30577 The host may be a name or an IP address; the port is either a
30578 single number or a pair of numbers with a dash between.
30579 For example:
30580 .code
30581 av_scanner = drweb:/var/run/drwebd.sock
30582 av_scanner = drweb:192.168.2.20 31337
30583 .endd
30584 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30585 is used. Thanks to Alex Miller for contributing the code for this scanner.
30586
30587 .vitem &%f-protd%&
30588 .cindex "virus scanners" "f-protd"
30589 The f-protd scanner is accessed via HTTP over TCP.
30590 One argument is taken, being a space-separated hostname and port number
30591 (or port-range).
30592 For example:
30593 .code
30594 av_scanner = f-protd:localhost 10200-10204
30595 .endd
30596 If you omit the argument, the default values show above are used.
30597
30598 .vitem &%fsecure%&
30599 .cindex "virus scanners" "F-Secure"
30600 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30601 argument which is the path to a UNIX socket. For example:
30602 .code
30603 av_scanner = fsecure:/path/to/.fsav
30604 .endd
30605 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30606 Thelmen for contributing the code for this scanner.
30607
30608 .vitem &%kavdaemon%&
30609 .cindex "virus scanners" "Kaspersky"
30610 This is the scanner daemon of Kaspersky Version 4. This version of the
30611 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30612 scanner type takes one option, which is the path to the daemon's UNIX socket.
30613 For example:
30614 .code
30615 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30616 .endd
30617 The default path is &_/var/run/AvpCtl_&.
30618
30619 .vitem &%mksd%&
30620 .cindex "virus scanners" "mksd"
30621 This is a daemon type scanner that is aimed mainly at Polish users, though some
30622 parts of documentation are now available in English. You can get it at
30623 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30624 the maximum number of processes used simultaneously to scan the attachments,
30625 provided that the demime facility is employed and also provided that mksd has
30626 been run with at least the same number of child processes. For example:
30627 .code
30628 av_scanner = mksd:2
30629 .endd
30630 You can safely omit this option (the default value is 1).
30631
30632 .vitem &%sock%&
30633 .cindex "virus scanners" "simple socket-connected"
30634 This is a general-purpose way of talking to simple scanner daemons
30635 running on the local machine.
30636 There are four options:
30637 an address (which may be an IP addres and port, or the path of a Unix socket),
30638 a commandline to send (may include a single %s which will be replaced with
30639 the path to the mail file to be scanned),
30640 an RE to trigger on from the returned data,
30641 an RE to extract malware_name from the returned data.
30642 For example:
30643 .code
30644 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30645 .endd
30646 Default for the socket specifier is &_/tmp/malware.sock_&.
30647 Default for the commandline is &_%s\n_&.
30648 Both regular-expressions are required.
30649
30650 .vitem &%sophie%&
30651 .cindex "virus scanners" "Sophos and Sophie"
30652 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30653 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30654 for this scanner type is the path to the UNIX socket that Sophie uses for
30655 client communication. For example:
30656 .code
30657 av_scanner = sophie:/tmp/sophie
30658 .endd
30659 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30660 the option.
30661 .endlist
30662
30663 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30664 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30665 ACL.
30666
30667 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30668 makes it possible to use different scanners. See further below for an example.
30669 The &%malware%& condition caches its results, so when you use it multiple times
30670 for the same message, the actual scanning process is only carried out once.
30671 However, using expandable items in &%av_scanner%& disables this caching, in
30672 which case each use of the &%malware%& condition causes a new scan of the
30673 message.
30674
30675 The &%malware%& condition takes a right-hand argument that is expanded before
30676 .new
30677 use and taken as a list, slash-separated by default.
30678 .wen
30679 The first element can then be one of
30680
30681 .ilist
30682 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30683 The condition succeeds if a virus was found, and fail otherwise. This is the
30684 recommended usage.
30685 .next
30686 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30687 the condition fails immediately.
30688 .next
30689 A regular expression, in which case the message is scanned for viruses. The
30690 condition succeeds if a virus is found and its name matches the regular
30691 expression. This allows you to take special actions on certain types of virus.
30692 .new
30693 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30694 unless the separator is changed (in the usual way).
30695 .wen
30696 .endlist
30697
30698 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30699 messages even if there is a problem with the virus scanner.
30700 Otherwise, such a problem causes the ACL to defer.
30701
30702 .new
30703 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30704 specify a non-default timeout.  The default is two minutes.
30705 For example:
30706 .code
30707 malware = * / defer_ok / tmo=10s
30708 .endd
30709 A timeout causes the ACL to defer.
30710 .wen
30711
30712 .vindex "&$malware_name$&"
30713 When a virus is found, the condition sets up an expansion variable called
30714 &$malware_name$& that contains the name of the virus. You can use it in a
30715 &%message%& modifier that specifies the error returned to the sender, and/or in
30716 logging data.
30717
30718 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30719 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30720 &%malware%& condition.
30721
30722 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30723 imposed by your anti-virus scanner.
30724
30725 Here is a very simple scanning example:
30726 .code
30727 deny message = This message contains malware ($malware_name)
30728      demime = *
30729      malware = *
30730 .endd
30731 The next example accepts messages when there is a problem with the scanner:
30732 .code
30733 deny message = This message contains malware ($malware_name)
30734      demime = *
30735      malware = */defer_ok
30736 .endd
30737 The next example shows how to use an ACL variable to scan with both sophie and
30738 aveserver. It assumes you have set:
30739 .code
30740 av_scanner = $acl_m0
30741 .endd
30742 in the main Exim configuration.
30743 .code
30744 deny message = This message contains malware ($malware_name)
30745      set acl_m0 = sophie
30746      malware = *
30747
30748 deny message = This message contains malware ($malware_name)
30749      set acl_m0 = aveserver
30750      malware = *
30751 .endd
30752
30753
30754 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
30755 .cindex "content scanning" "for spam"
30756 .cindex "spam scanning"
30757 .cindex "SpamAssassin"
30758 .cindex "Rspamd"
30759 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30760 score and a report for the message.
30761 .new
30762 Support is also provided for Rspamd.
30763
30764 For more information about installation and configuration of SpamAssassin or 
30765 Rspamd refer to their respective websites at
30766 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
30767 .wen
30768
30769 SpamAssassin can be installed with CPAN by running:
30770 .code
30771 perl -MCPAN -e 'install Mail::SpamAssassin'
30772 .endd
30773 SpamAssassin has its own set of configuration files. Please review its
30774 documentation to see how you can tweak it. The default installation should work
30775 nicely, however.
30776
30777 .oindex "&%spamd_address%&"
30778 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you 
30779 intend to use an instance running on the local host you do not need to set
30780 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
30781 you must set the &%spamd_address%& option in the global part of the Exim
30782 configuration as follows (example):
30783 .code
30784 spamd_address = 192.168.99.45 387
30785 .endd
30786
30787 .new
30788 To use Rspamd (which by default listens on all local addresses
30789 on TCP port 11333)
30790 you should add &%variant=rspamd%& after the address/port pair, for example:
30791 .code
30792 spamd_address = 127.0.0.1 11333 variant=rspamd
30793 .endd
30794 .wen
30795
30796 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
30797 sockets. If you want to us these, supply &%spamd_address%& with an absolute
30798 file name instead of an address/port pair:
30799 .code
30800 spamd_address = /var/run/spamd_socket
30801 .endd
30802 You can have multiple &%spamd%& servers to improve scalability. These can
30803 reside on other hardware reachable over the network. To specify multiple
30804 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30805 option, separated with colons (the separator can be changed in the usual way):
30806 .code
30807 spamd_address = 192.168.2.10 783 : \
30808                 192.168.2.11 783 : \
30809                 192.168.2.12 783
30810 .endd
30811 Up to 32 &%spamd%& servers are supported.
30812 When a server fails to respond to the connection attempt, all other
30813 servers are tried until one succeeds. If no server responds, the &%spam%&
30814 condition defers.
30815
30816 .new
30817 Unix and TCP socket specifications may be mixed in any order.
30818 Each element of the list is a list itself, space-separated by default
30819 and changeable in the usual way.
30820
30821 For TCP socket specifications a host name or IP (v4 or v6, but
30822 subject to list-separator quoting rules) address can be used,
30823 and the port can be one or a dash-separated pair.
30824 In the latter case, the range is tried in strict order.
30825
30826 Elements after the first for Unix sockets, or second for TCP socket,
30827 are options.
30828 The supported option are:
30829 .code
30830 pri=<priority>      Selection priority
30831 weight=<value>      Selection bias
30832 time=<start>-<end>  Use only between these times of day
30833 retry=<timespec>    Retry on connect fail
30834 tmo=<timespec>      Connection time limit
30835 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
30836 .endd
30837
30838 The &`pri`& option specifies a priority for the server within the list,
30839 higher values being tried first.
30840 The deafult priority is 1.
30841
30842 The &`weight`& option specifies a selection bias.
30843 Within a priority set
30844 servers are queried in a random fashion, weighted by this value.
30845 The default value for selection bias is 1.
30846
30847 Time specifications for the &`time`& option are <hour>.<minute>.<second>
30848 in the local time zone; each element being one or more digits.
30849 Either the seconds or both minutes and seconds, plus the leading &`.`&
30850 characters, may be omitted and will be taken as zero.
30851
30852 Timeout specifications for the &`retry`& and &`tmo`& options
30853 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
30854
30855 The &`tmo`& option specifies an overall timeout for communication.
30856 The default value is two minutes.
30857
30858 The &`retry`& option specifies a time after which a single retry for
30859 a failed connect is made.
30860 The default is to not retry.
30861 .wen
30862
30863 The &%spamd_address%& variable is expanded before use if it starts with
30864 a dollar sign. In this case, the expansion may return a string that is
30865 used as the list so that multiple spamd servers can be the result of an
30866 expansion.
30867
30868 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30869 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30870 .code
30871 deny message = This message was classified as SPAM
30872      spam = joe
30873 .endd
30874 The right-hand side of the &%spam%& condition specifies a name. This is
30875 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30876 to scan using a specific profile, but rather use the SpamAssassin system-wide
30877 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30878 .new
30879 Rspamd does not use this setting. However, you must put something on the
30880 right-hand side.
30881 .wen
30882
30883 The name allows you to use per-domain or per-user antispam profiles in
30884 principle, but this is not straightforward in practice, because a message may
30885 have multiple recipients, not necessarily all in the same domain. Because the
30886 &%spam%& condition has to be called from a DATA ACL in order to be able to
30887 read the contents of the message, the variables &$local_part$& and &$domain$&
30888 are not set.
30889 Careful enforcement of single-recipient messages
30890 (eg. by responding with defer in the recipient ACL for all recipients
30891 after the first),
30892 or the use of PRDR,
30893 .cindex "PRDR" "use for per-user SpamAssassin profiles"
30894 are needed to use this feature.
30895
30896 The right-hand side of the &%spam%& condition is expanded before being used, so
30897 you can put lookups or conditions there. When the right-hand side evaluates to
30898 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30899
30900
30901 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30902 large ones may cause significant performance degradation. As most spam messages
30903 are quite small, it is recommended that you do not scan the big ones. For
30904 example:
30905 .code
30906 deny message = This message was classified as SPAM
30907      condition = ${if < {$message_size}{10K}}
30908      spam = nobody
30909 .endd
30910
30911 The &%spam%& condition returns true if the threshold specified in the user's
30912 SpamAssassin profile has been matched or exceeded. If you want to use the
30913 &%spam%& condition for its side effects (see the variables below), you can make
30914 it always return &"true"& by appending &`:true`& to the username.
30915
30916 .cindex "spam scanning" "returned variables"
30917 When the &%spam%& condition is run, it sets up a number of expansion
30918 variables. These variables are saved with the received message, thus they are
30919 available for use at delivery time.
30920
30921 .vlist
30922 .vitem &$spam_score$&
30923 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30924 for inclusion in log or reject messages.
30925
30926 .vitem &$spam_score_int$&
30927 The spam score of the message, multiplied by ten, as an integer value. For
30928 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30929 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30930 The integer value is useful for numeric comparisons in conditions.
30931
30932 .vitem &$spam_bar$&
30933 A string consisting of a number of &"+"& or &"-"& characters, representing the
30934 integer part of the spam score value. A spam score of 4.4 would have a
30935 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30936 headers, since MUAs can match on such strings.
30937
30938 .vitem &$spam_report$&
30939 A multiline text table, containing the full SpamAssassin report for the
30940 message. Useful for inclusion in headers or reject messages.
30941
30942 .new
30943 .vitem &$spam_action$&
30944 For SpamAssassin either 'reject' or 'no action' depending on the
30945 spam score versus threshold.
30946 For Rspamd, the recommended action.
30947 .wen
30948
30949 .endlist
30950
30951 The &%spam%& condition caches its results unless expansion in
30952 spamd_address was used. If you call it again with the same user name, it
30953 does not scan again, but rather returns the same values as before.
30954
30955 The &%spam%& condition returns DEFER if there is any error while running
30956 the message through SpamAssassin or if the expansion of spamd_address
30957 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30958 statement block), append &`/defer_ok`& to the right-hand side of the
30959 spam condition, like this:
30960 .code
30961 deny message = This message was classified as SPAM
30962      spam    = joe/defer_ok
30963 .endd
30964 This causes messages to be accepted even if there is a problem with &%spamd%&.
30965
30966 Here is a longer, commented example of the use of the &%spam%&
30967 condition:
30968 .code
30969 # put headers in all messages (no matter if spam or not)
30970 warn  spam = nobody:true
30971       add_header = X-Spam-Score: $spam_score ($spam_bar)
30972       add_header = X-Spam-Report: $spam_report
30973
30974 # add second subject line with *SPAM* marker when message
30975 # is over threshold
30976 warn  spam = nobody
30977       add_header = Subject: *SPAM* $h_Subject:
30978
30979 # reject spam at high scores (> 12)
30980 deny  message = This message scored $spam_score spam points.
30981       spam = nobody:true
30982       condition = ${if >{$spam_score_int}{120}{1}{0}}
30983 .endd
30984
30985
30986
30987 .section "Scanning MIME parts" "SECTscanmimepart"
30988 .cindex "content scanning" "MIME parts"
30989 .cindex "MIME content scanning"
30990 .oindex "&%acl_smtp_mime%&"
30991 .oindex "&%acl_not_smtp_mime%&"
30992 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30993 each MIME part of an SMTP message, including multipart types, in the sequence
30994 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30995 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30996 options may both refer to the same ACL if you want the same processing in both
30997 cases.
30998
30999 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31000 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31001 the case of a non-SMTP message. However, a MIME ACL is called only if the
31002 message contains a &'Content-Type:'& header line. When a call to a MIME
31003 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31004 result code is sent to the client. In the case of an SMTP message, the
31005 &%acl_smtp_data%& ACL is not called when this happens.
31006
31007 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31008 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31009 condition to match against the raw MIME part. You can also use the
31010 &%mime_regex%& condition to match against the decoded MIME part (see section
31011 &<<SECTscanregex>>&).
31012
31013 At the start of a MIME ACL, a number of variables are set from the header
31014 information for the relevant MIME part. These are described below. The contents
31015 of the MIME part are not by default decoded into a disk file except for MIME
31016 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31017 part into a disk file, you can use the &%decode%& condition. The general
31018 syntax is:
31019 .display
31020 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31021 .endd
31022 The right hand side is expanded before use. After expansion,
31023 the value can be:
31024
31025 .olist
31026 &"0"& or &"false"&, in which case no decoding is done.
31027 .next
31028 The string &"default"&. In that case, the file is put in the temporary
31029 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31030 a sequential file name consisting of the message id and a sequence number. The
31031 full path and name is available in &$mime_decoded_filename$& after decoding.
31032 .next
31033 A full path name starting with a slash. If the full name is an existing
31034 directory, it is used as a replacement for the default directory. The filename
31035 is then sequentially assigned. If the path does not exist, it is used as
31036 the full path and file name.
31037 .next
31038 If the string does not start with a slash, it is used as the
31039 filename, and the default path is then used.
31040 .endlist
31041 The &%decode%& condition normally succeeds. It is only false for syntax
31042 errors or unusual circumstances such as memory shortages. You can easily decode
31043 a file with its original, proposed filename using
31044 .code
31045 decode = $mime_filename
31046 .endd
31047 However, you should keep in mind that &$mime_filename$& might contain
31048 anything. If you place files outside of the default path, they are not
31049 automatically unlinked.
31050
31051 For RFC822 attachments (these are messages attached to messages, with a
31052 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31053 as for the primary message, only that the &$mime_is_rfc822$& expansion
31054 variable is set (see below). Attached messages are always decoded to disk
31055 before being checked, and the files are unlinked once the check is done.
31056
31057 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31058 used to match regular expressions against raw and decoded MIME parts,
31059 respectively. They are described in section &<<SECTscanregex>>&.
31060
31061 .cindex "MIME content scanning" "returned variables"
31062 The following list describes all expansion variables that are
31063 available in the MIME ACL:
31064
31065 .vlist
31066 .vitem &$mime_boundary$&
31067 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31068 have a boundary string, which is stored in this variable. If the current part
31069 has no boundary parameter in the &'Content-Type:'& header, this variable
31070 contains the empty string.
31071
31072 .vitem &$mime_charset$&
31073 This variable contains the character set identifier, if one was found in the
31074 &'Content-Type:'& header. Examples for charset identifiers are:
31075 .code
31076 us-ascii
31077 gb2312 (Chinese)
31078 iso-8859-1
31079 .endd
31080 Please note that this value is not normalized, so you should do matches
31081 case-insensitively.
31082
31083 .vitem &$mime_content_description$&
31084 This variable contains the normalized content of the &'Content-Description:'&
31085 header. It can contain a human-readable description of the parts content. Some
31086 implementations repeat the filename for attachments here, but they are usually
31087 only used for display purposes.
31088
31089 .vitem &$mime_content_disposition$&
31090 This variable contains the normalized content of the &'Content-Disposition:'&
31091 header. You can expect strings like &"attachment"& or &"inline"& here.
31092
31093 .vitem &$mime_content_id$&
31094 This variable contains the normalized content of the &'Content-ID:'& header.
31095 This is a unique ID that can be used to reference a part from another part.
31096
31097 .vitem &$mime_content_size$&
31098 This variable is set only after the &%decode%& modifier (see above) has been
31099 successfully run. It contains the size of the decoded part in kilobytes. The
31100 size is always rounded up to full kilobytes, so only a completely empty part
31101 has a &$mime_content_size$& of zero.
31102
31103 .vitem &$mime_content_transfer_encoding$&
31104 This variable contains the normalized content of the
31105 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31106 type. Typical values are &"base64"& and &"quoted-printable"&.
31107
31108 .vitem &$mime_content_type$&
31109 If the MIME part has a &'Content-Type:'& header, this variable contains its
31110 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31111 are some examples of popular MIME types, as they may appear in this variable:
31112 .code
31113 text/plain
31114 text/html
31115 application/octet-stream
31116 image/jpeg
31117 audio/midi
31118 .endd
31119 If the MIME part has no &'Content-Type:'& header, this variable contains the
31120 empty string.
31121
31122 .vitem &$mime_decoded_filename$&
31123 This variable is set only after the &%decode%& modifier (see above) has been
31124 successfully run. It contains the full path and file name of the file
31125 containing the decoded data.
31126 .endlist
31127
31128 .cindex "RFC 2047"
31129 .vlist
31130 .vitem &$mime_filename$&
31131 This is perhaps the most important of the MIME variables. It contains a
31132 proposed filename for an attachment, if one was found in either the
31133 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31134 RFC2047 decoded, but no additional sanity checks are done. If no filename was
31135 found, this variable contains the empty string.
31136
31137 .vitem &$mime_is_coverletter$&
31138 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31139 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31140 content in the cover letter, while not restricting attachments at all.
31141
31142 The variable contains 1 (true) for a MIME part believed to be part of the
31143 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31144 follows:
31145
31146 .olist
31147 The outermost MIME part of a message is always a cover letter.
31148
31149 .next
31150 If a multipart/alternative or multipart/related MIME part is a cover letter,
31151 so are all MIME subparts within that multipart.
31152
31153 .next
31154 If any other multipart is a cover letter, the first subpart is a cover letter,
31155 and the rest are attachments.
31156
31157 .next
31158 All parts contained within an attachment multipart are attachments.
31159 .endlist olist
31160
31161 As an example, the following will ban &"HTML mail"& (including that sent with
31162 alternative plain text), while allowing HTML files to be attached. HTML
31163 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31164 .code
31165 deny message = HTML mail is not accepted here
31166 !condition = $mime_is_rfc822
31167 condition = $mime_is_coverletter
31168 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31169 .endd
31170 .vitem &$mime_is_multipart$&
31171 This variable has the value 1 (true) when the current part has the main type
31172 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31173 Since multipart entities only serve as containers for other parts, you may not
31174 want to carry out specific actions on them.
31175
31176 .vitem &$mime_is_rfc822$&
31177 This variable has the value 1 (true) if the current part is not a part of the
31178 checked message itself, but part of an attached message. Attached message
31179 decoding is fully recursive.
31180
31181 .vitem &$mime_part_count$&
31182 This variable is a counter that is raised for each processed MIME part. It
31183 starts at zero for the very first part (which is usually a multipart). The
31184 counter is per-message, so it is reset when processing RFC822 attachments (see
31185 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31186 complete, so you can use it in the DATA ACL to determine the number of MIME
31187 parts of a message. For non-MIME messages, this variable contains the value -1.
31188 .endlist
31189
31190
31191
31192 .section "Scanning with regular expressions" "SECTscanregex"
31193 .cindex "content scanning" "with regular expressions"
31194 .cindex "regular expressions" "content scanning with"
31195 You can specify your own custom regular expression matches on the full body of
31196 the message, or on individual MIME parts.
31197
31198 The &%regex%& condition takes one or more regular expressions as arguments and
31199 matches them against the full message (when called in the DATA ACL) or a raw
31200 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31201 linewise, with a maximum line length of 32K characters. That means you cannot
31202 have multiline matches with the &%regex%& condition.
31203
31204 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31205 to 32K of decoded content (the whole content at once, not linewise). If the
31206 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31207 is decoded automatically when &%mime_regex%& is executed (using default path
31208 and filename values). If the decoded data is larger than  32K, only the first
31209 32K characters are checked.
31210
31211 The regular expressions are passed as a colon-separated list. To include a
31212 literal colon, you must double it. Since the whole right-hand side string is
31213 expanded before being used, you must also escape dollar signs and backslashes
31214 with more backslashes, or use the &`\N`& facility to disable expansion.
31215 Here is a simple example that contains two regular expressions:
31216 .code
31217 deny message = contains blacklisted regex ($regex_match_string)
31218      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31219 .endd
31220 The conditions returns true if any one of the regular expressions matches. The
31221 &$regex_match_string$& expansion variable is then set up and contains the
31222 matching regular expression.
31223
31224 &*Warning*&: With large messages, these conditions can be fairly
31225 CPU-intensive.
31226
31227
31228
31229
31230 .section "The demime condition" "SECTdemimecond"
31231 .cindex "content scanning" "MIME checking"
31232 .cindex "MIME content scanning"
31233 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31234 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31235 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31236 ACL functionality, but provides no additional facilities. Please note that this
31237 condition is deprecated and kept only for backward compatibility. You must set
31238 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31239 use the &%demime%& condition.
31240
31241 The &%demime%& condition unpacks MIME containers in the message. It detects
31242 errors in MIME containers and can match file extensions found in the message
31243 against a list. Using this facility produces files containing the unpacked MIME
31244 parts of the message in the temporary scan directory. If you do antivirus
31245 scanning, it is recommended that you use the &%demime%& condition before the
31246 antivirus (&%malware%&) condition.
31247
31248 On the right-hand side of the &%demime%& condition you can pass a
31249 colon-separated list of file extensions that it should match against. For
31250 example:
31251 .code
31252 deny message = Found blacklisted file attachment
31253      demime  = vbs:com:bat:pif:prf:lnk
31254 .endd
31255 If one of the file extensions is found, the condition is true, otherwise it is
31256 false. If there is a temporary error while demimeing (for example, &"disk
31257 full"&), the condition defers, and the message is temporarily rejected (unless
31258 the condition is on a &%warn%& verb).
31259
31260 The right-hand side is expanded before being treated as a list, so you can have
31261 conditions and lookups there. If it expands to an empty string, &"false"&, or
31262 zero (&"0"&), no demimeing is done and the condition is false.
31263
31264 The &%demime%& condition set the following variables:
31265
31266 .vlist
31267 .vitem &$demime_errorlevel$&
31268 .vindex "&$demime_errorlevel$&"
31269 When an error is detected in a MIME container, this variable contains the
31270 severity of the error, as an integer number. The higher the value, the more
31271 severe the error (the current maximum value is 3). If this variable is unset or
31272 zero, no error occurred.
31273
31274 .vitem &$demime_reason$&
31275 .vindex "&$demime_reason$&"
31276 When &$demime_errorlevel$& is greater than zero, this variable contains a
31277 human-readable text string describing the MIME error that occurred.
31278 .endlist
31279
31280 .vlist
31281 .vitem &$found_extension$&
31282 .vindex "&$found_extension$&"
31283 When the &%demime%& condition is true, this variable contains the file
31284 extension it found.
31285 .endlist
31286
31287 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31288 the &%demime%& condition, and are not changed on subsequent calls.
31289
31290 If you do not want to check for file extensions, but rather use the &%demime%&
31291 condition for unpacking or error checking purposes, pass &"*"& as the
31292 right-hand side value. Here is a more elaborate example of how to use this
31293 facility:
31294 .code
31295 # Reject messages with serious MIME container errors
31296 deny  message = Found MIME error ($demime_reason).
31297       demime = *
31298       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31299
31300 # Reject known virus spreading file extensions.
31301 # Accepting these is pretty much braindead.
31302 deny  message = contains $found_extension file (blacklisted).
31303       demime  = com:vbs:bat:pif:scr
31304
31305 # Freeze .exe and .doc files. Postmaster can
31306 # examine them and eventually thaw them.
31307 deny  log_message = Another $found_extension file.
31308       demime = exe:doc
31309       control = freeze
31310 .endd
31311 .ecindex IIDcosca
31312
31313
31314
31315
31316 . ////////////////////////////////////////////////////////////////////////////
31317 . ////////////////////////////////////////////////////////////////////////////
31318
31319 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31320          "Local scan function"
31321 .scindex IIDlosca "&[local_scan()]& function" "description of"
31322 .cindex "customizing" "input scan using C function"
31323 .cindex "policy control" "by local scan function"
31324 In these days of email worms, viruses, and ever-increasing spam, some sites
31325 want to apply a lot of checking to messages before accepting them.
31326
31327 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31328 passing messages to external virus and spam scanning software. You can also do
31329 a certain amount in Exim itself through string expansions and the &%condition%&
31330 condition in the ACL that runs after the SMTP DATA command or the ACL for
31331 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31332
31333 To allow for further customization to a site's own requirements, there is the
31334 possibility of linking Exim with a private message scanning function, written
31335 in C. If you want to run code that is written in something other than C, you
31336 can of course use a little C stub to call it.
31337
31338 The local scan function is run once for every incoming message, at the point
31339 when Exim is just about to accept the message.
31340 It can therefore be used to control non-SMTP messages from local processes as
31341 well as messages arriving via SMTP.
31342
31343 Exim applies a timeout to calls of the local scan function, and there is an
31344 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31345 Zero means &"no timeout"&.
31346 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31347 before calling the local scan function, so that the most common types of crash
31348 are caught. If the timeout is exceeded or one of those signals is caught, the
31349 incoming message is rejected with a temporary error if it is an SMTP message.
31350 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31351 code. The incident is logged on the main and reject logs.
31352
31353
31354
31355 .section "Building Exim to use a local scan function" "SECID207"
31356 .cindex "&[local_scan()]& function" "building Exim to use"
31357 To make use of the local scan function feature, you must tell Exim where your
31358 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31359 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31360 directory, so you might set
31361 .code
31362 LOCAL_SCAN_SOURCE=Local/local_scan.c
31363 .endd
31364 for example. The function must be called &[local_scan()]&. It is called by
31365 Exim after it has received a message, when the success return code is about to
31366 be sent. This is after all the ACLs have been run. The return code from your
31367 function controls whether the message is actually accepted or not. There is a
31368 commented template function (that just accepts the message) in the file
31369 _src/local_scan.c_.
31370
31371 If you want to make use of Exim's run time configuration file to set options
31372 for your &[local_scan()]& function, you must also set
31373 .code
31374 LOCAL_SCAN_HAS_OPTIONS=yes
31375 .endd
31376 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31377
31378
31379
31380
31381 .section "API for local_scan()" "SECTapiforloc"
31382 .cindex "&[local_scan()]& function" "API description"
31383 You must include this line near the start of your code:
31384 .code
31385 #include "local_scan.h"
31386 .endd
31387 This header file defines a number of variables and other values, and the
31388 prototype for the function itself. Exim is coded to use unsigned char values
31389 almost exclusively, and one of the things this header defines is a shorthand
31390 for &`unsigned char`& called &`uschar`&.
31391 It also contains the following macro definitions, to simplify casting character
31392 strings and pointers to character strings:
31393 .code
31394 #define CS   (char *)
31395 #define CCS  (const char *)
31396 #define CSS  (char **)
31397 #define US   (unsigned char *)
31398 #define CUS  (const unsigned char *)
31399 #define USS  (unsigned char **)
31400 .endd
31401 The function prototype for &[local_scan()]& is:
31402 .code
31403 extern int local_scan(int fd, uschar **return_text);
31404 .endd
31405 The arguments are as follows:
31406
31407 .ilist
31408 &%fd%& is a file descriptor for the file that contains the body of the message
31409 (the -D file). The file is open for reading and writing, but updating it is not
31410 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31411
31412 The descriptor is positioned at character 19 of the file, which is the first
31413 character of the body itself, because the first 19 characters are the message
31414 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31415 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31416 case this changes in some future version.
31417 .next
31418 &%return_text%& is an address which you can use to return a pointer to a text
31419 string at the end of the function. The value it points to on entry is NULL.
31420 .endlist
31421
31422 The function must return an &%int%& value which is one of the following macros:
31423
31424 .vlist
31425 .vitem &`LOCAL_SCAN_ACCEPT`&
31426 .vindex "&$local_scan_data$&"
31427 The message is accepted. If you pass back a string of text, it is saved with
31428 the message, and made available in the variable &$local_scan_data$&. No
31429 newlines are permitted (if there are any, they are turned into spaces) and the
31430 maximum length of text is 1000 characters.
31431
31432 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31433 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31434 queued without immediate delivery, and is frozen.
31435
31436 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31437 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31438 queued without immediate delivery.
31439
31440 .vitem &`LOCAL_SCAN_REJECT`&
31441 The message is rejected; the returned text is used as an error message which is
31442 passed back to the sender and which is also logged. Newlines are permitted &--
31443 they cause a multiline response for SMTP rejections, but are converted to
31444 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31445 used.
31446
31447 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31448 The message is temporarily rejected; the returned text is used as an error
31449 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31450 problem"& is used.
31451
31452 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31453 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31454 message is not written to the reject log. It has the effect of unsetting the
31455 &%rejected_header%& log selector for just this rejection. If
31456 &%rejected_header%& is already unset (see the discussion of the
31457 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31458 same as LOCAL_SCAN_REJECT.
31459
31460 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31461 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31462 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31463 .endlist
31464
31465 If the message is not being received by interactive SMTP, rejections are
31466 reported by writing to &%stderr%& or by sending an email, as configured by the
31467 &%-oe%& command line options.
31468
31469
31470
31471 .section "Configuration options for local_scan()" "SECTconoptloc"
31472 .cindex "&[local_scan()]& function" "configuration options"
31473 It is possible to have option settings in the main configuration file
31474 that set values in static variables in the &[local_scan()]& module. If you
31475 want to do this, you must have the line
31476 .code
31477 LOCAL_SCAN_HAS_OPTIONS=yes
31478 .endd
31479 in your &_Local/Makefile_& when you build Exim. (This line is in
31480 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31481 file, you must define static variables to hold the option values, and a table
31482 to define them.
31483
31484 The table must be a vector called &%local_scan_options%&, of type
31485 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31486 and a pointer to the variable that holds the value. The entries must appear in
31487 alphabetical order. Following &%local_scan_options%& you must also define a
31488 variable called &%local_scan_options_count%& that contains the number of
31489 entries in the table. Here is a short example, showing two kinds of option:
31490 .code
31491 static int my_integer_option = 42;
31492 static uschar *my_string_option = US"a default string";
31493
31494 optionlist local_scan_options[] = {
31495   { "my_integer", opt_int,       &my_integer_option },
31496   { "my_string",  opt_stringptr, &my_string_option }
31497 };
31498
31499 int local_scan_options_count =
31500   sizeof(local_scan_options)/sizeof(optionlist);
31501 .endd
31502 The values of the variables can now be changed from Exim's runtime
31503 configuration file by including a local scan section as in this example:
31504 .code
31505 begin local_scan
31506 my_integer = 99
31507 my_string = some string of text...
31508 .endd
31509 The available types of option data are as follows:
31510
31511 .vlist
31512 .vitem &*opt_bool*&
31513 This specifies a boolean (true/false) option. The address should point to a
31514 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31515 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31516 whether such a variable has been set at all, you can initialize it to
31517 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31518 values.)
31519
31520 .vitem &*opt_fixed*&
31521 This specifies a fixed point number, such as is used for load averages.
31522 The address should point to a variable of type &`int`&. The value is stored
31523 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31524
31525 .vitem &*opt_int*&
31526 This specifies an integer; the address should point to a variable of type
31527 &`int`&. The value may be specified in any of the integer formats accepted by
31528 Exim.
31529
31530 .vitem &*opt_mkint*&
31531 This is the same as &%opt_int%&, except that when such a value is output in a
31532 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31533 printed with the suffix K or M.
31534
31535 .vitem &*opt_octint*&
31536 This also specifies an integer, but the value is always interpreted as an
31537 octal integer, whether or not it starts with the digit zero, and it is
31538 always output in octal.
31539
31540 .vitem &*opt_stringptr*&
31541 This specifies a string value; the address must be a pointer to a
31542 variable that points to a string (for example, of type &`uschar *`&).
31543
31544 .vitem &*opt_time*&
31545 This specifies a time interval value. The address must point to a variable of
31546 type &`int`&. The value that is placed there is a number of seconds.
31547 .endlist
31548
31549 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31550 out the values of all the &[local_scan()]& options.
31551
31552
31553
31554 .section "Available Exim variables" "SECID208"
31555 .cindex "&[local_scan()]& function" "available Exim variables"
31556 The header &_local_scan.h_& gives you access to a number of C variables. These
31557 are the only ones that are guaranteed to be maintained from release to release.
31558 Note, however, that you can obtain the value of any Exim expansion variable,
31559 including &$recipients$&, by calling &'expand_string()'&. The exported
31560 C variables are as follows:
31561
31562 .vlist
31563 .vitem &*int&~body_linecount*&
31564 This variable contains the number of lines in the message's body.
31565
31566 .vitem &*int&~body_zerocount*&
31567 This variable contains the number of binary zero bytes in the message's body.
31568
31569 .vitem &*unsigned&~int&~debug_selector*&
31570 This variable is set to zero when no debugging is taking place. Otherwise, it
31571 is a bitmap of debugging selectors. Two bits are identified for use in
31572 &[local_scan()]&; they are defined as macros:
31573
31574 .ilist
31575 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31576 testing option that is not privileged &-- any caller may set it. All the
31577 other selector bits can be set only by admin users.
31578
31579 .next
31580 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31581 by the &`+local_scan`& debug selector. It is not included in the default set
31582 of debugging bits.
31583 .endlist ilist
31584
31585 Thus, to write to the debugging output only when &`+local_scan`& has been
31586 selected, you should use code like this:
31587 .code
31588 if ((debug_selector & D_local_scan) != 0)
31589   debug_printf("xxx", ...);
31590 .endd
31591 .vitem &*uschar&~*expand_string_message*&
31592 After a failing call to &'expand_string()'& (returned value NULL), the
31593 variable &%expand_string_message%& contains the error message, zero-terminated.
31594
31595 .vitem &*header_line&~*header_list*&
31596 A pointer to a chain of header lines. The &%header_line%& structure is
31597 discussed below.
31598
31599 .vitem &*header_line&~*header_last*&
31600 A pointer to the last of the header lines.
31601
31602 .vitem &*uschar&~*headers_charset*&
31603 The value of the &%headers_charset%& configuration option.
31604
31605 .vitem &*BOOL&~host_checking*&
31606 This variable is TRUE during a host checking session that is initiated by the
31607 &%-bh%& command line option.
31608
31609 .vitem &*uschar&~*interface_address*&
31610 The IP address of the interface that received the message, as a string. This
31611 is NULL for locally submitted messages.
31612
31613 .vitem &*int&~interface_port*&
31614 The port on which this message was received. When testing with the &%-bh%&
31615 command line option, the value of this variable is -1 unless a port has been
31616 specified via the &%-oMi%& option.
31617
31618 .vitem &*uschar&~*message_id*&
31619 This variable contains Exim's message id for the incoming message (the value of
31620 &$message_exim_id$&) as a zero-terminated string.
31621
31622 .vitem &*uschar&~*received_protocol*&
31623 The name of the protocol by which the message was received.
31624
31625 .vitem &*int&~recipients_count*&
31626 The number of accepted recipients.
31627
31628 .vitem &*recipient_item&~*recipients_list*&
31629 .cindex "recipient" "adding in local scan"
31630 .cindex "recipient" "removing in local scan"
31631 The list of accepted recipients, held in a vector of length
31632 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31633 can add additional recipients by calling &'receive_add_recipient()'& (see
31634 below). You can delete recipients by removing them from the vector and
31635 adjusting the value in &%recipients_count%&. In particular, by setting
31636 &%recipients_count%& to zero you remove all recipients. If you then return the
31637 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31638 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31639 and then call &'receive_add_recipient()'& as often as needed.
31640
31641 .vitem &*uschar&~*sender_address*&
31642 The envelope sender address. For bounce messages this is the empty string.
31643
31644 .vitem &*uschar&~*sender_host_address*&
31645 The IP address of the sending host, as a string. This is NULL for
31646 locally-submitted messages.
31647
31648 .vitem &*uschar&~*sender_host_authenticated*&
31649 The name of the authentication mechanism that was used, or NULL if the message
31650 was not received over an authenticated SMTP connection.
31651
31652 .vitem &*uschar&~*sender_host_name*&
31653 The name of the sending host, if known.
31654
31655 .vitem &*int&~sender_host_port*&
31656 The port on the sending host.
31657
31658 .vitem &*BOOL&~smtp_input*&
31659 This variable is TRUE for all SMTP input, including BSMTP.
31660
31661 .vitem &*BOOL&~smtp_batched_input*&
31662 This variable is TRUE for BSMTP input.
31663
31664 .vitem &*int&~store_pool*&
31665 The contents of this variable control which pool of memory is used for new
31666 requests. See section &<<SECTmemhanloc>>& for details.
31667 .endlist
31668
31669
31670 .section "Structure of header lines" "SECID209"
31671 The &%header_line%& structure contains the members listed below.
31672 You can add additional header lines by calling the &'header_add()'& function
31673 (see below). You can cause header lines to be ignored (deleted) by setting
31674 their type to *.
31675
31676
31677 .vlist
31678 .vitem &*struct&~header_line&~*next*&
31679 A pointer to the next header line, or NULL for the last line.
31680
31681 .vitem &*int&~type*&
31682 A code identifying certain headers that Exim recognizes. The codes are printing
31683 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31684 Notice in particular that any header line whose type is * is not transmitted
31685 with the message. This flagging is used for header lines that have been
31686 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31687 lines.) Effectively, * means &"deleted"&.
31688
31689 .vitem &*int&~slen*&
31690 The number of characters in the header line, including the terminating and any
31691 internal newlines.
31692
31693 .vitem &*uschar&~*text*&
31694 A pointer to the text of the header. It always ends with a newline, followed by
31695 a zero byte. Internal newlines are preserved.
31696 .endlist
31697
31698
31699
31700 .section "Structure of recipient items" "SECID210"
31701 The &%recipient_item%& structure contains these members:
31702
31703 .vlist
31704 .vitem &*uschar&~*address*&
31705 This is a pointer to the recipient address as it was received.
31706
31707 .vitem &*int&~pno*&
31708 This is used in later Exim processing when top level addresses are created by
31709 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31710 and must always contain -1 at this stage.
31711
31712 .vitem &*uschar&~*errors_to*&
31713 If this value is not NULL, bounce messages caused by failing to deliver to the
31714 recipient are sent to the address it contains. In other words, it overrides the
31715 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31716 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31717 an unqualified address, Exim qualifies it using the domain from
31718 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31719 is NULL for all recipients.
31720 .endlist
31721
31722
31723
31724 .section "Available Exim functions" "SECID211"
31725 .cindex "&[local_scan()]& function" "available Exim functions"
31726 The header &_local_scan.h_& gives you access to a number of Exim functions.
31727 These are the only ones that are guaranteed to be maintained from release to
31728 release:
31729
31730 .vlist
31731 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31732        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31733
31734 This function creates a child process that runs the command specified by
31735 &%argv%&. The environment for the process is specified by &%envp%&, which can
31736 be NULL if no environment variables are to be passed. A new umask is supplied
31737 for the process in &%newumask%&.
31738
31739 Pipes to the standard input and output of the new process are set up
31740 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31741 standard error is cloned to the standard output. If there are any file
31742 descriptors &"in the way"& in the new process, they are closed. If the final
31743 argument is TRUE, the new process is made into a process group leader.
31744
31745 The function returns the pid of the new process, or -1 if things go wrong.
31746
31747 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31748 This function waits for a child process to terminate, or for a timeout (in
31749 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31750 return value is as follows:
31751
31752 .ilist
31753 >= 0
31754
31755 The process terminated by a normal exit and the value is the process
31756 ending status.
31757
31758 .next
31759 < 0 and > &--256
31760
31761 The process was terminated by a signal and the value is the negation of the
31762 signal number.
31763
31764 .next
31765 &--256
31766
31767 The process timed out.
31768 .next
31769 &--257
31770
31771 The was some other error in wait(); &%errno%& is still set.
31772 .endlist
31773
31774 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31775 This function provide you with a means of submitting a new message to
31776 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31777 want, but this packages it all up for you.) The function creates a pipe,
31778 forks a subprocess that is running
31779 .code
31780 exim -t -oem -oi -f <>
31781 .endd
31782 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31783 that is connected to the standard input. The yield of the function is the PID
31784 of the subprocess. You can then write a message to the file descriptor, with
31785 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31786
31787 When you have finished, call &'child_close()'& to wait for the process to
31788 finish and to collect its ending status. A timeout value of zero is usually
31789 fine in this circumstance. Unless you have made a mistake with the recipient
31790 addresses, you should get a return code of zero.
31791
31792
31793 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31794        *sender_authentication)*&
31795 This function is a more sophisticated version of &'child_open()'&. The command
31796 that it runs is:
31797 .display
31798 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31799 .endd
31800 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31801
31802
31803 .vitem &*void&~debug_printf(char&~*,&~...)*&
31804 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31805 output is written to the standard error stream. If no debugging is selected,
31806 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31807 conditional on the &`local_scan`& debug selector by coding like this:
31808 .code
31809 if ((debug_selector & D_local_scan) != 0)
31810   debug_printf("xxx", ...);
31811 .endd
31812
31813 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31814 This is an interface to Exim's string expansion code. The return value is the
31815 expanded string, or NULL if there was an expansion failure.
31816 The C variable &%expand_string_message%& contains an error message after an
31817 expansion failure. If expansion does not change the string, the return value is
31818 the pointer to the input string. Otherwise, the return value points to a new
31819 block of memory that was obtained by a call to &'store_get()'&. See section
31820 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31821
31822 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31823 This function allows you to an add additional header line at the end of the
31824 existing ones. The first argument is the type, and should normally be a space
31825 character. The second argument is a format string and any number of
31826 substitution arguments as for &[sprintf()]&. You may include internal newlines
31827 if you want, and you must ensure that the string ends with a newline.
31828
31829 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31830         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31831 This function adds a new header line at a specified point in the header
31832 chain. The header itself is specified as for &'header_add()'&.
31833
31834 If &%name%& is NULL, the new header is added at the end of the chain if
31835 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31836 NULL, the header lines are searched for the first non-deleted header that
31837 matches the name. If one is found, the new header is added before it if
31838 &%after%& is false. If &%after%& is true, the new header is added after the
31839 found header and any adjacent subsequent ones with the same name (even if
31840 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31841 option controls where the header is added. If it is true, addition is at the
31842 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31843 headers, or at the top if there are no &'Received:'& headers, you could use
31844 .code
31845 header_add_at_position(TRUE, US"Received", TRUE,
31846   ' ', "X-xxx: ...");
31847 .endd
31848 Normally, there is always at least one non-deleted &'Received:'& header, but
31849 there may not be if &%received_header_text%& expands to an empty string.
31850
31851
31852 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31853 This function removes header lines. If &%occurrence%& is zero or negative, all
31854 occurrences of the header are removed. If occurrence is greater than zero, that
31855 particular instance of the header is removed. If no header(s) can be found that
31856 match the specification, the function does nothing.
31857
31858
31859 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31860         int&~length,&~BOOL&~notdel)*&"
31861 This function tests whether the given header has the given name. It is not just
31862 a string comparison, because white space is permitted between the name and the
31863 colon. If the &%notdel%& argument is true, a false return is forced for all
31864 &"deleted"& headers; otherwise they are not treated specially. For example:
31865 .code
31866 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31867 .endd
31868 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31869 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31870 This function base64-encodes a string, which is passed by address and length.
31871 The text may contain bytes of any value, including zero. The result is passed
31872 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31873 zero-terminated.
31874
31875 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31876 This function decodes a base64-encoded string. Its arguments are a
31877 zero-terminated base64-encoded string and the address of a variable that is set
31878 to point to the result, which is in dynamic memory. The length of the decoded
31879 string is the yield of the function. If the input is invalid base64 data, the
31880 yield is -1. A zero byte is added to the end of the output string to make it
31881 easy to interpret as a C string (assuming it contains no zeros of its own). The
31882 added zero byte is not included in the returned count.
31883
31884 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31885 This function checks for a match in a domain list. Domains are always
31886 matched caselessly. The return value is one of the following:
31887 .display
31888 &`OK     `& match succeeded
31889 &`FAIL   `& match failed
31890 &`DEFER  `& match deferred
31891 .endd
31892 DEFER is usually caused by some kind of lookup defer, such as the
31893 inability to contact a database.
31894
31895 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31896         BOOL&~caseless)*&"
31897 This function checks for a match in a local part list. The third argument
31898 controls case-sensitivity. The return values are as for
31899 &'lss_match_domain()'&.
31900
31901 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31902         BOOL&~caseless)*&"
31903 This function checks for a match in an address list. The third argument
31904 controls the case-sensitivity of the local part match. The domain is always
31905 matched caselessly. The return values are as for &'lss_match_domain()'&.
31906
31907 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31908         uschar&~*list)*&"
31909 This function checks for a match in a host list. The most common usage is
31910 expected to be
31911 .code
31912 lss_match_host(sender_host_name, sender_host_address, ...)
31913 .endd
31914 .vindex "&$sender_host_address$&"
31915 An empty address field matches an empty item in the host list. If the host name
31916 is NULL, the name corresponding to &$sender_host_address$& is automatically
31917 looked up if a host name is required to match an item in the list. The return
31918 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31919 returns ERROR in the case when it had to look up a host name, but the lookup
31920 failed.
31921
31922 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31923         *format,&~...)*&"
31924 This function writes to Exim's log files. The first argument should be zero (it
31925 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31926 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31927 them. It specifies to which log or logs the message is written. The remaining
31928 arguments are a format and relevant insertion arguments. The string should not
31929 contain any newlines, not even at the end.
31930
31931
31932 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31933 This function adds an additional recipient to the message. The first argument
31934 is the recipient address. If it is unqualified (has no domain), it is qualified
31935 with the &%qualify_recipient%& domain. The second argument must always be -1.
31936
31937 This function does not allow you to specify a private &%errors_to%& address (as
31938 described with the structure of &%recipient_item%& above), because it pre-dates
31939 the addition of that field to the structure. However, it is easy to add such a
31940 value afterwards. For example:
31941 .code
31942  receive_add_recipient(US"monitor@mydom.example", -1);
31943  recipients_list[recipients_count-1].errors_to =
31944    US"postmaster@mydom.example";
31945 .endd
31946
31947 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31948 This is a convenience function to remove a named recipient from the list of
31949 recipients. It returns true if a recipient was removed, and false if no
31950 matching recipient could be found. The argument must be a complete email
31951 address.
31952 .endlist
31953
31954
31955 .cindex "RFC 2047"
31956 .vlist
31957 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31958   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31959 This function decodes strings that are encoded according to RFC 2047. Typically
31960 these are the contents of header lines. First, each &"encoded word"& is decoded
31961 from the Q or B encoding into a byte-string. Then, if provided with the name of
31962 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31963 made  to translate the result to the named character set. If this fails, the
31964 binary string is returned with an error message.
31965
31966 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31967 maximum MIME word length is enforced. The third argument is the target
31968 encoding, or NULL if no translation is wanted.
31969
31970 .cindex "binary zero" "in RFC 2047 decoding"
31971 .cindex "RFC 2047" "binary zero in"
31972 If a binary zero is encountered in the decoded string, it is replaced by the
31973 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31974 not be 0 because header lines are handled as zero-terminated strings.
31975
31976 The function returns the result of processing the string, zero-terminated; if
31977 &%lenptr%& is not NULL, the length of the result is set in the variable to
31978 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31979
31980 If an error is encountered, the function returns NULL and uses the &%error%&
31981 argument to return an error message. The variable pointed to by &%error%& is
31982 set to NULL if there is no error; it may be set non-NULL even when the function
31983 returns a non-NULL value if decoding was successful, but there was a problem
31984 with translation.
31985
31986
31987 .vitem &*int&~smtp_fflush(void)*&
31988 This function is used in conjunction with &'smtp_printf()'&, as described
31989 below.
31990
31991 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31992 The arguments of this function are like &[printf()]&; it writes to the SMTP
31993 output stream. You should use this function only when there is an SMTP output
31994 stream, that is, when the incoming message is being received via interactive
31995 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31996 is FALSE. If you want to test for an incoming message from another host (as
31997 opposed to a local process that used the &%-bs%& command line option), you can
31998 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31999 is involved.
32000
32001 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32002 output function, so it can be used for all forms of SMTP connection.
32003
32004 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32005 must start with an appropriate response code: 550 if you are going to return
32006 LOCAL_SCAN_REJECT, 451 if you are going to return
32007 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32008 initial lines of a multi-line response, the code must be followed by a hyphen
32009 to indicate that the line is not the final response line. You must also ensure
32010 that the lines you write terminate with CRLF. For example:
32011 .code
32012 smtp_printf("550-this is some extra info\r\n");
32013 return LOCAL_SCAN_REJECT;
32014 .endd
32015 Note that you can also create multi-line responses by including newlines in
32016 the data returned via the &%return_text%& argument. The added value of using
32017 &'smtp_printf()'& is that, for instance, you could introduce delays between
32018 multiple output lines.
32019
32020 The &'smtp_printf()'& function does not return any error indication, because it
32021 does not automatically flush pending output, and therefore does not test
32022 the state of the stream. (In the main code of Exim, flushing and error
32023 detection is done when Exim is ready for the next SMTP input command.) If
32024 you want to flush the output and check for an error (for example, the
32025 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32026 arguments. It flushes the output stream, and returns a non-zero value if there
32027 is an error.
32028
32029 .vitem &*void&~*store_get(int)*&
32030 This function accesses Exim's internal store (memory) manager. It gets a new
32031 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32032 runs out of memory. See the next section for a discussion of memory handling.
32033
32034 .vitem &*void&~*store_get_perm(int)*&
32035 This function is like &'store_get()'&, but it always gets memory from the
32036 permanent pool. See the next section for a discussion of memory handling.
32037
32038 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32039 See below.
32040
32041 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32042 See below.
32043
32044 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32045 These three functions create strings using Exim's dynamic memory facilities.
32046 The first makes a copy of an entire string. The second copies up to a maximum
32047 number of characters, indicated by the second argument. The third uses a format
32048 and insertion arguments to create a new string. In each case, the result is a
32049 pointer to a new string in the current memory pool. See the next section for
32050 more discussion.
32051 .endlist
32052
32053
32054
32055 .section "More about Exim's memory handling" "SECTmemhanloc"
32056 .cindex "&[local_scan()]& function" "memory handling"
32057 No function is provided for freeing memory, because that is never needed.
32058 The dynamic memory that Exim uses when receiving a message is automatically
32059 recycled if another message is received by the same process (this applies only
32060 to incoming SMTP connections &-- other input methods can supply only one
32061 message at a time). After receiving the last message, a reception process
32062 terminates.
32063
32064 Because it is recycled, the normal dynamic memory cannot be used for holding
32065 data that must be preserved over a number of incoming messages on the same SMTP
32066 connection. However, Exim in fact uses two pools of dynamic memory; the second
32067 one is not recycled, and can be used for this purpose.
32068
32069 If you want to allocate memory that remains available for subsequent messages
32070 in the same SMTP connection, you should set
32071 .code
32072 store_pool = POOL_PERM
32073 .endd
32074 before calling the function that does the allocation. There is no need to
32075 restore the value if you do not need to; however, if you do want to revert to
32076 the normal pool, you can either restore the previous value of &%store_pool%& or
32077 set it explicitly to POOL_MAIN.
32078
32079 The pool setting applies to all functions that get dynamic memory, including
32080 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32081 There is also a convenience function called &'store_get_perm()'& that gets a
32082 block of memory from the permanent pool while preserving the value of
32083 &%store_pool%&.
32084 .ecindex IIDlosca
32085
32086
32087
32088
32089 . ////////////////////////////////////////////////////////////////////////////
32090 . ////////////////////////////////////////////////////////////////////////////
32091
32092 .chapter "System-wide message filtering" "CHAPsystemfilter"
32093 .scindex IIDsysfil1 "filter" "system filter"
32094 .scindex IIDsysfil2 "filtering all mail"
32095 .scindex IIDsysfil3 "system filter"
32096 The previous chapters (on ACLs and the local scan function) describe checks
32097 that can be applied to messages before they are accepted by a host. There is
32098 also a mechanism for checking messages once they have been received, but before
32099 they are delivered. This is called the &'system filter'&.
32100
32101 The system filter operates in a similar manner to users' filter files, but it
32102 is run just once per message (however many recipients the message has).
32103 It should not normally be used as a substitute for routing, because &%deliver%&
32104 commands in a system router provide new envelope recipient addresses.
32105 The system filter must be an Exim filter. It cannot be a Sieve filter.
32106
32107 The system filter is run at the start of a delivery attempt, before any routing
32108 is done. If a message fails to be completely delivered at the first attempt,
32109 the system filter is run again at the start of every retry.
32110 If you want your filter to do something only once per message, you can make use
32111 of the &%first_delivery%& condition in an &%if%& command in the filter to
32112 prevent it happening on retries.
32113
32114 .vindex "&$domain$&"
32115 .vindex "&$local_part$&"
32116 &*Warning*&: Because the system filter runs just once, variables that are
32117 specific to individual recipient addresses, such as &$local_part$& and
32118 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32119 you want to run a centrally-specified filter for each recipient address
32120 independently, you can do so by setting up a suitable &(redirect)& router, as
32121 described in section &<<SECTperaddfil>>& below.
32122
32123
32124 .section "Specifying a system filter" "SECID212"
32125 .cindex "uid (user id)" "system filter"
32126 .cindex "gid (group id)" "system filter"
32127 The name of the file that contains the system filter must be specified by
32128 setting &%system_filter%&. If you want the filter to run under a uid and gid
32129 other than root, you must also set &%system_filter_user%& and
32130 &%system_filter_group%& as appropriate. For example:
32131 .code
32132 system_filter = /etc/mail/exim.filter
32133 system_filter_user = exim
32134 .endd
32135 If a system filter generates any deliveries directly to files or pipes (via the
32136 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32137 specified by setting &%system_filter_file_transport%& and
32138 &%system_filter_pipe_transport%&, respectively. Similarly,
32139 &%system_filter_reply_transport%& must be set to handle any messages generated
32140 by the &%reply%& command.
32141
32142
32143 .section "Testing a system filter" "SECID213"
32144 You can run simple tests of a system filter in the same way as for a user
32145 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32146 are permitted only in system filters are recognized.
32147
32148 If you want to test the combined effect of a system filter and a user filter,
32149 you can use both &%-bF%& and &%-bf%& on the same command line.
32150
32151
32152
32153 .section "Contents of a system filter" "SECID214"
32154 The language used to specify system filters is the same as for users' filter
32155 files. It is described in the separate end-user document &'Exim's interface to
32156 mail filtering'&. However, there are some additional features that are
32157 available only in system filters; these are described in subsequent sections.
32158 If they are encountered in a user's filter file or when testing with &%-bf%&,
32159 they cause errors.
32160
32161 .cindex "frozen messages" "manual thaw; testing in filter"
32162 There are two special conditions which, though available in users' filter
32163 files, are designed for use in system filters. The condition &%first_delivery%&
32164 is true only for the first attempt at delivering a message, and
32165 &%manually_thawed%& is true only if the message has been frozen, and
32166 subsequently thawed by an admin user. An explicit forced delivery counts as a
32167 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32168
32169 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32170 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32171 succeed, it will not be tried again.
32172 If you want Exim to retry an unseen delivery until it succeeds, you should
32173 arrange to set it up every time the filter runs.
32174
32175 When a system filter finishes running, the values of the variables &$n0$& &--
32176 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32177 users' filter files. Thus a system filter can, for example, set up &"scores"&
32178 to which users' filter files can refer.
32179
32180
32181
32182 .section "Additional variable for system filters" "SECID215"
32183 .vindex "&$recipients$&"
32184 The expansion variable &$recipients$&, containing a list of all the recipients
32185 of the message (separated by commas and white space), is available in system
32186 filters. It is not available in users' filters for privacy reasons.
32187
32188
32189
32190 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32191 .cindex "freezing messages"
32192 .cindex "message" "freezing"
32193 .cindex "message" "forced failure"
32194 .cindex "&%fail%&" "in system filter"
32195 .cindex "&%freeze%& in system filter"
32196 .cindex "&%defer%& in system filter"
32197 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32198 always available in system filters, but are not normally enabled in users'
32199 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32200 for the &(redirect)& router.) These commands can optionally be followed by the
32201 word &%text%& and a string containing an error message, for example:
32202 .code
32203 fail text "this message looks like spam to me"
32204 .endd
32205 The keyword &%text%& is optional if the next character is a double quote.
32206
32207 The &%defer%& command defers delivery of the original recipients of the
32208 message. The &%fail%& command causes all the original recipients to be failed,
32209 and a bounce message to be created. The &%freeze%& command suspends all
32210 delivery attempts for the original recipients. In all cases, any new deliveries
32211 that are specified by the filter are attempted as normal after the filter has
32212 run.
32213
32214 The &%freeze%& command is ignored if the message has been manually unfrozen and
32215 not manually frozen since. This means that automatic freezing by a system
32216 filter can be used as a way of checking out suspicious messages. If a message
32217 is found to be all right, manually unfreezing it allows it to be delivered.
32218
32219 .cindex "log" "&%fail%& command log line"
32220 .cindex "&%fail%&" "log line; reducing"
32221 The text given with a fail command is used as part of the bounce message as
32222 well as being written to the log. If the message is quite long, this can fill
32223 up a lot of log space when such failures are common. To reduce the size of the
32224 log message, Exim interprets the text in a special way if it starts with the
32225 two characters &`<<`& and contains &`>>`& later. The text between these two
32226 strings is written to the log, and the rest of the text is used in the bounce
32227 message. For example:
32228 .code
32229 fail "<<filter test 1>>Your message is rejected \
32230      because it contains attachments that we are \
32231      not prepared to receive."
32232 .endd
32233
32234 .cindex "loop" "caused by &%fail%&"
32235 Take great care with the &%fail%& command when basing the decision to fail on
32236 the contents of the message, because the bounce message will of course include
32237 the contents of the original message and will therefore trigger the &%fail%&
32238 command again (causing a mail loop) unless steps are taken to prevent this.
32239 Testing the &%error_message%& condition is one way to prevent this. You could
32240 use, for example
32241 .code
32242 if $message_body contains "this is spam" and not error_message
32243 then fail text "spam is not wanted here" endif
32244 .endd
32245 though of course that might let through unwanted bounce messages. The
32246 alternative is clever checking of the body and/or headers to detect bounces
32247 generated by the filter.
32248
32249 The interpretation of a system filter file ceases after a
32250 &%defer%&,
32251 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32252 set up earlier in the filter file are honoured, so you can use a sequence such
32253 as
32254 .code
32255 mail ...
32256 freeze
32257 .endd
32258 to send a specified message when the system filter is freezing (or deferring or
32259 failing) a message. The normal deliveries for the message do not, of course,
32260 take place.
32261
32262
32263
32264 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32265 .cindex "header lines" "adding; in system filter"
32266 .cindex "header lines" "removing; in system filter"
32267 .cindex "filter" "header lines; adding/removing"
32268 Two filter commands that are available only in system filters are:
32269 .code
32270 headers add <string>
32271 headers remove <string>
32272 .endd
32273 The argument for the &%headers add%& is a string that is expanded and then
32274 added to the end of the message's headers. It is the responsibility of the
32275 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32276 space is ignored, and if the string is otherwise empty, or if the expansion is
32277 forced to fail, the command has no effect.
32278
32279 You can use &"\n"& within the string, followed by white space, to specify
32280 continued header lines. More than one header may be added in one command by
32281 including &"\n"& within the string without any following white space. For
32282 example:
32283 .code
32284 headers add "X-header-1: ....\n  \
32285              continuation of X-header-1 ...\n\
32286              X-header-2: ...."
32287 .endd
32288 Note that the header line continuation white space after the first newline must
32289 be placed before the backslash that continues the input string, because white
32290 space after input continuations is ignored.
32291
32292 The argument for &%headers remove%& is a colon-separated list of header names.
32293 This command applies only to those headers that are stored with the message;
32294 those that are added at delivery time (such as &'Envelope-To:'& and
32295 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32296 header with the same name, they are all removed.
32297
32298 The &%headers%& command in a system filter makes an immediate change to the set
32299 of header lines that was received with the message (with possible additions
32300 from ACL processing). Subsequent commands in the system filter operate on the
32301 modified set, which also forms the basis for subsequent message delivery.
32302 Unless further modified during routing or transporting, this set of headers is
32303 used for all recipients of the message.
32304
32305 During routing and transporting, the variables that refer to the contents of
32306 header lines refer only to those lines that are in this set. Thus, header lines
32307 that are added by a system filter are visible to users' filter files and to all
32308 routers and transports. This contrasts with the manipulation of header lines by
32309 routers and transports, which is not immediate, but which instead is saved up
32310 until the message is actually being written (see section
32311 &<<SECTheadersaddrem>>&).
32312
32313 If the message is not delivered at the first attempt, header lines that were
32314 added by the system filter are stored with the message, and so are still
32315 present at the next delivery attempt. Header lines that were removed are still
32316 present, but marked &"deleted"& so that they are not transported with the
32317 message. For this reason, it is usual to make the &%headers%& command
32318 conditional on &%first_delivery%& so that the set of header lines is not
32319 modified more than once.
32320
32321 Because header modification in a system filter acts immediately, you have to
32322 use an indirect approach if you want to modify the contents of a header line.
32323 For example:
32324 .code
32325 headers add "Old-Subject: $h_subject:"
32326 headers remove "Subject"
32327 headers add "Subject: new subject (was: $h_old-subject:)"
32328 headers remove "Old-Subject"
32329 .endd
32330
32331
32332
32333 .section "Setting an errors address in a system filter" "SECID217"
32334 .cindex "envelope sender"
32335 In a system filter, if a &%deliver%& command is followed by
32336 .code
32337 errors_to <some address>
32338 .endd
32339 in order to change the envelope sender (and hence the error reporting) for that
32340 delivery, any address may be specified. (In a user filter, only the current
32341 user's address can be set.) For example, if some mail is being monitored, you
32342 might use
32343 .code
32344 unseen deliver monitor@spying.example errors_to root@local.example
32345 .endd
32346 to take a copy which would not be sent back to the normal error reporting
32347 address if its delivery failed.
32348
32349
32350
32351 .section "Per-address filtering" "SECTperaddfil"
32352 .vindex "&$domain$&"
32353 .vindex "&$local_part$&"
32354 In contrast to the system filter, which is run just once per message for each
32355 delivery attempt, it is also possible to set up a system-wide filtering
32356 operation that runs once for each recipient address. In this case, variables
32357 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32358 filter file could be made dependent on them. This is an example of a router
32359 which implements such a filter:
32360 .code
32361 central_filter:
32362   check_local_user
32363   driver = redirect
32364   domains = +local_domains
32365   file = /central/filters/$local_part
32366   no_verify
32367   allow_filter
32368   allow_freeze
32369 .endd
32370 The filter is run in a separate process under its own uid. Therefore, either
32371 &%check_local_user%& must be set (as above), in which case the filter is run as
32372 the local user, or the &%user%& option must be used to specify which user to
32373 use. If both are set, &%user%& overrides.
32374
32375 Care should be taken to ensure that none of the commands in the filter file
32376 specify a significant delivery if the message is to go on to be delivered to
32377 its intended recipient. The router will not then claim to have dealt with the
32378 address, so it will be passed on to subsequent routers to be delivered in the
32379 normal way.
32380 .ecindex IIDsysfil1
32381 .ecindex IIDsysfil2
32382 .ecindex IIDsysfil3
32383
32384
32385
32386
32387
32388
32389 . ////////////////////////////////////////////////////////////////////////////
32390 . ////////////////////////////////////////////////////////////////////////////
32391
32392 .chapter "Message processing" "CHAPmsgproc"
32393 .scindex IIDmesproc "message" "general processing"
32394 Exim performs various transformations on the sender and recipient addresses of
32395 all messages that it handles, and also on the messages' header lines. Some of
32396 these are optional and configurable, while others always take place. All of
32397 this processing, except rewriting as a result of routing, and the addition or
32398 removal of header lines while delivering, happens when a message is received,
32399 before it is placed on Exim's queue.
32400
32401 Some of the automatic processing takes place by default only for
32402 &"locally-originated"& messages. This adjective is used to describe messages
32403 that are not received over TCP/IP, but instead are passed to an Exim process on
32404 its standard input. This includes the interactive &"local SMTP"& case that is
32405 set up by the &%-bs%& command line option.
32406
32407 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32408 or ::1) are not considered to be locally-originated. Exim does not treat the
32409 loopback interface specially in any way.
32410
32411 If you want the loopback interface to be treated specially, you must ensure
32412 that there are appropriate entries in your ACLs.
32413
32414
32415
32416
32417 .section "Submission mode for non-local messages" "SECTsubmodnon"
32418 .cindex "message" "submission"
32419 .cindex "submission mode"
32420 Processing that happens automatically for locally-originated messages (unless
32421 &%suppress_local_fixups%& is set) can also be requested for messages that are
32422 received over TCP/IP. The term &"submission mode"& is used to describe this
32423 state. Submission mode is set by the modifier
32424 .code
32425 control = submission
32426 .endd
32427 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32428 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32429 a local submission, and is normally used when the source of the message is
32430 known to be an MUA running on a client host (as opposed to an MTA). For
32431 example, to set submission mode for messages originating on the IPv4 loopback
32432 interface, you could include the following in the MAIL ACL:
32433 .code
32434 warn  hosts = 127.0.0.1
32435       control = submission
32436 .endd
32437 .cindex "&%sender_retain%& submission option"
32438 There are some options that can be used when setting submission mode. A slash
32439 is used to separate options. For example:
32440 .code
32441 control = submission/sender_retain
32442 .endd
32443 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32444 true and &%local_from_check%& false for the current incoming message. The first
32445 of these allows an existing &'Sender:'& header in the message to remain, and
32446 the second suppresses the check to ensure that &'From:'& matches the
32447 authenticated sender. With this setting, Exim still fixes up messages by adding
32448 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32449 attempt to check sender authenticity in header lines.
32450
32451 When &%sender_retain%& is not set, a submission mode setting may specify a
32452 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32453 example:
32454 .code
32455 control = submission/domain=some.domain
32456 .endd
32457 The domain may be empty. How this value is used is described in sections
32458 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32459 that allows you to specify the user's full name for inclusion in a created
32460 &'Sender:'& or &'From:'& header line. For example:
32461 .code
32462 accept authenticated = *
32463        control = submission/domain=wonderland.example/\
32464                             name=${lookup {$authenticated_id} \
32465                                    lsearch {/etc/exim/namelist}}
32466 .endd
32467 Because the name may contain any characters, including slashes, the &%name%&
32468 option must be given last. The remainder of the string is used as the name. For
32469 the example above, if &_/etc/exim/namelist_& contains:
32470 .code
32471 bigegg:  Humpty Dumpty
32472 .endd
32473 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32474 line would be:
32475 .code
32476 Sender: Humpty Dumpty <bigegg@wonderland.example>
32477 .endd
32478 .cindex "return path" "in submission mode"
32479 By default, submission mode forces the return path to the same address as is
32480 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32481 specified, the return path is also left unchanged.
32482
32483 &*Note*&: The changes caused by submission mode take effect after the predata
32484 ACL. This means that any sender checks performed before the fix-ups use the
32485 untrusted sender address specified by the user, not the trusted sender address
32486 specified by submission mode. Although this might be slightly unexpected, it
32487 does mean that you can configure ACL checks to spot that a user is trying to
32488 spoof another's address.
32489
32490 .section "Line endings" "SECTlineendings"
32491 .cindex "line endings"
32492 .cindex "carriage return"
32493 .cindex "linefeed"
32494 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32495 linefeed) is the line ending for messages transmitted over the Internet using
32496 SMTP over TCP/IP. However, within individual operating systems, different
32497 conventions are used. For example, Unix-like systems use just LF, but others
32498 use CRLF or just CR.
32499
32500 Exim was designed for Unix-like systems, and internally, it stores messages
32501 using the system's convention of a single LF as a line terminator. When
32502 receiving a message, all line endings are translated to this standard format.
32503 Originally, it was thought that programs that passed messages directly to an
32504 MTA within an operating system would use that system's convention. Experience
32505 has shown that this is not the case; for example, there are Unix applications
32506 that use CRLF in this circumstance. For this reason, and for compatibility with
32507 other MTAs, the way Exim handles line endings for all messages is now as
32508 follows:
32509
32510 .ilist
32511 LF not preceded by CR is treated as a line ending.
32512 .next
32513 CR is treated as a line ending; if it is immediately followed by LF, the LF
32514 is ignored.
32515 .next
32516 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32517 nor a local message in the state where a line containing only a dot is a
32518 terminator.
32519 .next
32520 If a bare CR is encountered within a header line, an extra space is added after
32521 the line terminator so as not to end the header line. The reasoning behind this
32522 is that bare CRs in header lines are most likely either to be mistakes, or
32523 people trying to play silly games.
32524 .next
32525 If the first header line received in a message ends with CRLF, a subsequent
32526 bare LF in a header line is treated in the same way as a bare CR in a header
32527 line.
32528 .endlist
32529
32530
32531
32532
32533
32534 .section "Unqualified addresses" "SECID218"
32535 .cindex "unqualified addresses"
32536 .cindex "address" "qualification"
32537 By default, Exim expects every envelope address it receives from an external
32538 host to be fully qualified. Unqualified addresses cause negative responses to
32539 SMTP commands. However, because SMTP is used as a means of transporting
32540 messages from MUAs running on personal workstations, there is sometimes a
32541 requirement to accept unqualified addresses from specific hosts or IP networks.
32542
32543 Exim has two options that separately control which hosts may send unqualified
32544 sender or recipient addresses in SMTP commands, namely
32545 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32546 cases, if an unqualified address is accepted, it is qualified by adding the
32547 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32548
32549 .oindex "&%qualify_domain%&"
32550 .oindex "&%qualify_recipient%&"
32551 Unqualified addresses in header lines are automatically qualified for messages
32552 that are locally originated, unless the &%-bnq%& option is given on the command
32553 line. For messages received over SMTP, unqualified addresses in header lines
32554 are qualified only if unqualified addresses are permitted in SMTP commands. In
32555 other words, such qualification is also controlled by
32556 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32557
32558
32559
32560
32561 .section "The UUCP From line" "SECID219"
32562 .cindex "&""From""& line"
32563 .cindex "UUCP" "&""From""& line"
32564 .cindex "sender" "address"
32565 .oindex "&%uucp_from_pattern%&"
32566 .oindex "&%uucp_from_sender%&"
32567 .cindex "envelope sender"
32568 .cindex "Sendmail compatibility" "&""From""& line"
32569 Messages that have come from UUCP (and some other applications) often begin
32570 with a line containing the envelope sender and a timestamp, following the word
32571 &"From"&. Examples of two common formats are:
32572 .code
32573 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32574 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32575 .endd
32576 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32577 Exim recognizes such lines at the start of messages that are submitted to it
32578 via the command line (that is, on the standard input). It does not recognize
32579 such lines in incoming SMTP messages, unless the sending host matches
32580 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32581 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32582 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32583 default value matches the two common cases shown above and puts the address
32584 that follows &"From"& into &$1$&.
32585
32586 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32587 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32588 a trusted user, the message's sender address is constructed by expanding the
32589 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32590 then parsed as an RFC 2822 address. If there is no domain, the local part is
32591 qualified with &%qualify_domain%& unless it is the empty string. However, if
32592 the command line &%-f%& option is used, it overrides the &"From"& line.
32593
32594 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32595 sender address is not changed. This is also the case for incoming SMTP messages
32596 that are permitted to contain &"From"& lines.
32597
32598 Only one &"From"& line is recognized. If there is more than one, the second is
32599 treated as a data line that starts the body of the message, as it is not valid
32600 as a header line. This also happens if a &"From"& line is present in an
32601 incoming SMTP message from a source that is not permitted to send them.
32602
32603
32604
32605 .section "Resent- header lines" "SECID220"
32606 .cindex "&%Resent-%& header lines"
32607 RFC 2822 makes provision for sets of header lines starting with the string
32608 &`Resent-`& to be added to a message when it is resent by the original
32609 recipient to somebody else. These headers are &'Resent-Date:'&,
32610 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32611 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32612
32613 .blockquote
32614 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32615 processing of replies or other such automatic actions on messages.'&
32616 .endblockquote
32617
32618 This leaves things a bit vague as far as other processing actions such as
32619 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32620 follows:
32621
32622 .ilist
32623 A &'Resent-From:'& line that just contains the login id of the submitting user
32624 is automatically rewritten in the same way as &'From:'& (see below).
32625 .next
32626 If there's a rewriting rule for a particular header line, it is also applied to
32627 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32628 &'From:'& also rewrites &'Resent-From:'&.
32629 .next
32630 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32631 also removed.
32632 .next
32633 For a locally-submitted message,
32634 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32635 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32636 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32637 included in log lines in this case.
32638 .next
32639 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32640 &%Resent-%& header lines are present.
32641 .endlist
32642
32643
32644
32645
32646 .section "The Auto-Submitted: header line" "SECID221"
32647 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32648 includes the header line:
32649 .code
32650 Auto-Submitted: auto-replied
32651 .endd
32652
32653 .section "The Bcc: header line" "SECID222"
32654 .cindex "&'Bcc:'& header line"
32655 If Exim is called with the &%-t%& option, to take recipient addresses from a
32656 message's header, it removes any &'Bcc:'& header line that may exist (after
32657 extracting its addresses). If &%-t%& is not present on the command line, any
32658 existing &'Bcc:'& is not removed.
32659
32660
32661 .section "The Date: header line" "SECID223"
32662 .cindex "&'Date:'& header line"
32663 If a locally-generated or submission-mode message has no &'Date:'& header line,
32664 Exim adds one, using the current date and time, unless the
32665 &%suppress_local_fixups%& control has been specified.
32666
32667 .section "The Delivery-date: header line" "SECID224"
32668 .cindex "&'Delivery-date:'& header line"
32669 .oindex "&%delivery_date_remove%&"
32670 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32671 set. Exim can be configured to add them to the final delivery of messages. (See
32672 the generic &%delivery_date_add%& transport option.) They should not be present
32673 in messages in transit. If the &%delivery_date_remove%& configuration option is
32674 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32675 messages.
32676
32677
32678 .section "The Envelope-to: header line" "SECID225"
32679 .cindex "&'Envelope-to:'& header line"
32680 .oindex "&%envelope_to_remove%&"
32681 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32682 Exim can be configured to add them to the final delivery of messages. (See the
32683 generic &%envelope_to_add%& transport option.) They should not be present in
32684 messages in transit. If the &%envelope_to_remove%& configuration option is set
32685 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32686 messages.
32687
32688
32689 .section "The From: header line" "SECTthefrohea"
32690 .cindex "&'From:'& header line"
32691 .cindex "Sendmail compatibility" "&""From""& line"
32692 .cindex "message" "submission"
32693 .cindex "submission mode"
32694 If a submission-mode message does not contain a &'From:'& header line, Exim
32695 adds one if either of the following conditions is true:
32696
32697 .ilist
32698 The envelope sender address is not empty (that is, this is not a bounce
32699 message). The added header line copies the envelope sender address.
32700 .next
32701 .vindex "&$authenticated_id$&"
32702 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32703 .olist
32704 .vindex "&$qualify_domain$&"
32705 If no domain is specified by the submission control, the local part is
32706 &$authenticated_id$& and the domain is &$qualify_domain$&.
32707 .next
32708 If a non-empty domain is specified by the submission control, the local
32709 part is &$authenticated_id$&, and the domain is the specified domain.
32710 .next
32711 If an empty domain is specified by the submission control,
32712 &$authenticated_id$& is assumed to be the complete address.
32713 .endlist
32714 .endlist
32715
32716 A non-empty envelope sender takes precedence.
32717
32718 If a locally-generated incoming message does not contain a &'From:'& header
32719 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32720 containing the sender's address. The calling user's login name and full name
32721 are used to construct the address, as described in section &<<SECTconstr>>&.
32722 They are obtained from the password data by calling &[getpwuid()]& (but see the
32723 &%unknown_login%& configuration option). The address is qualified with
32724 &%qualify_domain%&.
32725
32726 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32727 &'From:'& header line containing just the unqualified login name of the calling
32728 user, this is replaced by an address containing the user's login name and full
32729 name as described in section &<<SECTconstr>>&.
32730
32731
32732 .section "The Message-ID: header line" "SECID226"
32733 .cindex "&'Message-ID:'& header line"
32734 .cindex "message" "submission"
32735 .oindex "&%message_id_header_text%&"
32736 If a locally-generated or submission-mode incoming message does not contain a
32737 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32738 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32739 to the message. If there are any &'Resent-:'& headers in the message, it
32740 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32741 message id, preceded by the letter E to ensure it starts with a letter, and
32742 followed by @ and the primary host name. Additional information can be included
32743 in this header line by setting the &%message_id_header_text%& and/or
32744 &%message_id_header_domain%& options.
32745
32746
32747 .section "The Received: header line" "SECID227"
32748 .cindex "&'Received:'& header line"
32749 A &'Received:'& header line is added at the start of every message. The
32750 contents are defined by the &%received_header_text%& configuration option, and
32751 Exim automatically adds a semicolon and a timestamp to the configured string.
32752
32753 The &'Received:'& header is generated as soon as the message's header lines
32754 have been received. At this stage, the timestamp in the &'Received:'& header
32755 line is the time that the message started to be received. This is the value
32756 that is seen by the DATA ACL and by the &[local_scan()]& function.
32757
32758 Once a message is accepted, the timestamp in the &'Received:'& header line is
32759 changed to the time of acceptance, which is (apart from a small delay while the
32760 -H spool file is written) the earliest time at which delivery could start.
32761
32762
32763 .section "The References: header line" "SECID228"
32764 .cindex "&'References:'& header line"
32765 Messages created by the &(autoreply)& transport include a &'References:'&
32766 header line. This is constructed according to the rules that are described in
32767 section 3.64 of RFC 2822 (which states that replies should contain such a
32768 header line), and section 3.14 of RFC 3834 (which states that automatic
32769 responses are not different in this respect). However, because some mail
32770 processing software does not cope well with very long header lines, no more
32771 than 12 message IDs are copied from the &'References:'& header line in the
32772 incoming message. If there are more than 12, the first one and then the final
32773 11 are copied, before adding the message ID of the incoming message.
32774
32775
32776
32777 .section "The Return-path: header line" "SECID229"
32778 .cindex "&'Return-path:'& header line"
32779 .oindex "&%return_path_remove%&"
32780 &'Return-path:'& header lines are defined as something an MTA may insert when
32781 it does the final delivery of messages. (See the generic &%return_path_add%&
32782 transport option.) Therefore, they should not be present in messages in
32783 transit. If the &%return_path_remove%& configuration option is set (the
32784 default), Exim removes &'Return-path:'& header lines from incoming messages.
32785
32786
32787
32788 .section "The Sender: header line" "SECTthesenhea"
32789 .cindex "&'Sender:'& header line"
32790 .cindex "message" "submission"
32791 For a locally-originated message from an untrusted user, Exim may remove an
32792 existing &'Sender:'& header line, and it may add a new one. You can modify
32793 these actions by setting the &%local_sender_retain%& option true, the
32794 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32795 control setting.
32796
32797 When a local message is received from an untrusted user and
32798 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32799 control has not been set, a check is made to see if the address given in the
32800 &'From:'& header line is the correct (local) sender of the message. The address
32801 that is expected has the login name as the local part and the value of
32802 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32803 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32804 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32805 line is added to the message.
32806
32807 If you set &%local_from_check%& false, this checking does not occur. However,
32808 the removal of an existing &'Sender:'& line still happens, unless you also set
32809 &%local_sender_retain%& to be true. It is not possible to set both of these
32810 options true at the same time.
32811
32812 .cindex "submission mode"
32813 By default, no processing of &'Sender:'& header lines is done for messages
32814 received over TCP/IP or for messages submitted by trusted users. However, when
32815 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32816 not specified on the submission control, the following processing takes place:
32817
32818 .vindex "&$authenticated_id$&"
32819 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32820 authenticated, and &$authenticated_id$& is not empty, a sender address is
32821 created as follows:
32822
32823 .ilist
32824 .vindex "&$qualify_domain$&"
32825 If no domain is specified by the submission control, the local part is
32826 &$authenticated_id$& and the domain is &$qualify_domain$&.
32827 .next
32828 If a non-empty domain is specified by the submission control, the local part
32829 is &$authenticated_id$&, and the domain is the specified domain.
32830 .next
32831 If an empty domain is specified by the submission control,
32832 &$authenticated_id$& is assumed to be the complete address.
32833 .endlist
32834
32835 This address is compared with the address in the &'From:'& header line. If they
32836 are different, a &'Sender:'& header line containing the created address is
32837 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32838 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32839
32840 .cindex "return path" "created from &'Sender:'&"
32841 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32842 the message (the envelope sender address) is changed to be the same address,
32843 except in the case of submission mode when &%sender_retain%& is specified.
32844
32845
32846
32847 .section "Adding and removing header lines in routers and transports" &&&
32848          "SECTheadersaddrem"
32849 .cindex "header lines" "adding; in router or transport"
32850 .cindex "header lines" "removing; in router or transport"
32851 When a message is delivered, the addition and removal of header lines can be
32852 specified in a system filter, or on any of the routers and transports that
32853 process the message. Section &<<SECTaddremheasys>>& contains details about
32854 modifying headers in a system filter. Header lines can also be added in an ACL
32855 as a message is received (see section &<<SECTaddheadacl>>&).
32856
32857 In contrast to what happens in a system filter, header modifications that are
32858 specified on routers and transports apply only to the particular recipient
32859 addresses that are being processed by those routers and transports. These
32860 changes do not actually take place until a copy of the message is being
32861 transported. Therefore, they do not affect the basic set of header lines, and
32862 they do not affect the values of the variables that refer to header lines.
32863
32864 &*Note*&: In particular, this means that any expansions in the configuration of
32865 the transport cannot refer to the modified header lines, because such
32866 expansions all occur before the message is actually transported.
32867
32868 For both routers and transports, the argument of a &%headers_add%&
32869 option must be in the form of one or more RFC 2822 header lines, separated by
32870 newlines (coded as &"\n"&). For example:
32871 .code
32872 headers_add = X-added-header: added by $primary_hostname\n\
32873               X-added-second: another added header line
32874 .endd
32875 Exim does not check the syntax of these added header lines.
32876
32877 Multiple &%headers_add%& options for a single router or transport can be
32878 specified; the values will append to a single list of header lines.
32879 Each header-line is separately expanded.
32880
32881 The argument of a &%headers_remove%& option must consist of a colon-separated
32882 list of header names. This is confusing, because header names themselves are
32883 often terminated by colons. In this case, the colons are the list separators,
32884 not part of the names. For example:
32885 .code
32886 headers_remove = return-receipt-to:acknowledge-to
32887 .endd
32888
32889 Multiple &%headers_remove%& options for a single router or transport can be
32890 specified; the arguments will append to a single header-names list.
32891 Each item is separately expanded.
32892 Note that colons in complex expansions which are used to
32893 form all or part of a &%headers_remove%& list
32894 will act as list separators.
32895
32896 When &%headers_add%& or &%headers_remove%& is specified on a router,
32897 items are expanded at routing time,
32898 and then associated with all addresses that are
32899 accepted by that router, and also with any new addresses that it generates. If
32900 an address passes through several routers as a result of aliasing or
32901 forwarding, the changes are cumulative.
32902
32903 .oindex "&%unseen%&"
32904 However, this does not apply to multiple routers that result from the use of
32905 the &%unseen%& option. Any header modifications that were specified by the
32906 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32907
32908 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32909 settings cannot be delivered together in a batch, so a transport is always
32910 dealing with a set of addresses that have the same header-processing
32911 requirements.
32912
32913 The transport starts by writing the original set of header lines that arrived
32914 with the message, possibly modified by the system filter. As it writes out
32915 these lines, it consults the list of header names that were attached to the
32916 recipient address(es) by &%headers_remove%& options in routers, and it also
32917 consults the transport's own &%headers_remove%& option. Header lines whose
32918 names are on either of these lists are not written out. If there are multiple
32919 instances of any listed header, they are all skipped.
32920
32921 After the remaining original header lines have been written, new header
32922 lines that were specified by routers' &%headers_add%& options are written, in
32923 the order in which they were attached to the address. These are followed by any
32924 header lines specified by the transport's &%headers_add%& option.
32925
32926 This way of handling header line modifications in routers and transports has
32927 the following consequences:
32928
32929 .ilist
32930 The original set of header lines, possibly modified by the system filter,
32931 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32932 to it, at all times.
32933 .next
32934 Header lines that are added by a router's
32935 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32936 expansion syntax in subsequent routers or the transport.
32937 .next
32938 Conversely, header lines that are specified for removal by &%headers_remove%&
32939 in a router remain visible to subsequent routers and the transport.
32940 .next
32941 Headers added to an address by &%headers_add%& in a router cannot be removed by
32942 a later router or by a transport.
32943 .next
32944 An added header can refer to the contents of an original header that is to be
32945 removed, even it has the same name as the added header. For example:
32946 .code
32947 headers_remove = subject
32948 headers_add = Subject: new subject (was: $h_subject:)
32949 .endd
32950 .endlist
32951
32952 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32953 for a &(redirect)& router that has the &%one_time%& option set.
32954
32955
32956
32957
32958
32959 .section "Constructed addresses" "SECTconstr"
32960 .cindex "address" "constructed"
32961 .cindex "constructed address"
32962 When Exim constructs a sender address for a locally-generated message, it uses
32963 the form
32964 .display
32965 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32966 .endd
32967 For example:
32968 .code
32969 Zaphod Beeblebrox <zaphod@end.univ.example>
32970 .endd
32971 The user name is obtained from the &%-F%& command line option if set, or
32972 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32973 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32974 ampersand character, this is replaced by the login name with the first letter
32975 upper cased, as is conventional in a number of operating systems. See the
32976 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32977 The &%unknown_username%& option can be used to specify user names in cases when
32978 there is no password file entry.
32979
32980 .cindex "RFC 2047"
32981 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32982 parts of it if necessary. In addition, if it contains any non-printing
32983 characters, it is encoded as described in RFC 2047, which defines a way of
32984 including non-ASCII characters in header lines. The value of the
32985 &%headers_charset%& option specifies the name of the encoding that is used (the
32986 characters are assumed to be in this encoding). The setting of
32987 &%print_topbitchars%& controls whether characters with the top bit set (that
32988 is, with codes greater than 127) count as printing characters or not.
32989
32990
32991
32992 .section "Case of local parts" "SECID230"
32993 .cindex "case of local parts"
32994 .cindex "local part" "case of"
32995 RFC 2822 states that the case of letters in the local parts of addresses cannot
32996 be assumed to be non-significant. Exim preserves the case of local parts of
32997 addresses, but by default it uses a lower-cased form when it is routing,
32998 because on most Unix systems, usernames are in lower case and case-insensitive
32999 routing is required. However, any particular router can be made to use the
33000 original case for local parts by setting the &%caseful_local_part%& generic
33001 router option.
33002
33003 .cindex "mixed-case login names"
33004 If you must have mixed-case user names on your system, the best way to proceed,
33005 assuming you want case-independent handling of incoming email, is to set up
33006 your first router to convert incoming local parts in your domains to the
33007 correct case by means of a file lookup. For example:
33008 .code
33009 correct_case:
33010   driver = redirect
33011   domains = +local_domains
33012   data = ${lookup{$local_part}cdb\
33013               {/etc/usercased.cdb}{$value}fail}\
33014               @$domain
33015 .endd
33016 For this router, the local part is forced to lower case by the default action
33017 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33018 up a new local part in the correct case. If you then set &%caseful_local_part%&
33019 on any subsequent routers which process your domains, they will operate on
33020 local parts with the correct case in a case-sensitive manner.
33021
33022
33023
33024 .section "Dots in local parts" "SECID231"
33025 .cindex "dot" "in local part"
33026 .cindex "local part" "dots in"
33027 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33028 part may not begin or end with a dot, nor have two consecutive dots in the
33029 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33030 empty components for compatibility.
33031
33032
33033
33034 .section "Rewriting addresses" "SECID232"
33035 .cindex "rewriting" "addresses"
33036 Rewriting of sender and recipient addresses, and addresses in headers, can
33037 happen automatically, or as the result of configuration options, as described
33038 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33039 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33040
33041 Automatic rewriting includes qualification, as mentioned above. The other case
33042 in which it can happen is when an incomplete non-local domain is given. The
33043 routing process may cause this to be expanded into the full domain name. For
33044 example, a header such as
33045 .code
33046 To: hare@teaparty
33047 .endd
33048 might get rewritten as
33049 .code
33050 To: hare@teaparty.wonderland.fict.example
33051 .endd
33052 Rewriting as a result of routing is the one kind of message processing that
33053 does not happen at input time, as it cannot be done until the address has
33054 been routed.
33055
33056 Strictly, one should not do &'any'& deliveries of a message until all its
33057 addresses have been routed, in case any of the headers get changed as a
33058 result of routing. However, doing this in practice would hold up many
33059 deliveries for unreasonable amounts of time, just because one address could not
33060 immediately be routed. Exim therefore does not delay other deliveries when
33061 routing of one or more addresses is deferred.
33062 .ecindex IIDmesproc
33063
33064
33065
33066 . ////////////////////////////////////////////////////////////////////////////
33067 . ////////////////////////////////////////////////////////////////////////////
33068
33069 .chapter "SMTP processing" "CHAPSMTP"
33070 .scindex IIDsmtpproc1 "SMTP" "processing details"
33071 .scindex IIDsmtpproc2 "LMTP" "processing details"
33072 Exim supports a number of different ways of using the SMTP protocol, and its
33073 LMTP variant, which is an interactive protocol for transferring messages into a
33074 closed mail store application. This chapter contains details of how SMTP is
33075 processed. For incoming mail, the following are available:
33076
33077 .ilist
33078 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33079 .next
33080 SMTP over the standard input and output (the &%-bs%& option);
33081 .next
33082 Batched SMTP on the standard input (the &%-bS%& option).
33083 .endlist
33084
33085 For mail delivery, the following are available:
33086
33087 .ilist
33088 SMTP over TCP/IP (the &(smtp)& transport);
33089 .next
33090 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33091 &"lmtp"&);
33092 .next
33093 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33094 transport);
33095 .next
33096 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33097 the &%use_bsmtp%& option set).
33098 .endlist
33099
33100 &'Batched SMTP'& is the name for a process in which batches of messages are
33101 stored in or read from files (or pipes), in a format in which SMTP commands are
33102 used to contain the envelope information.
33103
33104
33105
33106 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33107 .cindex "SMTP" "outgoing over TCP/IP"
33108 .cindex "outgoing SMTP over TCP/IP"
33109 .cindex "LMTP" "over TCP/IP"
33110 .cindex "outgoing LMTP over TCP/IP"
33111 .cindex "EHLO"
33112 .cindex "HELO"
33113 .cindex "SIZE option on MAIL command"
33114 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33115 The &%protocol%& option selects which protocol is to be used, but the actual
33116 processing is the same in both cases.
33117
33118 If, in response to its EHLO command, Exim is told that the SIZE
33119 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33120 command. The value of <&'n'&> is the message size plus the value of the
33121 &%size_addition%& option (default 1024) to allow for additions to the message
33122 such as per-transport header lines, or changes made in a
33123 .cindex "transport" "filter"
33124 .cindex "filter" "transport filter"
33125 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33126 suppressed.
33127
33128 If the remote server advertises support for PIPELINING, Exim uses the
33129 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33130 required for the transaction.
33131
33132 If the remote server advertises support for the STARTTLS command, and Exim
33133 was built to support TLS encryption, it tries to start a TLS session unless the
33134 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33135 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33136 is called for verification.
33137
33138 If the remote server advertises support for the AUTH command, Exim scans
33139 the authenticators configuration for any suitable client settings, as described
33140 in chapter &<<CHAPSMTPAUTH>>&.
33141
33142 .cindex "carriage return"
33143 .cindex "linefeed"
33144 Responses from the remote host are supposed to be terminated by CR followed by
33145 LF. However, there are known to be hosts that do not send CR characters, so in
33146 order to be able to interwork with such hosts, Exim treats LF on its own as a
33147 line terminator.
33148
33149 If a message contains a number of different addresses, all those with the same
33150 characteristics (for example, the same envelope sender) that resolve to the
33151 same set of hosts, in the same order, are sent in a single SMTP transaction,
33152 even if they are for different domains, unless there are more than the setting
33153 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33154 they are split into groups containing no more than &%max_rcpt%&s addresses
33155 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33156 in parallel sessions. The order of hosts with identical MX values is not
33157 significant when checking whether addresses can be batched in this way.
33158
33159 When the &(smtp)& transport suffers a temporary failure that is not
33160 message-related, Exim updates its transport-specific database, which contains
33161 records indexed by host name that remember which messages are waiting for each
33162 particular host. It also updates the retry database with new retry times.
33163
33164 .cindex "hints database" "retry keys"
33165 Exim's retry hints are based on host name plus IP address, so if one address of
33166 a multi-homed host is broken, it will soon be skipped most of the time.
33167 See the next section for more detail about error handling.
33168
33169 .cindex "SMTP" "passed connection"
33170 .cindex "SMTP" "batching over TCP/IP"
33171 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33172 looks in the hints database for the transport to see if there are any queued
33173 messages waiting for the host to which it is connected. If it finds one, it
33174 creates a new Exim process using the &%-MC%& option (which can only be used by
33175 a process running as root or the Exim user) and passes the TCP/IP socket to it
33176 so that it can deliver another message using the same socket. The new process
33177 does only those deliveries that are routed to the connected host, and may in
33178 turn pass the socket on to a third process, and so on.
33179
33180 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33181 limit the number of messages sent down a single TCP/IP connection.
33182
33183 .cindex "asterisk" "after IP address"
33184 The second and subsequent messages delivered down an existing connection are
33185 identified in the main log by the addition of an asterisk after the closing
33186 square bracket of the IP address.
33187
33188
33189
33190
33191 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33192 .cindex "error" "in outgoing SMTP"
33193 .cindex "SMTP" "errors in outgoing"
33194 .cindex "host" "error"
33195 Three different kinds of error are recognized for outgoing SMTP: host errors,
33196 message errors, and recipient errors.
33197
33198 .vlist
33199 .vitem "&*Host errors*&"
33200 A host error is not associated with a particular message or with a
33201 particular recipient of a message. The host errors are:
33202
33203 .ilist
33204 Connection refused or timed out,
33205 .next
33206 Any error response code on connection,
33207 .next
33208 Any error response code to EHLO or HELO,
33209 .next
33210 Loss of connection at any time, except after &"."&,
33211 .next
33212 I/O errors at any time,
33213 .next
33214 Timeouts during the session, other than in response to MAIL, RCPT or
33215 the &"."& at the end of the data.
33216 .endlist ilist
33217
33218 For a host error, a permanent error response on connection, or in response to
33219 EHLO, causes all addresses routed to the host to be failed. Any other host
33220 error causes all addresses to be deferred, and retry data to be created for the
33221 host. It is not tried again, for any message, until its retry time arrives. If
33222 the current set of addresses are not all delivered in this run (to some
33223 alternative host), the message is added to the list of those waiting for this
33224 host, so if it is still undelivered when a subsequent successful delivery is
33225 made to the host, it will be sent down the same SMTP connection.
33226
33227 .vitem "&*Message errors*&"
33228 .cindex "message" "error"
33229 A message error is associated with a particular message when sent to a
33230 particular host, but not with a particular recipient of the message. The
33231 message errors are:
33232
33233 .ilist
33234 Any error response code to MAIL, DATA, or the &"."& that terminates
33235 the data,
33236 .next
33237 Timeout after MAIL,
33238 .next
33239 Timeout or loss of connection after the &"."& that terminates the data. A
33240 timeout after the DATA command itself is treated as a host error, as is loss of
33241 connection at any other time.
33242 .endlist ilist
33243
33244 For a message error, a permanent error response (5&'xx'&) causes all addresses
33245 to be failed, and a delivery error report to be returned to the sender. A
33246 temporary error response (4&'xx'&), or one of the timeouts, causes all
33247 addresses to be deferred. Retry data is not created for the host, but instead,
33248 a retry record for the combination of host plus message id is created. The
33249 message is not added to the list of those waiting for this host. This ensures
33250 that the failing message will not be sent to this host again until the retry
33251 time arrives. However, other messages that are routed to the host are not
33252 affected, so if it is some property of the message that is causing the error,
33253 it will not stop the delivery of other mail.
33254
33255 If the remote host specified support for the SIZE parameter in its response
33256 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33257 over-large message will cause a message error because the error arrives as a
33258 response to MAIL.
33259
33260 .vitem "&*Recipient errors*&"
33261 .cindex "recipient" "error"
33262 A recipient error is associated with a particular recipient of a message. The
33263 recipient errors are:
33264
33265 .ilist
33266 Any error response to RCPT,
33267 .next
33268 Timeout after RCPT.
33269 .endlist
33270
33271 For a recipient error, a permanent error response (5&'xx'&) causes the
33272 recipient address to be failed, and a bounce message to be returned to the
33273 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33274 address to be deferred, and routing retry data to be created for it. This is
33275 used to delay processing of the address in subsequent queue runs, until its
33276 routing retry time arrives. This applies to all messages, but because it
33277 operates only in queue runs, one attempt will be made to deliver a new message
33278 to the failing address before the delay starts to operate. This ensures that,
33279 if the failure is really related to the message rather than the recipient
33280 (&"message too big for this recipient"& is a possible example), other messages
33281 have a chance of getting delivered. If a delivery to the address does succeed,
33282 the retry information gets cleared, so all stuck messages get tried again, and
33283 the retry clock is reset.
33284
33285 The message is not added to the list of those waiting for this host. Use of the
33286 host for other messages is unaffected, and except in the case of a timeout,
33287 other recipients are processed independently, and may be successfully delivered
33288 in the current SMTP session. After a timeout it is of course impossible to
33289 proceed with the session, so all addresses get deferred. However, those other
33290 than the one that failed do not suffer any subsequent retry delays. Therefore,
33291 if one recipient is causing trouble, the others have a chance of getting
33292 through when a subsequent delivery attempt occurs before the failing
33293 recipient's retry time.
33294 .endlist
33295
33296 In all cases, if there are other hosts (or IP addresses) available for the
33297 current set of addresses (for example, from multiple MX records), they are
33298 tried in this run for any undelivered addresses, subject of course to their
33299 own retry data. In other words, recipient error retry data does not take effect
33300 until the next delivery attempt.
33301
33302 Some hosts have been observed to give temporary error responses to every
33303 MAIL command at certain times (&"insufficient space"& has been seen). It
33304 would be nice if such circumstances could be recognized, and defer data for the
33305 host itself created, but this is not possible within the current Exim design.
33306 What actually happens is that retry data for every (host, message) combination
33307 is created.
33308
33309 The reason that timeouts after MAIL and RCPT are treated specially is that
33310 these can sometimes arise as a result of the remote host's verification
33311 procedures. Exim makes this assumption, and treats them as if a temporary error
33312 response had been received. A timeout after &"."& is treated specially because
33313 it is known that some broken implementations fail to recognize the end of the
33314 message if the last character of the last line is a binary zero. Thus, it is
33315 helpful to treat this case as a message error.
33316
33317 Timeouts at other times are treated as host errors, assuming a problem with the
33318 host, or the connection to it. If a timeout after MAIL, RCPT,
33319 or &"."& is really a connection problem, the assumption is that at the next try
33320 the timeout is likely to occur at some other point in the dialogue, causing it
33321 then to be treated as a host error.
33322
33323 There is experimental evidence that some MTAs drop the connection after the
33324 terminating &"."& if they do not like the contents of the message for some
33325 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33326 should be given. That is why Exim treats this case as a message rather than a
33327 host error, in order not to delay other messages to the same host.
33328
33329
33330
33331
33332 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33333 .cindex "SMTP" "incoming over TCP/IP"
33334 .cindex "incoming SMTP over TCP/IP"
33335 .cindex "inetd"
33336 .cindex "daemon"
33337 Incoming SMTP messages can be accepted in one of two ways: by running a
33338 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33339 &_/etc/inetd.conf_& should be like this:
33340 .code
33341 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33342 .endd
33343 Exim distinguishes between this case and the case of a locally running user
33344 agent using the &%-bs%& option by checking whether or not the standard input is
33345 a socket. When it is, either the port must be privileged (less than 1024), or
33346 the caller must be root or the Exim user. If any other user passes a socket
33347 with an unprivileged port number, Exim prints a message on the standard error
33348 stream and exits with an error code.
33349
33350 By default, Exim does not make a log entry when a remote host connects or
33351 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33352 unexpected. It can be made to write such log entries by setting the
33353 &%smtp_connection%& log selector.
33354
33355 .cindex "carriage return"
33356 .cindex "linefeed"
33357 Commands from the remote host are supposed to be terminated by CR followed by
33358 LF. However, there are known to be hosts that do not send CR characters. In
33359 order to be able to interwork with such hosts, Exim treats LF on its own as a
33360 line terminator.
33361 Furthermore, because common code is used for receiving messages from all
33362 sources, a CR on its own is also interpreted as a line terminator. However, the
33363 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33364
33365 .cindex "EHLO" "invalid data"
33366 .cindex "HELO" "invalid data"
33367 One area that sometimes gives rise to problems concerns the EHLO or
33368 HELO commands. Some clients send syntactically invalid versions of these
33369 commands, which Exim rejects by default. (This is nothing to do with verifying
33370 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33371 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33372 match the broken hosts that send invalid commands.
33373
33374 .cindex "SIZE option on MAIL command"
33375 .cindex "MAIL" "SIZE option"
33376 The amount of disk space available is checked whenever SIZE is received on
33377 a MAIL command, independently of whether &%message_size_limit%& or
33378 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33379 false. A temporary error is given if there is not enough space. If
33380 &%check_spool_space%& is set, the check is for that amount of space plus the
33381 value given with SIZE, that is, it checks that the addition of the incoming
33382 message will not reduce the space below the threshold.
33383
33384 When a message is successfully received, Exim includes the local message id in
33385 its response to the final &"."& that terminates the data. If the remote host
33386 logs this text it can help with tracing what has happened to a message.
33387
33388 The Exim daemon can limit the number of simultaneous incoming connections it is
33389 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33390 number of simultaneous incoming connections from a single remote host (see the
33391 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33392 rejected using the SMTP temporary error code 421.
33393
33394 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33395 subprocess has finished, as this can get lost at busy times. Instead, it looks
33396 for completed subprocesses every time it wakes up. Provided there are other
33397 things happening (new incoming calls, starts of queue runs), completed
33398 processes will be noticed and tidied away. On very quiet systems you may
33399 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33400 it will be noticed when the daemon next wakes up.
33401
33402 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33403 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33404 high system load &-- for details see the &%smtp_accept_reserve%&,
33405 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33406 applies in both the daemon and &'inetd'& cases.
33407
33408 Exim normally starts a delivery process for each message received, though this
33409 can be varied by means of the &%-odq%& command line option and the
33410 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33411 number of simultaneously running delivery processes started in this way from
33412 SMTP input can be limited by the &%smtp_accept_queue%& and
33413 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33414 subsequently received messages are just put on the input queue without starting
33415 a delivery process.
33416
33417 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33418 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33419 started up from the &'inetd'& daemon, because in that case each connection is
33420 handled by an entirely independent Exim process. Control by load average is,
33421 however, available with &'inetd'&.
33422
33423 Exim can be configured to verify addresses in incoming SMTP commands as they
33424 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33425 to rewrite addresses at this time &-- before any syntax checking is done. See
33426 section &<<SECTrewriteS>>&.
33427
33428 Exim can also be configured to limit the rate at which a client host submits
33429 MAIL and RCPT commands in a single SMTP session. See the
33430 &%smtp_ratelimit_hosts%& option.
33431
33432
33433
33434 .section "Unrecognized SMTP commands" "SECID234"
33435 .cindex "SMTP" "unrecognized commands"
33436 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33437 commands during a single SMTP connection, it drops the connection after sending
33438 the error response to the last command. The default value for
33439 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33440 abuse that subvert web servers into making connections to SMTP ports; in these
33441 circumstances, a number of non-SMTP lines are sent first.
33442
33443
33444 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33445 .cindex "SMTP" "syntax errors"
33446 .cindex "SMTP" "protocol errors"
33447 A syntax error is detected if an SMTP command is recognized, but there is
33448 something syntactically wrong with its data, for example, a malformed email
33449 address in a RCPT command. Protocol errors include invalid command
33450 sequencing such as RCPT before MAIL. If Exim receives more than
33451 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33452 drops the connection after sending the error response to the last command. The
33453 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33454 broken clients that loop sending bad commands (yes, it has been seen).
33455
33456
33457
33458 .section "Use of non-mail SMTP commands" "SECID236"
33459 .cindex "SMTP" "non-mail commands"
33460 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33461 DATA. Exim counts such commands, and drops the connection if there are too
33462 many of them in a single SMTP session. This action catches some
33463 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33464 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33465 defines what &"too many"& means. Its default value is 10.
33466
33467 When a new message is expected, one occurrence of RSET is not counted. This
33468 allows a client to send one RSET between messages (this is not necessary,
33469 but some clients do it). Exim also allows one uncounted occurrence of HELO
33470 or EHLO, and one occurrence of STARTTLS between messages. After
33471 starting up a TLS session, another EHLO is expected, and so it too is not
33472 counted.
33473
33474 The first occurrence of AUTH in a connection, or immediately following
33475 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33476 RCPT, DATA, and QUIT are counted.
33477
33478 You can control which hosts are subject to the limit set by
33479 &%smtp_accept_max_nonmail%& by setting
33480 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33481 the limit apply to all hosts. This option means that you can exclude any
33482 specific badly-behaved hosts that you have to live with.
33483
33484
33485
33486
33487 .section "The VRFY and EXPN commands" "SECID237"
33488 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33489 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33490 appropriate) in order to decide whether the command should be accepted or not.
33491 If no ACL is defined, the command is rejected.
33492
33493 .cindex "VRFY" "processing"
33494 When VRFY is accepted, it runs exactly the same code as when Exim is
33495 called with the &%-bv%& option.
33496
33497 .cindex "EXPN" "processing"
33498 When EXPN is accepted, a single-level expansion of the address is done.
33499 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33500 than a verification (the &%-bv%& option). If an unqualified local part is given
33501 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33502 of VRFY and EXPN commands are logged on the main and reject logs, and
33503 VRFY verification failures are logged on the main log for consistency with
33504 RCPT failures.
33505
33506
33507
33508 .section "The ETRN command" "SECTETRN"
33509 .cindex "ETRN" "processing"
33510 RFC 1985 describes an SMTP command called ETRN that is designed to
33511 overcome the security problems of the TURN command (which has fallen into
33512 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33513 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33514 should be accepted or not. If no ACL is defined, the command is rejected.
33515
33516 The ETRN command is concerned with &"releasing"& messages that are awaiting
33517 delivery to certain hosts. As Exim does not organize its message queue by host,
33518 the only form of ETRN that is supported by default is the one where the
33519 text starts with the &"#"& prefix, in which case the remainder of the text is
33520 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33521 the &%-R%& option to happen, with the remainder of the ETRN text as its
33522 argument. For example,
33523 .code
33524 ETRN #brigadoon
33525 .endd
33526 runs the command
33527 .code
33528 exim -R brigadoon
33529 .endd
33530 which causes a delivery attempt on all messages with undelivered addresses
33531 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33532 default), Exim prevents the simultaneous execution of more than one queue run
33533 for the same argument string as a result of an ETRN command. This stops
33534 a misbehaving client from starting more than one queue runner at once.
33535
33536 .cindex "hints database" "ETRN serialization"
33537 Exim implements the serialization by means of a hints database in which a
33538 record is written whenever a process is started by ETRN, and deleted when
33539 the process completes. However, Exim does not keep the SMTP session waiting for
33540 the ETRN process to complete. Once ETRN is accepted, the client is sent
33541 a &"success"& return code. Obviously there is scope for hints records to get
33542 left lying around if there is a system or program crash. To guard against this,
33543 Exim ignores any records that are more than six hours old.
33544
33545 .oindex "&%smtp_etrn_command%&"
33546 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33547 used. This specifies a command that is run whenever ETRN is received,
33548 whatever the form of its argument. For
33549 example:
33550 .code
33551 smtp_etrn_command = /etc/etrn_command $domain \
33552                     $sender_host_address
33553 .endd
33554 .vindex "&$domain$&"
33555 The string is split up into arguments which are independently expanded. The
33556 expansion variable &$domain$& is set to the argument of the ETRN command,
33557 and no syntax checking is done on the contents of this argument. Exim does not
33558 wait for the command to complete, so its status code is not checked. Exim runs
33559 under its own uid and gid when receiving incoming SMTP, so it is not possible
33560 for it to change them before running the command.
33561
33562
33563
33564 .section "Incoming local SMTP" "SECID238"
33565 .cindex "SMTP" "local incoming"
33566 Some user agents use SMTP to pass messages to their local MTA using the
33567 standard input and output, as opposed to passing the envelope on the command
33568 line and writing the message to the standard input. This is supported by the
33569 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33570 messages over TCP/IP (including the use of ACLs), except that the envelope
33571 sender given in a MAIL command is ignored unless the caller is trusted. In
33572 an ACL you can detect this form of SMTP input by testing for an empty host
33573 identification. It is common to have this as the first line in the ACL that
33574 runs for RCPT commands:
33575 .code
33576 accept hosts = :
33577 .endd
33578 This accepts SMTP messages from local processes without doing any other tests.
33579
33580
33581
33582 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33583 .cindex "SMTP" "batched outgoing"
33584 .cindex "batched SMTP output"
33585 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33586 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33587 be output in BSMTP format. No SMTP responses are possible for this form of
33588 delivery. All it is doing is using SMTP commands as a way of transmitting the
33589 envelope along with the message.
33590
33591 The message is written to the file or pipe preceded by the SMTP commands
33592 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33593 the message that start with a dot have an extra dot added. The SMTP command
33594 HELO is not normally used. If it is required, the &%message_prefix%& option
33595 can be used to specify it.
33596
33597 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33598 one recipient address at a time by default. However, you can arrange for them
33599 to handle several addresses at once by setting the &%batch_max%& option. When
33600 this is done for BSMTP, messages may contain multiple RCPT commands. See
33601 chapter &<<CHAPbatching>>& for more details.
33602
33603 .vindex "&$host$&"
33604 When one or more addresses are routed to a BSMTP transport by a router that
33605 sets up a host list, the name of the first host on the list is available to the
33606 transport in the variable &$host$&. Here is an example of such a transport and
33607 router:
33608 .code
33609 begin routers
33610 route_append:
33611   driver = manualroute
33612   transport = smtp_appendfile
33613   route_list = domain.example  batch.host.example
33614
33615 begin transports
33616 smtp_appendfile:
33617   driver = appendfile
33618   directory = /var/bsmtp/$host
33619   batch_max = 1000
33620   use_bsmtp
33621   user = exim
33622 .endd
33623 This causes messages addressed to &'domain.example'& to be written in BSMTP
33624 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33625 message (unless there are more than 1000 recipients).
33626
33627
33628
33629 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33630 .cindex "SMTP" "batched incoming"
33631 .cindex "batched SMTP input"
33632 The &%-bS%& command line option causes Exim to accept one or more messages by
33633 reading SMTP on the standard input, but to generate no responses. If the caller
33634 is trusted, the senders in the MAIL commands are believed; otherwise the
33635 sender is always the caller of Exim. Unqualified senders and receivers are not
33636 rejected (there seems little point) but instead just get qualified. HELO
33637 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33638 as NOOP; QUIT quits.
33639
33640 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33641 ACL is run in the same way as for non-SMTP local input.
33642
33643 If an error is detected while reading a message, including a missing &"."& at
33644 the end, Exim gives up immediately. It writes details of the error to the
33645 standard output in a stylized way that the calling program should be able to
33646 make some use of automatically, for example:
33647 .code
33648 554 Unexpected end of file
33649 Transaction started in line 10
33650 Error detected in line 14
33651 .endd
33652 It writes a more verbose version, for human consumption, to the standard error
33653 file, for example:
33654 .code
33655 An error was detected while processing a file of BSMTP input.
33656 The error message was:
33657
33658 501 '>' missing at end of address
33659
33660 The SMTP transaction started in line 10.
33661 The error was detected in line 12.
33662 The SMTP command at fault was:
33663
33664 rcpt to:<malformed@in.com.plete
33665
33666 1 previous message was successfully processed.
33667 The rest of the batch was abandoned.
33668 .endd
33669 The return code from Exim is zero only if there were no errors. It is 1 if some
33670 messages were accepted before an error was detected, and 2 if no messages were
33671 accepted.
33672 .ecindex IIDsmtpproc1
33673 .ecindex IIDsmtpproc2
33674
33675
33676
33677 . ////////////////////////////////////////////////////////////////////////////
33678 . ////////////////////////////////////////////////////////////////////////////
33679
33680 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33681          "Customizing messages"
33682 When a message fails to be delivered, or remains on the queue for more than a
33683 configured amount of time, Exim sends a message to the original sender, or
33684 to an alternative configured address. The text of these messages is built into
33685 the code of Exim, but it is possible to change it, either by adding a single
33686 string, or by replacing each of the paragraphs by text supplied in a file.
33687
33688 The &'From:'& and &'To:'& header lines are automatically generated; you can
33689 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33690 option. Exim also adds the line
33691 .code
33692 Auto-Submitted: auto-generated
33693 .endd
33694 to all warning and bounce messages,
33695
33696
33697 .section "Customizing bounce messages" "SECID239"
33698 .cindex "customizing" "bounce message"
33699 .cindex "bounce message" "customizing"
33700 If &%bounce_message_text%& is set, its contents are included in the default
33701 message immediately after &"This message was created automatically by mail
33702 delivery software."& The string is not expanded. It is not used if
33703 &%bounce_message_file%& is set.
33704
33705 When &%bounce_message_file%& is set, it must point to a template file for
33706 constructing error messages. The file consists of a series of text items,
33707 separated by lines consisting of exactly four asterisks. If the file cannot be
33708 opened, default text is used and a message is written to the main and panic
33709 logs. If any text item in the file is empty, default text is used for that
33710 item.
33711
33712 .vindex "&$bounce_recipient$&"
33713 .vindex "&$bounce_return_size_limit$&"
33714 Each item of text that is read from the file is expanded, and there are two
33715 expansion variables which can be of use here: &$bounce_recipient$& is set to
33716 the recipient of an error message while it is being created, and
33717 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33718 option, rounded to a whole number.
33719
33720 The items must appear in the file in the following order:
33721
33722 .ilist
33723 The first item is included in the headers, and should include at least a
33724 &'Subject:'& header. Exim does not check the syntax of these headers.
33725 .next
33726 The second item forms the start of the error message. After it, Exim lists the
33727 failing addresses with their error messages.
33728 .next
33729 The third item is used to introduce any text from pipe transports that is to be
33730 returned to the sender. It is omitted if there is no such text.
33731 .next
33732 .new
33733 The fourth, fifth and sixth items will be ignored and may be empty.
33734 The fields exist for back-compatibility
33735 .wen
33736 .endlist
33737
33738 The default state (&%bounce_message_file%& unset) is equivalent to the
33739 following file, in which the sixth item is empty. The &'Subject:'& and some
33740 other lines have been split in order to fit them on the page:
33741 .code
33742 Subject: Mail delivery failed
33743   ${if eq{$sender_address}{$bounce_recipient}
33744   {: returning message to sender}}
33745 ****
33746 This message was created automatically by mail delivery software.
33747
33748 A message ${if eq{$sender_address}{$bounce_recipient}
33749   {that you sent }{sent by
33750
33751 <$sender_address>
33752
33753 }}could not be delivered to all of its recipients.
33754 This is a permanent error. The following address(es) failed:
33755 ****
33756 The following text was generated during the delivery attempt(s):
33757 ****
33758 ------ This is a copy of the message, including all the headers.
33759   ------
33760 ****
33761 ------ The body of the message is $message_size characters long;
33762   only the first
33763 ------ $bounce_return_size_limit or so are included here.
33764 ****
33765 .endd
33766 .section "Customizing warning messages" "SECTcustwarn"
33767 .cindex "customizing" "warning message"
33768 .cindex "warning of delay" "customizing the message"
33769 The option &%warn_message_file%& can be pointed at a template file for use when
33770 warnings about message delays are created. In this case there are only three
33771 text sections:
33772
33773 .ilist
33774 The first item is included in the headers, and should include at least a
33775 &'Subject:'& header. Exim does not check the syntax of these headers.
33776 .next
33777 The second item forms the start of the warning message. After it, Exim lists
33778 the delayed addresses.
33779 .next
33780 The third item then ends the message.
33781 .endlist
33782
33783 The default state is equivalent to the following file, except that some lines
33784 have been split here, in order to fit them on the page:
33785 .code
33786 Subject: Warning: message $message_exim_id delayed
33787   $warn_message_delay
33788 ****
33789 This message was created automatically by mail delivery software.
33790
33791 A message ${if eq{$sender_address}{$warn_message_recipients}
33792 {that you sent }{sent by
33793
33794 <$sender_address>
33795
33796 }}has not been delivered to all of its recipients after
33797 more than $warn_message_delay on the queue on $primary_hostname.
33798
33799 The message identifier is:     $message_exim_id
33800 The subject of the message is: $h_subject
33801 The date of the message is:    $h_date
33802
33803 The following address(es) have not yet been delivered:
33804 ****
33805 No action is required on your part. Delivery attempts will
33806 continue for some time, and this warning may be repeated at
33807 intervals if the message remains undelivered. Eventually the
33808 mail delivery software will give up, and when that happens,
33809 the message will be returned to you.
33810 .endd
33811 .vindex "&$warn_message_delay$&"
33812 .vindex "&$warn_message_recipients$&"
33813 However, in the default state the subject and date lines are omitted if no
33814 appropriate headers exist. During the expansion of this file,
33815 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33816 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33817 of recipients for the warning message. There may be more than one if there are
33818 multiple addresses with different &%errors_to%& settings on the routers that
33819 handled them.
33820
33821
33822
33823
33824 . ////////////////////////////////////////////////////////////////////////////
33825 . ////////////////////////////////////////////////////////////////////////////
33826
33827 .chapter "Some common configuration settings" "CHAPcomconreq"
33828 This chapter discusses some configuration settings that seem to be fairly
33829 common. More examples and discussion can be found in the Exim book.
33830
33831
33832
33833 .section "Sending mail to a smart host" "SECID240"
33834 .cindex "smart host" "example router"
33835 If you want to send all mail for non-local domains to a &"smart host"&, you
33836 should replace the default &(dnslookup)& router with a router which does the
33837 routing explicitly:
33838 .code
33839 send_to_smart_host:
33840   driver = manualroute
33841   route_list = !+local_domains smart.host.name
33842   transport = remote_smtp
33843 .endd
33844 You can use the smart host's IP address instead of the name if you wish.
33845 If you are using Exim only to submit messages to a smart host, and not for
33846 receiving incoming messages, you can arrange for it to do the submission
33847 synchronously by setting the &%mua_wrapper%& option (see chapter
33848 &<<CHAPnonqueueing>>&).
33849
33850
33851
33852
33853 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33854 .cindex "mailing lists"
33855 Exim can be used to run simple mailing lists, but for large and/or complicated
33856 requirements, the use of additional specialized mailing list software such as
33857 Majordomo or Mailman is recommended.
33858
33859 The &(redirect)& router can be used to handle mailing lists where each list
33860 is maintained in a separate file, which can therefore be managed by an
33861 independent manager. The &%domains%& router option can be used to run these
33862 lists in a separate domain from normal mail. For example:
33863 .code
33864 lists:
33865   driver = redirect
33866   domains = lists.example
33867   file = /usr/lists/$local_part
33868   forbid_pipe
33869   forbid_file
33870   errors_to = $local_part-request@lists.example
33871   no_more
33872 .endd
33873 This router is skipped for domains other than &'lists.example'&. For addresses
33874 in that domain, it looks for a file that matches the local part. If there is no
33875 such file, the router declines, but because &%no_more%& is set, no subsequent
33876 routers are tried, and so the whole delivery fails.
33877
33878 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33879 expanded into a file name or a pipe delivery, which is usually inappropriate in
33880 a mailing list.
33881
33882 .oindex "&%errors_to%&"
33883 The &%errors_to%& option specifies that any delivery errors caused by addresses
33884 taken from a mailing list are to be sent to the given address rather than the
33885 original sender of the message. However, before acting on this, Exim verifies
33886 the error address, and ignores it if verification fails.
33887
33888 For example, using the configuration above, mail sent to
33889 &'dicts@lists.example'& is passed on to those addresses contained in
33890 &_/usr/lists/dicts_&, with error reports directed to
33891 &'dicts-request@lists.example'&, provided that this address can be verified.
33892 There could be a file called &_/usr/lists/dicts-request_& containing
33893 the address(es) of this particular list's manager(s), but other approaches,
33894 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33895 or &%local_part_suffix%& options) to handle addresses of the form
33896 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33897
33898
33899
33900 .section "Syntax errors in mailing lists" "SECID241"
33901 .cindex "mailing lists" "syntax errors in"
33902 If an entry in redirection data contains a syntax error, Exim normally defers
33903 delivery of the original address. That means that a syntax error in a mailing
33904 list holds up all deliveries to the list. This may not be appropriate when a
33905 list is being maintained automatically from data supplied by users, and the
33906 addresses are not rigorously checked.
33907
33908 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33909 entries that fail to parse, noting the incident in the log. If in addition
33910 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33911 whenever a broken address is skipped. It is usually appropriate to set
33912 &%syntax_errors_to%& to the same address as &%errors_to%&.
33913
33914
33915
33916 .section "Re-expansion of mailing lists" "SECID242"
33917 .cindex "mailing lists" "re-expansion of"
33918 Exim remembers every individual address to which a message has been delivered,
33919 in order to avoid duplication, but it normally stores only the original
33920 recipient addresses with a message. If all the deliveries to a mailing list
33921 cannot be done at the first attempt, the mailing list is re-expanded when the
33922 delivery is next tried. This means that alterations to the list are taken into
33923 account at each delivery attempt, so addresses that have been added to
33924 the list since the message arrived will therefore receive a copy of the
33925 message, even though it pre-dates their subscription.
33926
33927 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33928 on the &(redirect)& router. If this is done, any addresses generated by the
33929 router that fail to deliver at the first attempt are added to the message as
33930 &"top level"& addresses, and the parent address that generated them is marked
33931 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33932 subsequent delivery attempts. The disadvantage of this is that if any of the
33933 failing addresses are incorrect, correcting them in the file has no effect on
33934 pre-existing messages.
33935
33936 The original top-level address is remembered with each of the generated
33937 addresses, and is output in any log messages. However, any intermediate parent
33938 addresses are not recorded. This makes a difference to the log only if the
33939 &%all_parents%& selector is set, but for mailing lists there is normally only
33940 one level of expansion anyway.
33941
33942
33943
33944 .section "Closed mailing lists" "SECID243"
33945 .cindex "mailing lists" "closed"
33946 The examples so far have assumed open mailing lists, to which anybody may
33947 send mail. It is also possible to set up closed lists, where mail is accepted
33948 from specified senders only. This is done by making use of the generic
33949 &%senders%& option to restrict the router that handles the list.
33950
33951 The following example uses the same file as a list of recipients and as a list
33952 of permitted senders. It requires three routers:
33953 .code
33954 lists_request:
33955   driver = redirect
33956   domains = lists.example
33957   local_part_suffix = -request
33958   file = /usr/lists/$local_part$local_part_suffix
33959   no_more
33960
33961 lists_post:
33962   driver = redirect
33963   domains = lists.example
33964   senders = ${if exists {/usr/lists/$local_part}\
33965              {lsearch;/usr/lists/$local_part}{*}}
33966   file = /usr/lists/$local_part
33967   forbid_pipe
33968   forbid_file
33969   errors_to = $local_part-request@lists.example
33970   no_more
33971
33972 lists_closed:
33973   driver = redirect
33974   domains = lists.example
33975   allow_fail
33976   data = :fail: $local_part@lists.example is a closed mailing list
33977 .endd
33978 All three routers have the same &%domains%& setting, so for any other domains,
33979 they are all skipped. The first router runs only if the local part ends in
33980 &%-request%&. It handles messages to the list manager(s) by means of an open
33981 mailing list.
33982
33983 The second router runs only if the &%senders%& precondition is satisfied. It
33984 checks for the existence of a list that corresponds to the local part, and then
33985 checks that the sender is on the list by means of a linear search. It is
33986 necessary to check for the existence of the file before trying to search it,
33987 because otherwise Exim thinks there is a configuration error. If the file does
33988 not exist, the expansion of &%senders%& is *, which matches all senders. This
33989 means that the router runs, but because there is no list, declines, and
33990 &%no_more%& ensures that no further routers are run. The address fails with an
33991 &"unrouteable address"& error.
33992
33993 The third router runs only if the second router is skipped, which happens when
33994 a mailing list exists, but the sender is not on it. This router forcibly fails
33995 the address, giving a suitable error message.
33996
33997
33998
33999
34000 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34001 .cindex "VERP"
34002 .cindex "Variable Envelope Return Paths"
34003 .cindex "envelope sender"
34004 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34005 are a way of helping mailing list administrators discover which subscription
34006 address is the cause of a particular delivery failure. The idea is to encode
34007 the original recipient address in the outgoing envelope sender address, so that
34008 if the message is forwarded by another host and then subsequently bounces, the
34009 original recipient can be extracted from the recipient address of the bounce.
34010
34011 .oindex &%errors_to%&
34012 .oindex &%return_path%&
34013 Envelope sender addresses can be modified by Exim using two different
34014 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34015 list examples), or the &%return_path%& option on a transport. The second of
34016 these is effective only if the message is successfully delivered to another
34017 host; it is not used for errors detected on the local host (see the description
34018 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34019 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34020 .code
34021 verp_smtp:
34022   driver = smtp
34023   max_rcpt = 1
34024   return_path = \
34025     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34026       {$1-request+$local_part=$domain@your.dom.example}fail}
34027 .endd
34028 This has the effect of rewriting the return path (envelope sender) on outgoing
34029 SMTP messages, if the local part of the original return path ends in
34030 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34031 local part and domain of the recipient into the return path. Suppose, for
34032 example, that a message whose return path has been set to
34033 &'somelist-request@your.dom.example'& is sent to
34034 &'subscriber@other.dom.example'&. In the transport, the return path is
34035 rewritten as
34036 .code
34037 somelist-request+subscriber=other.dom.example@your.dom.example
34038 .endd
34039 .vindex "&$local_part$&"
34040 For this to work, you must tell Exim to send multiple copies of messages that
34041 have more than one recipient, so that each copy has just one recipient. This is
34042 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34043 might be sent to several different recipients in the same domain, in which case
34044 &$local_part$& is not available in the transport, because it is not unique.
34045
34046 Unless your host is doing nothing but mailing list deliveries, you should
34047 probably use a separate transport for the VERP deliveries, so as not to use
34048 extra resources in making one-per-recipient copies for other deliveries. This
34049 can easily be done by expanding the &%transport%& option in the router:
34050 .code
34051 dnslookup:
34052   driver = dnslookup
34053   domains = ! +local_domains
34054   transport = \
34055     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34056       {verp_smtp}{remote_smtp}}
34057   no_more
34058 .endd
34059 If you want to change the return path using &%errors_to%& in a router instead
34060 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34061 routers that handle mailing list addresses. This will ensure that all delivery
34062 errors, including those detected on the local host, are sent to the VERP
34063 address.
34064
34065 On a host that does no local deliveries and has no manual routing, only the
34066 &(dnslookup)& router needs to be changed. A special transport is not needed for
34067 SMTP deliveries. Every mailing list recipient has its own return path value,
34068 and so Exim must hand them to the transport one at a time. Here is an example
34069 of a &(dnslookup)& router that implements VERP:
34070 .code
34071 verp_dnslookup:
34072   driver = dnslookup
34073   domains = ! +local_domains
34074   transport = remote_smtp
34075   errors_to = \
34076     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34077      {$1-request+$local_part=$domain@your.dom.example}fail}
34078   no_more
34079 .endd
34080 Before you start sending out messages with VERPed return paths, you must also
34081 configure Exim to accept the bounce messages that come back to those paths.
34082 Typically this is done by setting a &%local_part_suffix%& option for a
34083 router, and using this to route the messages to wherever you want to handle
34084 them.
34085
34086 The overhead incurred in using VERP depends very much on the size of the
34087 message, the number of recipient addresses that resolve to the same remote
34088 host, and the speed of the connection over which the message is being sent. If
34089 a lot of addresses resolve to the same host and the connection is slow, sending
34090 a separate copy of the message for each address may take substantially longer
34091 than sending a single copy with many recipients (for which VERP cannot be
34092 used).
34093
34094
34095
34096
34097
34098
34099 .section "Virtual domains" "SECTvirtualdomains"
34100 .cindex "virtual domains"
34101 .cindex "domain" "virtual"
34102 The phrase &'virtual domain'& is unfortunately used with two rather different
34103 meanings:
34104
34105 .ilist
34106 A domain for which there are no real mailboxes; all valid local parts are
34107 aliases for other email addresses. Common examples are organizational
34108 top-level domains and &"vanity"& domains.
34109 .next
34110 One of a number of independent domains that are all handled by the same host,
34111 with mailboxes on that host, but where the mailbox owners do not necessarily
34112 have login accounts on that host.
34113 .endlist
34114
34115 The first usage is probably more common, and does seem more &"virtual"& than
34116 the second. This kind of domain can be handled in Exim with a straightforward
34117 aliasing router. One approach is to create a separate alias file for each
34118 virtual domain. Exim can test for the existence of the alias file to determine
34119 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34120 to a router of this form:
34121 .code
34122 virtual:
34123   driver = redirect
34124   domains = dsearch;/etc/mail/virtual
34125   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34126   no_more
34127 .endd
34128 The &%domains%& option specifies that the router is to be skipped, unless there
34129 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34130 domain that is being processed. When the router runs, it looks up the local
34131 part in the file to find a new address (or list of addresses). The &%no_more%&
34132 setting ensures that if the lookup fails (leading to &%data%& being an empty
34133 string), Exim gives up on the address without trying any subsequent routers.
34134
34135 This one router can handle all the virtual domains because the alias file names
34136 follow a fixed pattern. Permissions can be arranged so that appropriate people
34137 can edit the different alias files. A successful aliasing operation results in
34138 a new envelope recipient address, which is then routed from scratch.
34139
34140 The other kind of &"virtual"& domain can also be handled in a straightforward
34141 way. One approach is to create a file for each domain containing a list of
34142 valid local parts, and use it in a router like this:
34143 .code
34144 my_domains:
34145   driver = accept
34146   domains = dsearch;/etc/mail/domains
34147   local_parts = lsearch;/etc/mail/domains/$domain
34148   transport = my_mailboxes
34149 .endd
34150 The address is accepted if there is a file for the domain, and the local part
34151 can be found in the file. The &%domains%& option is used to check for the
34152 file's existence because &%domains%& is tested before the &%local_parts%&
34153 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34154 because that option is tested after &%local_parts%&. The transport is as
34155 follows:
34156 .code
34157 my_mailboxes:
34158   driver = appendfile
34159   file = /var/mail/$domain/$local_part
34160   user = mail
34161 .endd
34162 This uses a directory of mailboxes for each domain. The &%user%& setting is
34163 required, to specify which uid is to be used for writing to the mailboxes.
34164
34165 The configuration shown here is just one example of how you might support this
34166 requirement. There are many other ways this kind of configuration can be set
34167 up, for example, by using a database instead of separate files to hold all the
34168 information about the domains.
34169
34170
34171
34172 .section "Multiple user mailboxes" "SECTmulbox"
34173 .cindex "multiple mailboxes"
34174 .cindex "mailbox" "multiple"
34175 .cindex "local part" "prefix"
34176 .cindex "local part" "suffix"
34177 Heavy email users often want to operate with multiple mailboxes, into which
34178 incoming mail is automatically sorted. A popular way of handling this is to
34179 allow users to use multiple sender addresses, so that replies can easily be
34180 identified. Users are permitted to add prefixes or suffixes to their local
34181 parts for this purpose. The wildcard facility of the generic router options
34182 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34183 example, consider this router:
34184 .code
34185 userforward:
34186   driver = redirect
34187   check_local_user
34188   file = $home/.forward
34189   local_part_suffix = -*
34190   local_part_suffix_optional
34191   allow_filter
34192 .endd
34193 .vindex "&$local_part_suffix$&"
34194 It runs a user's &_.forward_& file for all local parts of the form
34195 &'username-*'&. Within the filter file the user can distinguish different
34196 cases by testing the variable &$local_part_suffix$&. For example:
34197 .code
34198 if $local_part_suffix contains -special then
34199 save /home/$local_part/Mail/special
34200 endif
34201 .endd
34202 If the filter file does not exist, or does not deal with such addresses, they
34203 fall through to subsequent routers, and, assuming no subsequent use of the
34204 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34205 control over which suffixes are valid.
34206
34207 Alternatively, a suffix can be used to trigger the use of a different
34208 &_.forward_& file &-- which is the way a similar facility is implemented in
34209 another MTA:
34210 .code
34211 userforward:
34212   driver = redirect
34213   check_local_user
34214   file = $home/.forward$local_part_suffix
34215   local_part_suffix = -*
34216   local_part_suffix_optional
34217   allow_filter
34218 .endd
34219 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34220 example, &_.forward-special_& is used. Once again, if the appropriate file
34221 does not exist, or does not deal with the address, it is passed on to
34222 subsequent routers, which could, if required, look for an unqualified
34223 &_.forward_& file to use as a default.
34224
34225
34226
34227 .section "Simplified vacation processing" "SECID244"
34228 .cindex "vacation processing"
34229 The traditional way of running the &'vacation'& program is for a user to set up
34230 a pipe command in a &_.forward_& file
34231 (see section &<<SECTspecitredli>>& for syntax details).
34232 This is prone to error by inexperienced users. There are two features of Exim
34233 that can be used to make this process simpler for users:
34234
34235 .ilist
34236 A local part prefix such as &"vacation-"& can be specified on a router which
34237 can cause the message to be delivered directly to the &'vacation'& program, or
34238 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34239 &_.forward_& file are then much simpler. For example:
34240 .code
34241 spqr, vacation-spqr
34242 .endd
34243 .next
34244 The &%require_files%& generic router option can be used to trigger a
34245 vacation delivery by checking for the existence of a certain file in the
34246 user's home directory. The &%unseen%& generic option should also be used, to
34247 ensure that the original delivery also proceeds. In this case, all the user has
34248 to do is to create a file called, say, &_.vacation_&, containing a vacation
34249 message.
34250 .endlist
34251
34252 Another advantage of both these methods is that they both work even when the
34253 use of arbitrary pipes by users is locked out.
34254
34255
34256
34257 .section "Taking copies of mail" "SECID245"
34258 .cindex "message" "copying every"
34259 Some installations have policies that require archive copies of all messages to
34260 be made. A single copy of each message can easily be taken by an appropriate
34261 command in a system filter, which could, for example, use a different file for
34262 each day's messages.
34263
34264 There is also a shadow transport mechanism that can be used to take copies of
34265 messages that are successfully delivered by local transports, one copy per
34266 delivery. This could be used, &'inter alia'&, to implement automatic
34267 notification of delivery by sites that insist on doing such things.
34268
34269
34270
34271 .section "Intermittently connected hosts" "SECID246"
34272 .cindex "intermittently connected hosts"
34273 It has become quite common (because it is cheaper) for hosts to connect to the
34274 Internet periodically rather than remain connected all the time. The normal
34275 arrangement is that mail for such hosts accumulates on a system that is
34276 permanently connected.
34277
34278 Exim was designed for use on permanently connected hosts, and so it is not
34279 particularly well-suited to use in an intermittently connected environment.
34280 Nevertheless there are some features that can be used.
34281
34282
34283 .section "Exim on the upstream server host" "SECID247"
34284 It is tempting to arrange for incoming mail for the intermittently connected
34285 host to remain on Exim's queue until the client connects. However, this
34286 approach does not scale very well. Two different kinds of waiting message are
34287 being mixed up in the same queue &-- those that cannot be delivered because of
34288 some temporary problem, and those that are waiting for their destination host
34289 to connect. This makes it hard to manage the queue, as well as wasting
34290 resources, because each queue runner scans the entire queue.
34291
34292 A better approach is to separate off those messages that are waiting for an
34293 intermittently connected host. This can be done by delivering these messages
34294 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34295 format, from where they are transmitted by other software when their
34296 destination connects. This makes it easy to collect all the mail for one host
34297 in a single directory, and to apply local timeout rules on a per-message basis
34298 if required.
34299
34300 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34301 you are doing this, you should configure Exim with a long retry period for the
34302 intermittent host. For example:
34303 .code
34304 cheshire.wonderland.fict.example    *   F,5d,24h
34305 .endd
34306 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34307 which messages it has queued up for that host. Once the intermittent host comes
34308 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34309 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34310 causes all the queued up messages to be delivered, often down a single SMTP
34311 connection. While the host remains connected, any new messages get delivered
34312 immediately.
34313
34314 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34315 issued with a different IP address each time it connects, Exim's retry
34316 mechanisms on the holding host get confused, because the IP address is normally
34317 used as part of the key string for holding retry information. This can be
34318 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34319 Since this has disadvantages for permanently connected hosts, it is best to
34320 arrange a separate transport for the intermittently connected ones.
34321
34322
34323
34324 .section "Exim on the intermittently connected client host" "SECID248"
34325 The value of &%smtp_accept_queue_per_connection%& should probably be
34326 increased, or even set to zero (that is, disabled) on the intermittently
34327 connected host, so that all incoming messages down a single connection get
34328 delivered immediately.
34329
34330 .cindex "SMTP" "passed connection"
34331 .cindex "SMTP" "multiple deliveries"
34332 .cindex "multiple SMTP deliveries"
34333 Mail waiting to be sent from an intermittently connected host will probably
34334 not have been routed, because without a connection DNS lookups are not
34335 possible. This means that if a normal queue run is done at connection time,
34336 each message is likely to be sent in a separate SMTP session. This can be
34337 avoided by starting the queue run with a command line option beginning with
34338 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34339 first pass, routing is done but no deliveries take place. The second pass is a
34340 normal queue run; since all the messages have been previously routed, those
34341 destined for the same host are likely to get sent as multiple deliveries in a
34342 single SMTP connection.
34343
34344
34345
34346 . ////////////////////////////////////////////////////////////////////////////
34347 . ////////////////////////////////////////////////////////////////////////////
34348
34349 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34350          "Exim as a non-queueing client"
34351 .cindex "client, non-queueing"
34352 .cindex "smart host" "suppressing queueing"
34353 On a personal computer, it is a common requirement for all
34354 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34355 configured to operate that way, for all the popular operating systems.
34356 However, there are some MUAs for Unix-like systems that cannot be so
34357 configured: they submit messages using the command line interface of
34358 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34359 messages this way.
34360
34361 If the personal computer runs continuously, there is no problem, because it can
34362 run a conventional MTA that handles delivery to the smart host, and deal with
34363 any delays via its queueing mechanism. However, if the computer does not run
34364 continuously or runs different operating systems at different times, queueing
34365 email is not desirable.
34366
34367 There is therefore a requirement for something that can provide the
34368 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34369 any queueing or retrying facilities. Furthermore, the delivery to the smart
34370 host should be synchronous, so that if it fails, the sending MUA is immediately
34371 informed. In other words, we want something that extends an MUA that submits
34372 to a local MTA via the command line so that it behaves like one that submits
34373 to a remote smart host using TCP/SMTP.
34374
34375 There are a number of applications (for example, there is one called &'ssmtp'&)
34376 that do this job. However, people have found them to be lacking in various
34377 ways. For instance, you might want to allow aliasing and forwarding to be done
34378 before sending a message to the smart host.
34379
34380 Exim already had the necessary infrastructure for doing this job. Just a few
34381 tweaks were needed to make it behave as required, though it is somewhat of an
34382 overkill to use a fully-featured MTA for this purpose.
34383
34384 .oindex "&%mua_wrapper%&"
34385 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34386 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34387 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34388 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34389 compatible router and transport configuration. Typically there will be just one
34390 router and one transport, sending everything to a smart host.
34391
34392 When run in MUA wrapping mode, the behaviour of Exim changes in the
34393 following ways:
34394
34395 .ilist
34396 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34397 In other words, the only way to submit messages is via the command line.
34398 .next
34399 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34400 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34401 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34402 does not finish until the delivery attempt is complete. If the delivery is
34403 successful, a zero return code is given.
34404 .next
34405 Address redirection is permitted, but the final routing for all addresses must
34406 be to the same remote transport, and to the same list of hosts. Furthermore,
34407 the return address (envelope sender) must be the same for all recipients, as
34408 must any added or deleted header lines. In other words, it must be possible to
34409 deliver the message in a single SMTP transaction, however many recipients there
34410 are.
34411 .next
34412 If these conditions are not met, or if routing any address results in a
34413 failure or defer status, or if Exim is unable to deliver all the recipients
34414 successfully to one of the smart hosts, delivery of the entire message fails.
34415 .next
34416 Because no queueing is allowed, all failures are treated as permanent; there
34417 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34418 smart host. Furthermore, because only a single yes/no response can be given to
34419 the caller, it is not possible to deliver to some recipients and not others. If
34420 there is an error (temporary or permanent) for any recipient, all are failed.
34421 .next
34422 If more than one smart host is listed, Exim will try another host after a
34423 connection failure or a timeout, in the normal way. However, if this kind of
34424 failure happens for all the hosts, the delivery fails.
34425 .next
34426 When delivery fails, an error message is written to the standard error stream
34427 (as well as to Exim's log), and Exim exits to the caller with a return code
34428 value 1. The message is expunged from Exim's spool files. No bounce messages
34429 are ever generated.
34430 .next
34431 No retry data is maintained, and any retry rules are ignored.
34432 .next
34433 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34434 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34435 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34436 .endlist
34437
34438 The overall effect is that Exim makes a single synchronous attempt to deliver
34439 the message, failing if there is any kind of problem. Because no local
34440 deliveries are done and no daemon can be run, Exim does not need root
34441 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34442 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34443 the advantages and disadvantages of running without root privilege.
34444
34445
34446
34447
34448 . ////////////////////////////////////////////////////////////////////////////
34449 . ////////////////////////////////////////////////////////////////////////////
34450
34451 .chapter "Log files" "CHAPlog"
34452 .scindex IIDloggen "log" "general description"
34453 .cindex "log" "types of"
34454 Exim writes three different logs, referred to as the main log, the reject log,
34455 and the panic log:
34456
34457 .ilist
34458 .cindex "main log"
34459 The main log records the arrival of each message and each delivery in a single
34460 line in each case. The format is as compact as possible, in an attempt to keep
34461 down the size of log files. Two-character flag sequences make it easy to pick
34462 out these lines. A number of other events are recorded in the main log. Some of
34463 them are optional, in which case the &%log_selector%& option controls whether
34464 they are included or not. A Perl script called &'eximstats'&, which does simple
34465 analysis of main log files, is provided in the Exim distribution (see section
34466 &<<SECTmailstat>>&).
34467 .next
34468 .cindex "reject log"
34469 The reject log records information from messages that are rejected as a result
34470 of a configuration option (that is, for policy reasons).
34471 The first line of each rejection is a copy of the line that is also written to
34472 the main log. Then, if the message's header has been read at the time the log
34473 is written, its contents are written to this log. Only the original header
34474 lines are available; header lines added by ACLs are not logged. You can use the
34475 reject log to check that your policy controls are working correctly; on a busy
34476 host this may be easier than scanning the main log for rejection messages. You
34477 can suppress the writing of the reject log by setting &%write_rejectlog%&
34478 false.
34479 .next
34480 .cindex "panic log"
34481 .cindex "system log"
34482 When certain serious errors occur, Exim writes entries to its panic log. If the
34483 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34484 are usually written to the main log as well, but can get lost amid the mass of
34485 other entries. The panic log should be empty under normal circumstances. It is
34486 therefore a good idea to check it (or to have a &'cron'& script check it)
34487 regularly, in order to become aware of any problems. When Exim cannot open its
34488 panic log, it tries as a last resort to write to the system log (syslog). This
34489 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34490 message itself is written at priority LOG_CRIT.
34491 .endlist
34492
34493 Every log line starts with a timestamp, in the format shown in the following
34494 example. Note that many of the examples shown in this chapter are line-wrapped.
34495 In the log file, this would be all on one line:
34496 .code
34497 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34498   by QUIT
34499 .endd
34500 By default, the timestamps are in the local timezone. There are two
34501 ways of changing this:
34502
34503 .ilist
34504 You can set the &%timezone%& option to a different time zone; in particular, if
34505 you set
34506 .code
34507 timezone = UTC
34508 .endd
34509 the timestamps will be in UTC (aka GMT).
34510 .next
34511 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34512 example:
34513 .code
34514 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34515 .endd
34516 .endlist
34517
34518 .cindex "log" "process ids in"
34519 .cindex "pid (process id)" "in log lines"
34520 Exim does not include its process id in log lines by default, but you can
34521 request that it does so by specifying the &`pid`& log selector (see section
34522 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34523 brackets, immediately after the time and date.
34524
34525
34526
34527
34528 .section "Where the logs are written" "SECTwhelogwri"
34529 .cindex "log" "destination"
34530 .cindex "log" "to file"
34531 .cindex "log" "to syslog"
34532 .cindex "syslog"
34533 The logs may be written to local files, or to syslog, or both. However, it
34534 should be noted that many syslog implementations use UDP as a transport, and
34535 are therefore unreliable in the sense that messages are not guaranteed to
34536 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34537 It has also been reported that on large log files (tens of megabytes) you may
34538 need to tweak syslog to prevent it syncing the file with each write &-- on
34539 Linux this has been seen to make syslog take 90% plus of CPU time.
34540
34541 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34542 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34543 configuration. This latter string is expanded, so it can contain, for example,
34544 references to the host name:
34545 .code
34546 log_file_path = /var/log/$primary_hostname/exim_%slog
34547 .endd
34548 It is generally advisable, however, to set the string in &_Local/Makefile_&
34549 rather than at run time, because then the setting is available right from the
34550 start of Exim's execution. Otherwise, if there's something it wants to log
34551 before it has read the configuration file (for example, an error in the
34552 configuration file) it will not use the path you want, and may not be able to
34553 log at all.
34554
34555 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34556 list, currently limited to at most two items. This is one option where the
34557 facility for changing a list separator may not be used. The list must always be
34558 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34559 otherwise the item must either be an absolute path, containing &`%s`& at the
34560 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34561 implying the use of a default path.
34562
34563 When Exim encounters an empty item in the list, it searches the list defined by
34564 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34565 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34566 mean &"use the path specified at build time"&. It no such item exists, log
34567 files are written in the &_log_& subdirectory of the spool directory. This is
34568 equivalent to the setting:
34569 .code
34570 log_file_path = $spool_directory/log/%slog
34571 .endd
34572 If you do not specify anything at build time or run time, that is where the
34573 logs are written.
34574
34575 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34576 are in use &-- see section &<<SECTdatlogfil>>& below.
34577
34578 Here are some examples of possible settings:
34579 .display
34580 &`LOG_FILE_PATH=syslog                    `& syslog only
34581 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34582 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34583 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34584 .endd
34585 If there are more than two paths in the list, the first is used and a panic
34586 error is logged.
34587
34588
34589
34590 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34591 .cindex "log" "cycling local files"
34592 .cindex "cycling logs"
34593 .cindex "&'exicyclog'&"
34594 .cindex "log" "local files; writing to"
34595 Some operating systems provide centralized and standardized methods for cycling
34596 log files. For those that do not, a utility script called &'exicyclog'& is
34597 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34598 main and reject logs each time it is called. The maximum number of old logs to
34599 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34600
34601 An Exim delivery process opens the main log when it first needs to write to it,
34602 and it keeps the file open in case subsequent entries are required &-- for
34603 example, if a number of different deliveries are being done for the same
34604 message. However, remote SMTP deliveries can take a long time, and this means
34605 that the file may be kept open long after it is renamed if &'exicyclog'& or
34606 something similar is being used to rename log files on a regular basis. To
34607 ensure that a switch of log files is noticed as soon as possible, Exim calls
34608 &[stat()]& on the main log's name before reusing an open file, and if the file
34609 does not exist, or its inode has changed, the old file is closed and Exim
34610 tries to open the main log from scratch. Thus, an old log file may remain open
34611 for quite some time, but no Exim processes should write to it once it has been
34612 renamed.
34613
34614
34615
34616 .section "Datestamped log files" "SECTdatlogfil"
34617 .cindex "log" "datestamped files"
34618 Instead of cycling the main and reject log files by renaming them
34619 periodically, some sites like to use files whose names contain a datestamp,
34620 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34621 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34622 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34623 point where the datestamp is required. For example:
34624 .code
34625 log_file_path = /var/spool/exim/log/%slog-%D
34626 log_file_path = /var/log/exim-%s-%D.log
34627 log_file_path = /var/spool/exim/log/%D-%slog
34628 log_file_path = /var/log/exim/%s.%M
34629 .endd
34630 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34631 examples of names generated by the above examples:
34632 .code
34633 /var/spool/exim/log/mainlog-20021225
34634 /var/log/exim-reject-20021225.log
34635 /var/spool/exim/log/20021225-mainlog
34636 /var/log/exim/main.200212
34637 .endd
34638 When this form of log file is specified, Exim automatically switches to new
34639 files at midnight. It does not make any attempt to compress old logs; you
34640 will need to write your own script if you require this. You should not
34641 run &'exicyclog'& with this form of logging.
34642
34643 The location of the panic log is also determined by &%log_file_path%&, but it
34644 is not datestamped, because rotation of the panic log does not make sense.
34645 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34646 the string. In addition, if it immediately follows a slash, a following
34647 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34648 character is removed. Thus, the four examples above would give these panic
34649 log names:
34650 .code
34651 /var/spool/exim/log/paniclog
34652 /var/log/exim-panic.log
34653 /var/spool/exim/log/paniclog
34654 /var/log/exim/panic
34655 .endd
34656
34657
34658 .section "Logging to syslog" "SECID249"
34659 .cindex "log" "syslog; writing to"
34660 The use of syslog does not change what Exim logs or the format of its messages,
34661 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34662 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34663 that, the same strings are written to syslog as to log files. The syslog
34664 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34665 by default, but you can change these by setting the &%syslog_facility%& and
34666 &%syslog_processname%& options, respectively. If Exim was compiled with
34667 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34668 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34669 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34670 the time and host name to each line.
34671 The three log streams are mapped onto syslog priorities as follows:
34672
34673 .ilist
34674 &'mainlog'& is mapped to LOG_INFO
34675 .next
34676 &'rejectlog'& is mapped to LOG_NOTICE
34677 .next
34678 &'paniclog'& is mapped to LOG_ALERT
34679 .endlist
34680
34681 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34682 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34683 these are routed by syslog to the same place. You can suppress this duplication
34684 by setting &%syslog_duplication%& false.
34685
34686 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34687 entries contain multiple lines when headers are included. To cope with both
34688 these cases, entries written to syslog are split into separate &[syslog()]&
34689 calls at each internal newline, and also after a maximum of
34690 870 data characters. (This allows for a total syslog line length of 1024, when
34691 additions such as timestamps are added.) If you are running a syslog
34692 replacement that can handle lines longer than the 1024 characters allowed by
34693 RFC 3164, you should set
34694 .code
34695 SYSLOG_LONG_LINES=yes
34696 .endd
34697 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34698 lines, but it still splits at internal newlines in &'reject'& log entries.
34699
34700 To make it easy to re-assemble split lines later, each component of a split
34701 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34702 where <&'n'&> is the component number and <&'m'&> is the total number of
34703 components in the entry. The / delimiter is used when the line was split
34704 because it was too long; if it was split because of an internal newline, the \
34705 delimiter is used. For example, supposing the length limit to be 50 instead of
34706 870, the following would be the result of a typical rejection message to
34707 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34708 name, and pid as added by syslog:
34709 .code
34710 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34711 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34712 [3/5]  when scanning for sender: missing or malformed lo
34713 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34714 [5/5] mple>)
34715 .endd
34716 The same error might cause the following lines to be written to &"rejectlog"&
34717 (LOG_NOTICE):
34718 .code
34719 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34720 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34721 [3/18] er when scanning for sender: missing or malformed
34722 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34723 [5\18] .example>)
34724 [6\18] Recipients: ph10@some.domain.cam.example
34725 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34726 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34727 [9\18]        id 16RdAL-0006pc-00
34728 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34729 [11\18] 09:43 +0100
34730 [12\18] F From: <>
34731 [13\18]   Subject: this is a test header
34732 [18\18]   X-something: this is another header
34733 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34734 [16\18] le>
34735 [17\18] B Bcc:
34736 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34737 .endd
34738 Log lines that are neither too long nor contain newlines are written to syslog
34739 without modification.
34740
34741 If only syslog is being used, the Exim monitor is unable to provide a log tail
34742 display, unless syslog is routing &'mainlog'& to a file on the local host and
34743 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34744 where it is.
34745
34746
34747
34748 .section "Log line flags" "SECID250"
34749 One line is written to the main log for each message received, and for each
34750 successful, unsuccessful, and delayed delivery. These lines can readily be
34751 picked out by the distinctive two-character flags that immediately follow the
34752 timestamp. The flags are:
34753 .display
34754 &`<=`&     message arrival
34755 &`=>`&     normal message delivery
34756 &`->`&     additional address in same delivery
34757 &`>>`&     cutthrough message delivery
34758 &`*>`&     delivery suppressed by &%-N%&
34759 &`**`&     delivery failed; address bounced
34760 &`==`&     delivery deferred; temporary problem
34761 .endd
34762
34763
34764 .section "Logging message reception" "SECID251"
34765 .cindex "log" "reception line"
34766 The format of the single-line entry in the main log that is written for every
34767 message received is shown in the basic example below, which is split over
34768 several lines in order to fit it on the page:
34769 .code
34770 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34771   H=mailer.fict.example [192.168.123.123] U=exim
34772   P=smtp S=5678 id=<incoming message id>
34773 .endd
34774 The address immediately following &"<="& is the envelope sender address. A
34775 bounce message is shown with the sender address &"<>"&, and if it is locally
34776 generated, this is followed by an item of the form
34777 .code
34778 R=<message id>
34779 .endd
34780 which is a reference to the message that caused the bounce to be sent.
34781
34782 .cindex "HELO"
34783 .cindex "EHLO"
34784 For messages from other hosts, the H and U fields identify the remote host and
34785 record the RFC 1413 identity of the user that sent the message, if one was
34786 received. The number given in square brackets is the IP address of the sending
34787 host. If there is a single, unparenthesized  host name in the H field, as
34788 above, it has been verified to correspond to the IP address (see the
34789 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34790 by the remote host in the SMTP HELO or EHLO command, and has not been
34791 verified. If verification yields a different name to that given for HELO or
34792 EHLO, the verified name appears first, followed by the HELO or EHLO
34793 name in parentheses.
34794
34795 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34796 without brackets, in the HELO or EHLO command, leading to entries in
34797 the log containing text like these examples:
34798 .code
34799 H=(10.21.32.43) [192.168.8.34]
34800 H=([10.21.32.43]) [192.168.8.34]
34801 .endd
34802 This can be confusing. Only the final address in square brackets can be relied
34803 on.
34804
34805 For locally generated messages (that is, messages not received over TCP/IP),
34806 the H field is omitted, and the U field contains the login name of the caller
34807 of Exim.
34808
34809 .cindex "authentication" "logging"
34810 .cindex "AUTH" "logging"
34811 For all messages, the P field specifies the protocol used to receive the
34812 message. This is the value that is stored in &$received_protocol$&. In the case
34813 of incoming SMTP messages, the value indicates whether or not any SMTP
34814 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34815 session was encrypted, there is an additional X field that records the cipher
34816 suite that was used.
34817
34818 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34819 hosts that have authenticated themselves using the SMTP AUTH command. The first
34820 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34821 there is an additional item A= followed by the name of the authenticator that
34822 was used. If an authenticated identification was set up by the authenticator's
34823 &%server_set_id%& option, this is logged too, separated by a colon from the
34824 authenticator name.
34825
34826 .cindex "size" "of message"
34827 The id field records the existing message id, if present. The size of the
34828 received message is given by the S field. When the message is delivered,
34829 headers may be removed or added, so that the size of delivered copies of the
34830 message may not correspond with this value (and indeed may be different to each
34831 other).
34832
34833 The &%log_selector%& option can be used to request the logging of additional
34834 data when a message is received. See section &<<SECTlogselector>>& below.
34835
34836
34837
34838 .section "Logging deliveries" "SECID252"
34839 .cindex "log" "delivery line"
34840 The format of the single-line entry in the main log that is written for every
34841 delivery is shown in one of the examples below, for local and remote
34842 deliveries, respectively. Each example has been split into two lines in order
34843 to fit it on the page:
34844 .code
34845 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34846   <marv@hitch.fict.example> R=localuser T=local_delivery
34847 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34848   monk@holistic.fict.example R=dnslookup T=remote_smtp
34849   H=holistic.fict.example [192.168.234.234]
34850 .endd
34851 For ordinary local deliveries, the original address is given in angle brackets
34852 after the final delivery address, which might be a pipe or a file. If
34853 intermediate address(es) exist between the original and the final address, the
34854 last of these is given in parentheses after the final address. The R and T
34855 fields record the router and transport that were used to process the address.
34856
34857 If SMTP AUTH was used for the delivery there is an additional item A=
34858 followed by the name of the authenticator that was used.
34859 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34860 option, this is logged too, separated by a colon from the authenticator name.
34861
34862 If a shadow transport was run after a successful local delivery, the log line
34863 for the successful delivery has an item added on the end, of the form
34864 .display
34865 &`ST=<`&&'shadow transport name'&&`>`&
34866 .endd
34867 If the shadow transport did not succeed, the error message is put in
34868 parentheses afterwards.
34869
34870 .cindex "asterisk" "after IP address"
34871 When more than one address is included in a single delivery (for example, two
34872 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34873 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34874 down a single SMTP connection, an asterisk follows the IP address in the log
34875 lines for the second and subsequent messages.
34876
34877 .cindex "delivery" "cutthrough; logging"
34878 .cindex "cutthrough" "logging"
34879 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34880 line precedes the reception line, since cutthrough waits for a possible
34881 rejection from the destination in case it can reject the sourced item.
34882
34883 The generation of a reply message by a filter file gets logged as a
34884 &"delivery"& to the addressee, preceded by &">"&.
34885
34886 The &%log_selector%& option can be used to request the logging of additional
34887 data when a message is delivered. See section &<<SECTlogselector>>& below.
34888
34889
34890 .section "Discarded deliveries" "SECID253"
34891 .cindex "discarded messages"
34892 .cindex "message" "discarded"
34893 .cindex "delivery" "discarded; logging"
34894 When a message is discarded as a result of the command &"seen finish"& being
34895 obeyed in a filter file which generates no deliveries, a log entry of the form
34896 .code
34897 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34898   <low.club@bridge.example> R=userforward
34899 .endd
34900 is written, to record why no deliveries are logged. When a message is discarded
34901 because it is aliased to &":blackhole:"& the log line is like this:
34902 .code
34903 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34904   <hole@nowhere.example> R=blackhole_router
34905 .endd
34906
34907
34908 .section "Deferred deliveries" "SECID254"
34909 When a delivery is deferred, a line of the following form is logged:
34910 .code
34911 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34912   R=dnslookup T=smtp defer (146): Connection refused
34913 .endd
34914 In the case of remote deliveries, the error is the one that was given for the
34915 last IP address that was tried. Details of individual SMTP failures are also
34916 written to the log, so the above line would be preceded by something like
34917 .code
34918 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34919   mail1.endrest.example [192.168.239.239]: Connection refused
34920 .endd
34921 When a deferred address is skipped because its retry time has not been reached,
34922 a message is written to the log, but this can be suppressed by setting an
34923 appropriate value in &%log_selector%&.
34924
34925
34926
34927 .section "Delivery failures" "SECID255"
34928 .cindex "delivery" "failure; logging"
34929 If a delivery fails because an address cannot be routed, a line of the
34930 following form is logged:
34931 .code
34932 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34933   <jim@trek99.example>: unknown mail domain
34934 .endd
34935 If a delivery fails at transport time, the router and transport are shown, and
34936 the response from the remote host is included, as in this example:
34937 .code
34938 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34939   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34940   after pipelined RCPT TO:<ace400@pb.example>: host
34941   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34942   <ace400@pb.example>...Addressee unknown
34943 .endd
34944 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34945 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34946 disabling PIPELINING. The log lines for all forms of delivery failure are
34947 flagged with &`**`&.
34948
34949
34950
34951 .section "Fake deliveries" "SECID256"
34952 .cindex "delivery" "fake; logging"
34953 If a delivery does not actually take place because the &%-N%& option has been
34954 used to suppress it, a normal delivery line is written to the log, except that
34955 &"=>"& is replaced by &"*>"&.
34956
34957
34958
34959 .section "Completion" "SECID257"
34960 A line of the form
34961 .code
34962 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34963 .endd
34964 is written to the main log when a message is about to be removed from the spool
34965 at the end of its processing.
34966
34967
34968
34969
34970 .section "Summary of Fields in Log Lines" "SECID258"
34971 .cindex "log" "summary of fields"
34972 A summary of the field identifiers that are used in log lines is shown in
34973 the following table:
34974 .display
34975 &`A   `&        authenticator name (and optional id and sender)
34976 &`C   `&        SMTP confirmation on delivery
34977 &`    `&        command list for &"no mail in SMTP session"&
34978 &`CV  `&        certificate verification status
34979 &`D   `&        duration of &"no mail in SMTP session"&
34980 &`DN  `&        distinguished name from peer certificate
34981 &`DT  `&        on &`=>`& lines: time taken for a delivery
34982 &`F   `&        sender address (on delivery lines)
34983 &`H   `&        host name and IP address
34984 &`I   `&        local interface used
34985 &`id  `&        message id for incoming message
34986 &`P   `&        on &`<=`& lines: protocol used
34987 &`    `&        on &`=>`& and &`**`& lines: return path
34988 &`QT  `&        on &`=>`& lines: time spent on queue so far
34989 &`    `&        on &"Completed"& lines: time spent on queue
34990 &`R   `&        on &`<=`& lines: reference for local bounce
34991 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34992 &`S   `&        size of message
34993 &`SNI `&        server name indication from TLS client hello
34994 &`ST  `&        shadow transport name
34995 &`T   `&        on &`<=`& lines: message subject (topic)
34996 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34997 &`U   `&        local user or RFC 1413 identity
34998 &`X   `&        TLS cipher suite
34999 .endd
35000
35001
35002 .section "Other log entries" "SECID259"
35003 Various other types of log entry are written from time to time. Most should be
35004 self-explanatory. Among the more common are:
35005
35006 .ilist
35007 .cindex "retry" "time not reached"
35008 &'retry time not reached'&&~&~An address previously suffered a temporary error
35009 during routing or local delivery, and the time to retry has not yet arrived.
35010 This message is not written to an individual message log file unless it happens
35011 during the first delivery attempt.
35012 .next
35013 &'retry time not reached for any host'&&~&~An address previously suffered
35014 temporary errors during remote delivery, and the retry time has not yet arrived
35015 for any of the hosts to which it is routed.
35016 .next
35017 .cindex "spool directory" "file locked"
35018 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35019 some other Exim process is already working on the message. This can be quite
35020 common if queue running processes are started at frequent intervals. The
35021 &'exiwhat'& utility script can be used to find out what Exim processes are
35022 doing.
35023 .next
35024 .cindex "error" "ignored"
35025 &'error ignored'&&~&~There are several circumstances that give rise to this
35026 message:
35027 .olist
35028 Exim failed to deliver a bounce message whose age was greater than
35029 &%ignore_bounce_errors_after%&. The bounce was discarded.
35030 .next
35031 A filter file set up a delivery using the &"noerror"& option, and the delivery
35032 failed. The delivery was discarded.
35033 .next
35034 A delivery set up by a router configured with
35035 . ==== As this is a nested list, any displays it contains must be indented
35036 . ==== as otherwise they are too far to the left.
35037 .code
35038     errors_to = <>
35039 .endd
35040 failed. The delivery was discarded.
35041 .endlist olist
35042 .endlist ilist
35043
35044
35045
35046
35047
35048 .section "Reducing or increasing what is logged" "SECTlogselector"
35049 .cindex "log" "selectors"
35050 By setting the &%log_selector%& global option, you can disable some of Exim's
35051 default logging, or you can request additional logging. The value of
35052 &%log_selector%& is made up of names preceded by plus or minus characters. For
35053 example:
35054 .code
35055 log_selector = +arguments -retry_defer
35056 .endd
35057 The list of optional log items is in the following table, with the default
35058 selection marked by asterisks:
35059 .display
35060 &` 8bitmime                   `&  received 8BITMIME status
35061 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35062 &` address_rewrite            `&  address rewriting
35063 &` all_parents                `&  all parents in => lines
35064 &` arguments                  `&  command line arguments
35065 &`*connection_reject          `&  connection rejections
35066 &`*delay_delivery             `&  immediate delivery delayed
35067 &` deliver_time               `&  time taken to perform delivery
35068 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35069 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35070 &`*etrn                       `&  ETRN commands
35071 &`*host_lookup_failed         `&  as it says
35072 &` ident_timeout              `&  timeout for ident connection
35073 &` incoming_interface         `&  local interface on <= and => lines
35074 &` incoming_port              `&  remote port on <= lines
35075 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35076 &` outgoing_port              `&  add remote port to => lines
35077 &`*queue_run                  `&  start and end queue runs
35078 &` queue_time                 `&  time on queue for one recipient
35079 &` queue_time_overall         `&  time on queue for whole message
35080 &` pid                        `&  Exim process id
35081 &` received_recipients        `&  recipients on <= lines
35082 &` received_sender            `&  sender on <= lines
35083 &`*rejected_header            `&  header contents on reject log
35084 &`*retry_defer                `&  &"retry time not reached"&
35085 &` return_path_on_delivery    `&  put return path on => and ** lines
35086 &` sender_on_delivery         `&  add sender to => lines
35087 &`*sender_verify_fail         `&  sender verification failures
35088 &`*size_reject                `&  rejection because too big
35089 &`*skip_delivery              `&  delivery skipped in a queue run
35090 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35091 &` smtp_connection            `&  SMTP connections
35092 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35093 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35094 &` smtp_no_mail               `&  session with no MAIL commands
35095 &` smtp_protocol_error        `&  SMTP protocol errors
35096 &` smtp_syntax_error          `&  SMTP syntax errors
35097 &` subject                    `&  contents of &'Subject:'& on <= lines
35098 .new
35099 &`*tls_certificate_verified   `&  certificate verification status
35100 .wen
35101 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35102 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35103 &` tls_sni                    `&  TLS SNI on <= lines
35104 &` unknown_in_list            `&  DNS lookup failed in list match
35105
35106 &` all                        `&  all of the above
35107 .endd
35108 More details on each of these items follows:
35109
35110 .ilist
35111 .cindex "8BITMIME"
35112 .cindex "log" "8BITMIME"
35113 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35114 which may help in tracking down interoperability issues with ancient MTAs
35115 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35116 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35117 &`7BIT`& and &`8BITMIME`& respectively.
35118 .next
35119 .cindex "&%warn%& ACL verb" "log when skipping"
35120 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35121 its conditions cannot be evaluated, a log line to this effect is written if
35122 this log selector is set.
35123 .next
35124 .cindex "log" "rewriting"
35125 .cindex "rewriting" "logging"
35126 &%address_rewrite%&: This applies both to global rewrites and per-transport
35127 rewrites, but not to rewrites in filters run as an unprivileged user (because
35128 such users cannot access the log).
35129 .next
35130 .cindex "log" "full parentage"
35131 &%all_parents%&: Normally only the original and final addresses are logged on
35132 delivery lines; with this selector, intermediate parents are given in
35133 parentheses between them.
35134 .next
35135 .cindex "log" "Exim arguments"
35136 .cindex "Exim arguments, logging"
35137 &%arguments%&: This causes Exim to write the arguments with which it was called
35138 to the main log, preceded by the current working directory. This is a debugging
35139 feature, added to make it easier to find out how certain MUAs call
35140 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35141 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35142 that are empty or that contain white space are quoted. Non-printing characters
35143 are shown as escape sequences. This facility cannot log unrecognized arguments,
35144 because the arguments are checked before the configuration file is read. The
35145 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35146 between the caller and Exim.
35147 .next
35148 .cindex "log" "connection rejections"
35149 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35150 connection is rejected, for whatever reason.
35151 .next
35152 .cindex "log" "delayed delivery"
35153 .cindex "delayed delivery, logging"
35154 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35155 started for an incoming message because the load is too high or too many
35156 messages were received on one connection. Logging does not occur if no delivery
35157 process is started because &%queue_only%& is set or &%-odq%& was used.
35158 .next
35159 .cindex "log" "delivery duration"
35160 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35161 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35162 .next
35163 .cindex "log" "message size on delivery"
35164 .cindex "size" "of message"
35165 &%delivery_size%&: For each delivery, the size of message delivered is added to
35166 the &"=>"& line, tagged with S=.
35167 .next
35168 .cindex "log" "dnslist defer"
35169 .cindex "DNS list" "logging defer"
35170 .cindex "black list (DNS)"
35171 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35172 DNS black list suffers a temporary error.
35173 .next
35174 .cindex "log" "ETRN commands"
35175 .cindex "ETRN" "logging"
35176 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35177 is run to determine whether or not it is actually accepted. An invalid ETRN
35178 command, or one received within a message transaction is not logged by this
35179 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35180 .next
35181 .cindex "log" "host lookup failure"
35182 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35183 any addresses, or when a lookup of an IP address fails to find a host name, a
35184 log line is written. This logging does not apply to direct DNS lookups when
35185 routing email addresses, but it does apply to &"byname"& lookups.
35186 .next
35187 .cindex "log" "ident timeout"
35188 .cindex "RFC 1413" "logging timeout"
35189 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35190 client's ident port times out.
35191 .next
35192 .cindex "log" "incoming interface"
35193 .cindex "log" "local interface"
35194 .cindex "log" "local address and port"
35195 .cindex "TCP/IP" "logging local address and port"
35196 .cindex "interface" "logging"
35197 &%incoming_interface%&: The interface on which a message was received is added
35198 to the &"<="& line as an IP address in square brackets, tagged by I= and
35199 followed by a colon and the port number. The local interface and port are also
35200 added to other SMTP log lines, for example &"SMTP connection from"& and to
35201 rejection lines
35202 and (despite the name) the local interface is added to &"=>"& lines..
35203 .next
35204 .cindex "log" "incoming remote port"
35205 .cindex "port" "logging remote"
35206 .cindex "TCP/IP" "logging incoming remote port"
35207 .vindex "&$sender_fullhost$&"
35208 .vindex "&$sender_rcvhost$&"
35209 &%incoming_port%&: The remote port number from which a message was received is
35210 added to log entries and &'Received:'& header lines, following the IP address
35211 in square brackets, and separated from it by a colon. This is implemented by
35212 changing the value that is put in the &$sender_fullhost$& and
35213 &$sender_rcvhost$& variables. Recording the remote port number has become more
35214 important with the widening use of NAT (see RFC 2505).
35215 .next
35216 .cindex "log" "dropped connection"
35217 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35218 connection is unexpectedly dropped.
35219 .next
35220 .cindex "log" "outgoing remote port"
35221 .cindex "port" "logging outgoint remote"
35222 .cindex "TCP/IP" "logging ougtoing remote port"
35223 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35224 containing => tags) following the IP address. This option is not included in
35225 the default setting, because for most ordinary configurations, the remote port
35226 number is always 25 (the SMTP port).
35227 .next
35228 .cindex "log" "process ids in"
35229 .cindex "pid (process id)" "in log lines"
35230 &%pid%&: The current process id is added to every log line, in square brackets,
35231 immediately after the time and date.
35232 .next
35233 .cindex "log" "queue run"
35234 .cindex "queue runner" "logging"
35235 &%queue_run%&: The start and end of every queue run are logged.
35236 .next
35237 .cindex "log" "queue time"
35238 &%queue_time%&: The amount of time the message has been in the queue on the
35239 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35240 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35241 includes reception time as well as the delivery time for the current address.
35242 This means that it may be longer than the difference between the arrival and
35243 delivery log line times, because the arrival log line is not written until the
35244 message has been successfully received.
35245 .next
35246 &%queue_time_overall%&: The amount of time the message has been in the queue on
35247 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35248 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35249 message, so it includes reception time as well as the total delivery time.
35250 .next
35251 .cindex "log" "recipients"
35252 &%received_recipients%&: The recipients of a message are listed in the main log
35253 as soon as the message is received. The list appears at the end of the log line
35254 that is written when a message is received, preceded by the word &"for"&. The
35255 addresses are listed after they have been qualified, but before any rewriting
35256 has taken place.
35257 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35258 in the list.
35259 .next
35260 .cindex "log" "sender reception"
35261 &%received_sender%&: The unrewritten original sender of a message is added to
35262 the end of the log line that records the message's arrival, after the word
35263 &"from"& (before the recipients if &%received_recipients%& is also set).
35264 .next
35265 .cindex "log" "header lines for rejection"
35266 &%rejected_header%&: If a message's header has been received at the time a
35267 rejection is written to the reject log, the complete header is added to the
35268 log. Header logging can be turned off individually for messages that are
35269 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35270 .next
35271 .cindex "log" "retry defer"
35272 &%retry_defer%&: A log line is written if a delivery is deferred because a
35273 retry time has not yet been reached. However, this &"retry time not reached"&
35274 message is always omitted from individual message logs after the first delivery
35275 attempt.
35276 .next
35277 .cindex "log" "return path"
35278 &%return_path_on_delivery%&: The return path that is being transmitted with
35279 the message is included in delivery and bounce lines, using the tag P=.
35280 This is omitted if no delivery actually happens, for example, if routing fails,
35281 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35282 .next
35283 .cindex "log" "sender on delivery"
35284 &%sender_on_delivery%&: The message's sender address is added to every delivery
35285 and bounce line, tagged by F= (for &"from"&).
35286 This is the original sender that was received with the message; it is not
35287 necessarily the same as the outgoing return path.
35288 .next
35289 .cindex "log" "sender verify failure"
35290 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35291 gives details of a sender verification failure is not written. Log lines for
35292 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35293 detail is lost.
35294 .next
35295 .cindex "log" "size rejection"
35296 &%size_reject%&: A log line is written whenever a message is rejected because
35297 it is too big.
35298 .next
35299 .cindex "log" "frozen messages; skipped"
35300 .cindex "frozen messages" "logging skipping"
35301 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35302 queue run because it is frozen or because another process is already delivering
35303 it.
35304 .cindex "&""spool file is locked""&"
35305 The message that is written is &"spool file is locked"&.
35306 .next
35307 .cindex "log" "smtp confirmation"
35308 .cindex "SMTP" "logging confirmation"
35309 .cindex "LMTP" "logging confirmation"
35310 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35311 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35312 A number of MTAs (including Exim) return an identifying string in this
35313 response.
35314 .next
35315 .cindex "log" "SMTP connections"
35316 .cindex "SMTP" "logging connections"
35317 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35318 established or closed, unless the connection is from a host that matches
35319 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35320 only when the closure is unexpected.) This applies to connections from local
35321 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35322 dropped in the middle of a message, a log line is always written, whether or
35323 not this selector is set, but otherwise nothing is written at the start and end
35324 of connections unless this selector is enabled.
35325
35326 For TCP/IP connections to an Exim daemon, the current number of connections is
35327 included in the log message for each new connection, but note that the count is
35328 reset if the daemon is restarted.
35329 Also, because connections are closed (and the closure is logged) in
35330 subprocesses, the count may not include connections that have been closed but
35331 whose termination the daemon has not yet noticed. Thus, while it is possible to
35332 match up the opening and closing of connections in the log, the value of the
35333 logged counts may not be entirely accurate.
35334 .next
35335 .cindex "log" "SMTP transaction; incomplete"
35336 .cindex "SMTP" "logging incomplete transactions"
35337 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35338 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35339 and the message sender plus any accepted recipients are included in the log
35340 line. This can provide evidence of dictionary attacks.
35341 .next
35342 .cindex "log" "non-MAIL SMTP sessions"
35343 .cindex "MAIL" "logging session without"
35344 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35345 connection terminates without having issued a MAIL command. This includes both
35346 the case when the connection is dropped, and the case when QUIT is used. It
35347 does not include cases where the connection is rejected right at the start (by
35348 an ACL, or because there are too many connections, or whatever). These cases
35349 already have their own log lines.
35350
35351 The log line that is written contains the identity of the client in the usual
35352 way, followed by D= and a time, which records the duration of the connection.
35353 If the connection was authenticated, this fact is logged exactly as it is for
35354 an incoming message, with an A= item. If the connection was encrypted, CV=,
35355 DN=, and X= items may appear as they do for an incoming message, controlled by
35356 the same logging options.
35357
35358 Finally, if any SMTP commands were issued during the connection, a C= item
35359 is added to the line, listing the commands that were used. For example,
35360 .code
35361 C=EHLO,QUIT
35362 .endd
35363 shows that the client issued QUIT straight after EHLO. If there were fewer
35364 than 20 commands, they are all listed. If there were more than 20 commands,
35365 the last 20 are listed, preceded by &"..."&. However, with the default
35366 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35367 have been aborted before 20 non-mail commands are processed.
35368 .next
35369 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35370 colon-separated, is appended to the A= item for a message arrival or delivery
35371 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35372 was accepted or used.
35373 .next
35374 .cindex "log" "SMTP protocol error"
35375 .cindex "SMTP" "logging protocol error"
35376 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35377 encountered. Exim does not have perfect detection of all protocol errors
35378 because of transmission delays and the use of pipelining. If PIPELINING has
35379 been advertised to a client, an Exim server assumes that the client will use
35380 it, and therefore it does not count &"expected"& errors (for example, RCPT
35381 received after rejecting MAIL) as protocol errors.
35382 .next
35383 .cindex "SMTP" "logging syntax errors"
35384 .cindex "SMTP" "syntax errors; logging"
35385 .cindex "SMTP" "unknown command; logging"
35386 .cindex "log" "unknown SMTP command"
35387 .cindex "log" "SMTP syntax error"
35388 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35389 encountered. An unrecognized command is treated as a syntax error. For an
35390 external connection, the host identity is given; for an internal connection
35391 using &%-bs%& the sender identification (normally the calling user) is given.
35392 .next
35393 .cindex "log" "subject"
35394 .cindex "subject, logging"
35395 &%subject%&: The subject of the message is added to the arrival log line,
35396 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35397 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35398 specifies whether characters with values greater than 127 should be logged
35399 unchanged, or whether they should be rendered as escape sequences.
35400 .next
35401 .cindex "log" "certificate verification"
35402 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35403 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35404 verified, and &`CV=no`& if not.
35405 .next
35406 .cindex "log" "TLS cipher"
35407 .cindex "TLS" "logging cipher"
35408 &%tls_cipher%&: When a message is sent or received over an encrypted
35409 connection, the cipher suite used is added to the log line, preceded by X=.
35410 .next
35411 .cindex "log" "TLS peer DN"
35412 .cindex "TLS" "logging peer DN"
35413 &%tls_peerdn%&: When a message is sent or received over an encrypted
35414 connection, and a certificate is supplied by the remote host, the peer DN is
35415 added to the log line, preceded by DN=.
35416 .next
35417 .cindex "log" "TLS SNI"
35418 .cindex "TLS" "logging SNI"
35419 &%tls_sni%&: When a message is received over an encrypted connection, and
35420 the remote host provided the Server Name Indication extension, the SNI is
35421 added to the log line, preceded by SNI=.
35422 .next
35423 .cindex "log" "DNS failure in list"
35424 &%unknown_in_list%&: This setting causes a log entry to be written when the
35425 result of a list match is failure because a DNS lookup failed.
35426 .endlist
35427
35428
35429 .section "Message log" "SECID260"
35430 .cindex "message" "log file for"
35431 .cindex "log" "message log; description of"
35432 .cindex "&_msglog_& directory"
35433 .oindex "&%preserve_message_logs%&"
35434 In addition to the general log files, Exim writes a log file for each message
35435 that it handles. The names of these per-message logs are the message ids, and
35436 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35437 message log contains copies of the log lines that apply to the message. This
35438 makes it easier to inspect the status of an individual message without having
35439 to search the main log. A message log is deleted when processing of the message
35440 is complete, unless &%preserve_message_logs%& is set, but this should be used
35441 only with great care because they can fill up your disk very quickly.
35442
35443 On a heavily loaded system, it may be desirable to disable the use of
35444 per-message logs, in order to reduce disk I/O. This can be done by setting the
35445 &%message_logs%& option false.
35446 .ecindex IIDloggen
35447
35448
35449
35450
35451 . ////////////////////////////////////////////////////////////////////////////
35452 . ////////////////////////////////////////////////////////////////////////////
35453
35454 .chapter "Exim utilities" "CHAPutils"
35455 .scindex IIDutils "utilities"
35456 A number of utility scripts and programs are supplied with Exim and are
35457 described in this chapter. There is also the Exim Monitor, which is covered in
35458 the next chapter. The utilities described here are:
35459
35460 .itable none 0 0 3  7* left  15* left  40* left
35461 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35462   "list what Exim processes are doing"
35463 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35464 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35465 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35466 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35467                                                 various criteria"
35468 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35469 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35470   "extract statistics from the log"
35471 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35472   "check address acceptance from given IP"
35473 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35474 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35475 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35476 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35477 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35478 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35479 .endtable
35480
35481 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35482 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35483 &url(http://duncanthrax.net/exilog/) for details.
35484
35485
35486
35487
35488 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35489 .cindex "&'exiwhat'&"
35490 .cindex "process, querying"
35491 .cindex "SIGUSR1"
35492 On operating systems that can restart a system call after receiving a signal
35493 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35494 a line describing what it is doing to the file &_exim-process.info_& in the
35495 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35496 processes it can find, having first emptied the file. It then waits for one
35497 second to allow the Exim processes to react before displaying the results. In
35498 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35499 send the signal to the Exim processes, so it is normally run as root.
35500
35501 &*Warning*&: This is not an efficient process. It is intended for occasional
35502 use by system administrators. It is not sensible, for example, to set up a
35503 script that sends SIGUSR1 signals to Exim processes at short intervals.
35504
35505
35506 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35507 varies in different operating systems. Not only are different options used,
35508 but the format of the output is different. For this reason, there are some
35509 system configuration options that configure exactly how &'exiwhat'& works. If
35510 it doesn't seem to be working for you, check the following compile-time
35511 options:
35512 .display
35513 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35514 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35515 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35516 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35517 .endd
35518 An example of typical output from &'exiwhat'& is
35519 .code
35520 164 daemon: -q1h, listening on port 25
35521 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35522 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35523   [10.19.42.42] (editor@ref.example)
35524 10592 handling incoming call from [192.168.243.242]
35525 10628 accepting a local non-SMTP message
35526 .endd
35527 The first number in the output line is the process number. The third line has
35528 been split here, in order to fit it on the page.
35529
35530
35531
35532 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35533 .cindex "&'exiqgrep'&"
35534 .cindex "queue" "grepping"
35535 This utility is a Perl script contributed by Matt Hubbard. It runs
35536 .code
35537 exim -bpu
35538 .endd
35539 or (in case &*-a*& switch is specified)
35540 .code
35541 exim -bp
35542 .endd
35543 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35544 contain alternate exim configuration the queue management might be using.
35545
35546 to obtain a queue listing, and then greps the output to select messages 
35547 that match given criteria. The following selection options are available:
35548
35549 .vlist
35550 .vitem &*-f*&&~<&'regex'&>
35551 Match the sender address using a case-insensitive search. The field that is
35552 tested is enclosed in angle brackets, so you can test for bounce messages with
35553 .code
35554 exiqgrep -f '^<>$'
35555 .endd
35556 .vitem &*-r*&&~<&'regex'&>
35557 Match a recipient address using a case-insensitve search. The field that is
35558 tested is not enclosed in angle brackets.
35559
35560 .vitem &*-s*&&~<&'regex'&>
35561 Match against the size field.
35562
35563 .vitem &*-y*&&~<&'seconds'&>
35564 Match messages that are younger than the given time.
35565
35566 .vitem &*-o*&&~<&'seconds'&>
35567 Match messages that are older than the given time.
35568
35569 .vitem &*-z*&
35570 Match only frozen messages.
35571
35572 .vitem &*-x*&
35573 Match only non-frozen messages.
35574 .endlist
35575
35576 The following options control the format of the output:
35577
35578 .vlist
35579 .vitem &*-c*&
35580 Display only the count of matching messages.
35581
35582 .vitem &*-l*&
35583 Long format &-- display the full message information as output by Exim. This is
35584 the default.
35585
35586 .vitem &*-i*&
35587 Display message ids only.
35588
35589 .vitem &*-b*&
35590 Brief format &-- one line per message.
35591
35592 .vitem &*-R*&
35593 Display messages in reverse order.
35594
35595 .vitem &*-a*&
35596 Include delivered recipients in queue listing.
35597 .endlist
35598
35599 There is one more option, &%-h%&, which outputs a list of options.
35600
35601
35602
35603 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35604 .cindex "&'exiqsumm'&"
35605 .cindex "queue" "summary"
35606 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35607 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35608 running a command such as
35609 .code
35610 exim -bp | exiqsumm
35611 .endd
35612 The output consists of one line for each domain that has messages waiting for
35613 it, as in the following example:
35614 .code
35615 3   2322   74m   66m  msn.com.example
35616 .endd
35617 Each line lists the number of pending deliveries for a domain, their total
35618 volume, and the length of time that the oldest and the newest messages have
35619 been waiting. Note that the number of pending deliveries is greater than the
35620 number of messages when messages have more than one recipient.
35621
35622 A summary line is output at the end. By default the output is sorted on the
35623 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35624 the output to be sorted by oldest message and by count of messages,
35625 respectively. There are also three options that split the messages for each
35626 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35627 separates frozen messages, and &%-s%& separates messages according to their
35628 sender.
35629
35630 The output of &'exim -bp'& contains the original addresses in the message, so
35631 this also applies to the output from &'exiqsumm'&. No domains from addresses
35632 generated by aliasing or forwarding are included (unless the &%one_time%&
35633 option of the &(redirect)& router has been used to convert them into &"top
35634 level"& addresses).
35635
35636
35637
35638
35639 .section "Extracting specific information from the log (exigrep)" &&&
35640          "SECTextspeinf"
35641 .cindex "&'exigrep'&"
35642 .cindex "log" "extracts; grepping for"
35643 The &'exigrep'& utility is a Perl script that searches one or more main log
35644 files for entries that match a given pattern. When it finds a match, it
35645 extracts all the log entries for the relevant message, not just those that
35646 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35647 given message, or all mail for a given user, or for a given host, for example.
35648 The input files can be in Exim log format or syslog format.
35649 If a matching log line is not associated with a specific message, it is
35650 included in &'exigrep'&'s output without any additional lines. The usage is:
35651 .display
35652 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35653 .endd
35654 If no log file names are given on the command line, the standard input is read.
35655
35656 The &%-t%& argument specifies a number of seconds. It adds an additional
35657 condition for message selection. Messages that are complete are shown only if
35658 they spent more than <&'n'&> seconds on the queue.
35659
35660 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35661 makes it case-sensitive. This may give a performance improvement when searching
35662 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35663 option; with &%-I%& they do not. In both cases it is possible to change the
35664 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35665
35666 The &%-l%& option means &"literal"&, that is, treat all characters in the
35667 pattern as standing for themselves. Otherwise the pattern must be a Perl
35668 regular expression.
35669
35670 The &%-v%& option inverts the matching condition. That is, a line is selected
35671 if it does &'not'& match the pattern.
35672
35673 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35674 that are generated as a result/response to a message that &'exigrep'& matched
35675 normally.
35676
35677 Example of &%-M%&:
35678 user_a sends a message to user_b, which generates a bounce back to user_b. If
35679 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35680 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35681 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35682 when searching for &"user_a"& will show both messages since the bounce is
35683 &"related"& to or a &"result"& of the first message that was found by the
35684 search term.
35685
35686 If the location of a &'zcat'& command is known from the definition of
35687 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35688 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35689
35690
35691 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35692 .cindex "&'exipick'&"
35693 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35694 lists messages from the queue according to a variety of criteria. For details
35695 of &'exipick'&'s facilities, visit the web page at
35696 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35697 the &%--help%& option.
35698
35699
35700 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35701 .cindex "log" "cycling local files"
35702 .cindex "cycling logs"
35703 .cindex "&'exicyclog'&"
35704 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35705 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35706 you are using log files with datestamps in their names (see section
35707 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35708 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35709 There are two command line options for &'exicyclog'&:
35710 .ilist
35711 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35712 default that is set when Exim is built. The default default is 10.
35713 .next
35714 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35715 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35716 overriding the script's default, which is to find the setting from Exim's
35717 configuration.
35718 .endlist
35719
35720 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35721 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35722 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35723 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35724 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35725 logs are handled similarly.
35726
35727 If the limit is greater than 99, the script uses 3-digit numbers such as
35728 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35729 to one that is greater, or &'vice versa'&, you will have to fix the names of
35730 any existing log files.
35731
35732 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35733 the end are deleted. All files with numbers greater than 01 are compressed,
35734 using a compression command which is configured by the COMPRESS_COMMAND
35735 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35736 root &%crontab%& entry of the form
35737 .code
35738 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35739 .endd
35740 assuming you have used the name &"exim"& for the Exim user. You can run
35741 &'exicyclog'& as root if you wish, but there is no need.
35742
35743
35744
35745 .section "Mail statistics (eximstats)" "SECTmailstat"
35746 .cindex "statistics"
35747 .cindex "&'eximstats'&"
35748 A Perl script called &'eximstats'& is provided for extracting statistical
35749 information from log files. The output is either plain text, or HTML.
35750 Exim log files are also supported by the &'Lire'& system produced by the
35751 LogReport Foundation &url(http://www.logreport.org).
35752
35753 The &'eximstats'& script has been hacked about quite a bit over time. The
35754 latest version is the result of some extensive revision by Steve Campbell. A
35755 lot of information is given by default, but there are options for suppressing
35756 various parts of it. Following any options, the arguments to the script are a
35757 list of files, which should be main log files. For example:
35758 .code
35759 eximstats -nr /var/spool/exim/log/mainlog.01
35760 .endd
35761 By default, &'eximstats'& extracts information about the number and volume of
35762 messages received from or delivered to various hosts. The information is sorted
35763 both by message count and by volume, and the top fifty hosts in each category
35764 are listed on the standard output. Similar information, based on email
35765 addresses or domains instead of hosts can be requested by means of various
35766 options. For messages delivered and received locally, similar statistics are
35767 also produced per user.
35768
35769 The output also includes total counts and statistics about delivery errors, and
35770 histograms showing the number of messages received and deliveries made in each
35771 hour of the day. A delivery with more than one address in its envelope (for
35772 example, an SMTP transaction with more than one RCPT command) is counted
35773 as a single delivery by &'eximstats'&.
35774
35775 Though normally more deliveries than receipts are reported (as messages may
35776 have multiple recipients), it is possible for &'eximstats'& to report more
35777 messages received than delivered, even though the queue is empty at the start
35778 and end of the period in question. If an incoming message contains no valid
35779 recipients, no deliveries are recorded for it. A bounce message is handled as
35780 an entirely separate message.
35781
35782 &'eximstats'& always outputs a grand total summary giving the volume and number
35783 of messages received and deliveries made, and the number of hosts involved in
35784 each case. It also outputs the number of messages that were delayed (that is,
35785 not completely delivered at the first attempt), and the number that had at
35786 least one address that failed.
35787
35788 The remainder of the output is in sections that can be independently disabled
35789 or modified by various options. It consists of a summary of deliveries by
35790 transport, histograms of messages received and delivered per time interval
35791 (default per hour), information about the time messages spent on the queue,
35792 a list of relayed messages, lists of the top fifty sending hosts, local
35793 senders, destination hosts, and destination local users by count and by volume,
35794 and a list of delivery errors that occurred.
35795
35796 The relay information lists messages that were actually relayed, that is, they
35797 came from a remote host and were directly delivered to some other remote host,
35798 without being processed (for example, for aliasing or forwarding) locally.
35799
35800 There are quite a few options for &'eximstats'& to control exactly what it
35801 outputs. These are documented in the Perl script itself, and can be extracted
35802 by running the command &(perldoc)& on the script. For example:
35803 .code
35804 perldoc /usr/exim/bin/eximstats
35805 .endd
35806
35807 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35808 .cindex "&'exim_checkaccess'&"
35809 .cindex "policy control" "checking access"
35810 .cindex "checking access"
35811 The &%-bh%& command line argument allows you to run a fake SMTP session with
35812 debugging output, in order to check what Exim is doing when it is applying
35813 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35814 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35815 sometimes you just want to answer the question &"Does this address have
35816 access?"& without bothering with any further details.
35817
35818 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35819 two arguments, an IP address and an email address:
35820 .code
35821 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35822 .endd
35823 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35824 given email address would be accepted in a RCPT command in a TCP/IP
35825 connection from the host with the given IP address. The output of the utility
35826 is either the word &"accepted"&, or the SMTP error response, for example:
35827 .code
35828 Rejected:
35829 550 Relay not permitted
35830 .endd
35831 When running this test, the utility uses &`<>`& as the envelope sender address
35832 for the MAIL command, but you can change this by providing additional
35833 options. These are passed directly to the Exim command. For example, to specify
35834 that the test is to be run with the sender address &'himself@there.example'&
35835 you can use:
35836 .code
35837 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35838                  -f himself@there.example
35839 .endd
35840 Note that these additional Exim command line items must be given after the two
35841 mandatory arguments.
35842
35843 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35844 while running its checks. You can run checks that include callouts by using
35845 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35846
35847
35848
35849 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35850 .cindex "DBM" "building dbm files"
35851 .cindex "building DBM files"
35852 .cindex "&'exim_dbmbuild'&"
35853 .cindex "lower casing"
35854 .cindex "binary zero" "in lookup key"
35855 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35856 the format used by the &(lsearch)& lookup (see section
35857 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35858 names as keys and the remainder of the information as data. The lower-casing
35859 can be prevented by calling the program with the &%-nolc%& option.
35860
35861 A terminating zero is included as part of the key string. This is expected by
35862 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35863 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35864 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35865 files.
35866
35867 The program requires two arguments: the name of the input file (which can be a
35868 single hyphen to indicate the standard input), and the name of the output file.
35869 It creates the output under a temporary name, and then renames it if all went
35870 well.
35871
35872 .cindex "USE_DB"
35873 If the native DB interface is in use (USE_DB is set in a compile-time
35874 configuration file &-- this is common in free versions of Unix) the two file
35875 names must be different, because in this mode the Berkeley DB functions create
35876 a single output file using exactly the name given. For example,
35877 .code
35878 exim_dbmbuild /etc/aliases /etc/aliases.db
35879 .endd
35880 reads the system alias file and creates a DBM version of it in
35881 &_/etc/aliases.db_&.
35882
35883 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35884 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35885 environment, the suffixes are added to the second argument of
35886 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35887 when the Berkeley functions are used in compatibility mode (though this is not
35888 recommended), because in that case it adds a &_.db_& suffix to the file name.
35889
35890 If a duplicate key is encountered, the program outputs a warning, and when it
35891 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35892 option is used. By default, only the first of a set of duplicates is used &--
35893 this makes it compatible with &(lsearch)& lookups. There is an option
35894 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35895 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35896 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35897 return code is 2.
35898
35899
35900
35901
35902 .section "Finding individual retry times (exinext)" "SECTfinindret"
35903 .cindex "retry" "times"
35904 .cindex "&'exinext'&"
35905 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35906 fish specific information out of the retry database. Given a mail domain (or a
35907 complete address), it looks up the hosts for that domain, and outputs any retry
35908 information for the hosts or for the domain. At present, the retry information
35909 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35910 output. For example:
35911 .code
35912 $ exinext piglet@milne.fict.example
35913 kanga.milne.example:192.168.8.1 error 146: Connection refused
35914   first failed: 21-Feb-1996 14:57:34
35915   last tried:   21-Feb-1996 14:57:34
35916   next try at:  21-Feb-1996 15:02:34
35917 roo.milne.example:192.168.8.3 error 146: Connection refused
35918   first failed: 20-Jan-1996 13:12:08
35919   last tried:   21-Feb-1996 11:42:03
35920   next try at:  21-Feb-1996 19:42:03
35921   past final cutoff time
35922 .endd
35923 You can also give &'exinext'& a local part, without a domain, and it
35924 will give any retry information for that local part in your default domain.
35925 A message id can be used to obtain retry information pertaining to a specific
35926 message. This exists only when an attempt to deliver a message to a remote host
35927 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35928 &'exinext'& is not particularly efficient, but then it is not expected to be
35929 run very often.
35930
35931 The &'exinext'& utility calls Exim to find out information such as the location
35932 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35933 passed on to the &'exim'& commands. The first specifies an alternate Exim
35934 configuration file, and the second sets macros for use within the configuration
35935 file. These features are mainly to help in testing, but might also be useful in
35936 environments where more than one configuration file is in use.
35937
35938
35939
35940 .section "Hints database maintenance" "SECThindatmai"
35941 .cindex "hints database" "maintenance"
35942 .cindex "maintaining Exim's hints database"
35943 Three utility programs are provided for maintaining the DBM files that Exim
35944 uses to contain its delivery hint information. Each program requires two
35945 arguments. The first specifies the name of Exim's spool directory, and the
35946 second is the name of the database it is to operate on. These are as follows:
35947
35948 .ilist
35949 &'retry'&: the database of retry information
35950 .next
35951 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35952 for remote hosts
35953 .next
35954 &'callout'&: the callout cache
35955 .next
35956 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35957 .next
35958 &'misc'&: other hints data
35959 .endlist
35960
35961 The &'misc'& database is used for
35962
35963 .ilist
35964 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35965 .next
35966 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35967 &(smtp)& transport)
35968 .endlist
35969
35970
35971
35972 .section "exim_dumpdb" "SECID261"
35973 .cindex "&'exim_dumpdb'&"
35974 The entire contents of a database are written to the standard output by the
35975 &'exim_dumpdb'& program, which has no options or arguments other than the
35976 spool and database names. For example, to dump the retry database:
35977 .code
35978 exim_dumpdb /var/spool/exim retry
35979 .endd
35980 Two lines of output are produced for each entry:
35981 .code
35982 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35983 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35984 .endd
35985 The first item on the first line is the key of the record. It starts with one
35986 of the letters R, or T, depending on whether it refers to a routing or
35987 transport retry. For a local delivery, the next part is the local address; for
35988 a remote delivery it is the name of the remote host, followed by its failing IP
35989 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35990 transport). If the remote port is not the standard one (port 25), it is added
35991 to the IP address. Then there follows an error code, an additional error code,
35992 and a textual description of the error.
35993
35994 The three times on the second line are the time of first failure, the time of
35995 the last delivery attempt, and the computed time for the next attempt. The line
35996 ends with an asterisk if the cutoff time for the last retry rule has been
35997 exceeded.
35998
35999 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36000 consists of a host name followed by a list of ids for messages that are or were
36001 waiting to be delivered to that host. If there are a very large number for any
36002 one host, continuation records, with a sequence number added to the host name,
36003 may be seen. The data in these records is often out of date, because a message
36004 may be routed to several alternative hosts, and Exim makes no effort to keep
36005 cross-references.
36006
36007
36008
36009 .section "exim_tidydb" "SECID262"
36010 .cindex "&'exim_tidydb'&"
36011 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36012 database. If run with no options, it removes all records that are more than 30
36013 days old. The age is calculated from the date and time that the record was last
36014 updated. Note that, in the case of the retry database, it is &'not'& the time
36015 since the first delivery failure. Information about a host that has been down
36016 for more than 30 days will remain in the database, provided that the record is
36017 updated sufficiently often.
36018
36019 The cutoff date can be altered by means of the &%-t%& option, which must be
36020 followed by a time. For example, to remove all records older than a week from
36021 the retry database:
36022 .code
36023 exim_tidydb -t 7d /var/spool/exim retry
36024 .endd
36025 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36026 message ids. In the former these appear as data in records keyed by host &--
36027 they were messages that were waiting for that host &-- and in the latter they
36028 are the keys for retry information for messages that have suffered certain
36029 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36030 message ids in database records are those of messages that are still on the
36031 queue. Message ids for messages that no longer exist are removed from
36032 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36033 For the &'retry'& database, records whose keys are non-existent message ids are
36034 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36035 whenever it removes information from the database.
36036
36037 Certain records are automatically removed by Exim when they are no longer
36038 needed, but others are not. For example, if all the MX hosts for a domain are
36039 down, a retry record is created for each one. If the primary MX host comes back
36040 first, its record is removed when Exim successfully delivers to it, but the
36041 records for the others remain because Exim has not tried to use those hosts.
36042
36043 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36044 hints databases. You should do this at a quiet time of day, because it requires
36045 a database to be locked (and therefore inaccessible to Exim) while it does its
36046 work. Removing records from a DBM file does not normally make the file smaller,
36047 but all the common DBM libraries are able to re-use the space that is released.
36048 After an initial phase of increasing in size, the databases normally reach a
36049 point at which they no longer get any bigger, as long as they are regularly
36050 tidied.
36051
36052 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36053 databases is likely to keep on increasing.
36054
36055
36056
36057
36058 .section "exim_fixdb" "SECID263"
36059 .cindex "&'exim_fixdb'&"
36060 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36061 Its main use is for testing Exim, but it might also be occasionally useful for
36062 getting round problems in a live system. It has no options, and its interface
36063 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36064 key of a database record can then be entered, and the data for that record is
36065 displayed.
36066
36067 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36068 except the &'retry'& database, that is the only operation that can be carried
36069 out. For the &'retry'& database, each field is output preceded by a number, and
36070 data for individual fields can be changed by typing the field number followed
36071 by new data, for example:
36072 .code
36073 > 4 951102:1000
36074 .endd
36075 resets the time of the next delivery attempt. Time values are given as a
36076 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36077 used as optional separators.
36078
36079
36080
36081
36082 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36083 .cindex "mailbox" "maintenance"
36084 .cindex "&'exim_lock'&"
36085 .cindex "locking mailboxes"
36086 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36087 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36088 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36089 a user agent while investigating a problem. The utility requires the name of
36090 the file as its first argument. If the locking is successful, the second
36091 argument is run as a command (using C's &[system()]& function); if there is no
36092 second argument, the value of the SHELL environment variable is used; if this
36093 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36094 is unlocked and the utility ends. The following options are available:
36095
36096 .vlist
36097 .vitem &%-fcntl%&
36098 Use &[fcntl()]& locking on the open mailbox.
36099
36100 .vitem &%-flock%&
36101 Use &[flock()]& locking on the open mailbox, provided the operating system
36102 supports it.
36103
36104 .vitem &%-interval%&
36105 This must be followed by a number, which is a number of seconds; it sets the
36106 interval to sleep between retries (default 3).
36107
36108 .vitem &%-lockfile%&
36109 Create a lock file before opening the mailbox.
36110
36111 .vitem &%-mbx%&
36112 Lock the mailbox using MBX rules.
36113
36114 .vitem &%-q%&
36115 Suppress verification output.
36116
36117 .vitem &%-retries%&
36118 This must be followed by a number; it sets the number of times to try to get
36119 the lock (default 10).
36120
36121 .vitem &%-restore_time%&
36122 This option causes &%exim_lock%& to restore the modified and read times to the
36123 locked file before exiting. This allows you to access a locked mailbox (for
36124 example, to take a backup copy) without disturbing the times that the user
36125 subsequently sees.
36126
36127 .vitem &%-timeout%&
36128 This must be followed by a number, which is a number of seconds; it sets a
36129 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36130 default), a non-blocking call is used.
36131
36132 .vitem &%-v%&
36133 Generate verbose output.
36134 .endlist
36135
36136 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36137 default is to create a lock file and also to use &[fcntl()]& locking on the
36138 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36139 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36140 requires that the directory containing the file be writeable. Locking by lock
36141 file does not last for ever; Exim assumes that a lock file is expired if it is
36142 more than 30 minutes old.
36143
36144 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36145 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36146 to be taken out on the open mailbox, and an exclusive lock on the file
36147 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36148 number of the mailbox file. When the locking is released, if an exclusive lock
36149 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36150
36151 The default output contains verification of the locking that takes place. The
36152 &%-v%& option causes some additional information to be given. The &%-q%& option
36153 suppresses all output except error messages.
36154
36155 A command such as
36156 .code
36157 exim_lock /var/spool/mail/spqr
36158 .endd
36159 runs an interactive shell while the file is locked, whereas
36160 .display
36161 &`exim_lock -q /var/spool/mail/spqr <<End`&
36162 <&'some commands'&>
36163 &`End`&
36164 .endd
36165 runs a specific non-interactive sequence of commands while the file is locked,
36166 suppressing all verification output. A single command can be run by a command
36167 such as
36168 .code
36169 exim_lock -q /var/spool/mail/spqr \
36170   "cp /var/spool/mail/spqr /some/where"
36171 .endd
36172 Note that if a command is supplied, it must be entirely contained within the
36173 second argument &-- hence the quotes.
36174 .ecindex IIDutils
36175
36176
36177 . ////////////////////////////////////////////////////////////////////////////
36178 . ////////////////////////////////////////////////////////////////////////////
36179
36180 .chapter "The Exim monitor" "CHAPeximon"
36181 .scindex IIDeximon "Exim monitor" "description"
36182 .cindex "X-windows"
36183 .cindex "&'eximon'&"
36184 .cindex "Local/eximon.conf"
36185 .cindex "&_exim_monitor/EDITME_&"
36186 The Exim monitor is an application which displays in an X window information
36187 about the state of Exim's queue and what Exim is doing. An admin user can
36188 perform certain operations on messages from this GUI interface; however all
36189 such facilities are also available from the command line, and indeed, the
36190 monitor itself makes use of the command line to perform any actions requested.
36191
36192
36193
36194 .section "Running the monitor" "SECID264"
36195 The monitor is started by running the script called &'eximon'&. This is a shell
36196 script that sets up a number of environment variables, and then runs the
36197 binary called &_eximon.bin_&. The default appearance of the monitor window can
36198 be changed by editing the &_Local/eximon.conf_& file created by editing
36199 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36200 parameters are for.
36201
36202 The parameters that get built into the &'eximon'& script can be overridden for
36203 a particular invocation by setting up environment variables of the same names,
36204 preceded by &`EXIMON_`&. For example, a shell command such as
36205 .code
36206 EXIMON_LOG_DEPTH=400 eximon
36207 .endd
36208 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36209 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36210 overrides the Exim log file configuration. This makes it possible to have
36211 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36212 syslog messages are routed to a file on the local host.
36213
36214 X resources can be used to change the appearance of the window in the normal
36215 way. For example, a resource setting of the form
36216 .code
36217 Eximon*background: gray94
36218 .endd
36219 changes the colour of the background to light grey rather than white. The
36220 stripcharts are drawn with both the data lines and the reference lines in
36221 black. This means that the reference lines are not visible when on top of the
36222 data. However, their colour can be changed by setting a resource called
36223 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36224 For example, if your X server is running Unix, you could set up lighter
36225 reference lines in the stripcharts by obeying
36226 .code
36227 xrdb -merge <<End
36228 Eximon*highlight: gray
36229 End
36230 .endd
36231 .cindex "admin user"
36232 In order to see the contents of messages on the queue, and to operate on them,
36233 &'eximon'& must either be run as root or by an admin user.
36234
36235 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36236 contain X11 resource parameters interpreted by the X11 library.  In addition,
36237 if the first parameter starts with the string "gdb" then it is removed and the
36238 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36239 versioned variants of gdb can be invoked).
36240
36241 The monitor's window is divided into three parts. The first contains one or
36242 more stripcharts and two action buttons, the second contains a &"tail"& of the
36243 main log file, and the third is a display of the queue of messages awaiting
36244 delivery, with two more action buttons. The following sections describe these
36245 different parts of the display.
36246
36247
36248
36249
36250 .section "The stripcharts" "SECID265"
36251 .cindex "stripchart"
36252 The first stripchart is always a count of messages on the queue. Its name can
36253 be configured by setting QUEUE_STRIPCHART_NAME in the
36254 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36255 configuration script by regular expression matches on log file entries, making
36256 it possible to display, for example, counts of messages delivered to certain
36257 hosts or using certain transports. The supplied defaults display counts of
36258 received and delivered messages, and of local and SMTP deliveries. The default
36259 period between stripchart updates is one minute; this can be adjusted by a
36260 parameter in the &_Local/eximon.conf_& file.
36261
36262 The stripchart displays rescale themselves automatically as the value they are
36263 displaying changes. There are always 10 horizontal lines in each chart; the
36264 title string indicates the value of each division when it is greater than one.
36265 For example, &"x2"& means that each division represents a value of 2.
36266
36267 It is also possible to have a stripchart which shows the percentage fullness of
36268 a particular disk partition, which is useful when local deliveries are confined
36269 to a single partition.
36270
36271 .cindex "&%statvfs%& function"
36272 This relies on the availability of the &[statvfs()]& function or equivalent in
36273 the operating system. Most, but not all versions of Unix that support Exim have
36274 this. For this particular stripchart, the top of the chart always represents
36275 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36276 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36277 &_Local/eximon.conf_& file.
36278
36279
36280
36281
36282 .section "Main action buttons" "SECID266"
36283 .cindex "size" "of monitor window"
36284 .cindex "Exim monitor" "window size"
36285 .cindex "window size"
36286 Below the stripcharts there is an action button for quitting the monitor. Next
36287 to this is another button marked &"Size"&. They are placed here so that
36288 shrinking the window to its default minimum size leaves just the queue count
36289 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36290 the window to expand to its maximum size, unless it is already at the maximum,
36291 in which case it is reduced to its minimum.
36292
36293 When expanding to the maximum, if the window cannot be fully seen where it
36294 currently is, it is moved back to where it was the last time it was at full
36295 size. When it is expanding from its minimum size, the old position is
36296 remembered, and next time it is reduced to the minimum it is moved back there.
36297
36298 The idea is that you can keep a reduced window just showing one or two
36299 stripcharts at a convenient place on your screen, easily expand it to show
36300 the full window when required, and just as easily put it back to what it was.
36301 The idea is copied from what the &'twm'& window manager does for its
36302 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36303 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36304
36305 Normally, the monitor starts up with the window at its full size, but it can be
36306 built so that it starts up with the window at its smallest size, by setting
36307 START_SMALL=yes in &_Local/eximon.conf_&.
36308
36309
36310
36311 .section "The log display" "SECID267"
36312 .cindex "log" "tail of; in monitor"
36313 The second section of the window is an area in which a display of the tail of
36314 the main log is maintained.
36315 To save space on the screen, the timestamp on each log line is shortened by
36316 removing the date and, if &%log_timezone%& is set, the timezone.
36317 The log tail is not available when the only destination for logging data is
36318 syslog, unless the syslog lines are routed to a local file whose name is passed
36319 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36320
36321 The log sub-window has a scroll bar at its lefthand side which can be used to
36322 move back to look at earlier text, and the up and down arrow keys also have a
36323 scrolling effect. The amount of log that is kept depends on the setting of
36324 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36325 to use. When this is full, the earlier 50% of data is discarded &-- this is
36326 much more efficient than throwing it away line by line. The sub-window also has
36327 a horizontal scroll bar for accessing the ends of long log lines. This is the
36328 only means of horizontal scrolling; the right and left arrow keys are not
36329 available. Text can be cut from this part of the window using the mouse in the
36330 normal way. The size of this subwindow is controlled by parameters in the
36331 configuration file &_Local/eximon.conf_&.
36332
36333 Searches of the text in the log window can be carried out by means of the ^R
36334 and ^S keystrokes, which default to a reverse and a forward search,
36335 respectively. The search covers only the text that is displayed in the window.
36336 It cannot go further back up the log.
36337
36338 The point from which the search starts is indicated by a caret marker. This is
36339 normally at the end of the text in the window, but can be positioned explicitly
36340 by pointing and clicking with the left mouse button, and is moved automatically
36341 by a successful search. If new text arrives in the window when it is scrolled
36342 back, the caret remains where it is, but if the window is not scrolled back,
36343 the caret is moved to the end of the new text.
36344
36345 Pressing ^R or ^S pops up a window into which the search text can be typed.
36346 There are buttons for selecting forward or reverse searching, for carrying out
36347 the search, and for cancelling. If the &"Search"& button is pressed, the search
36348 happens and the window remains so that further searches can be done. If the
36349 &"Return"& key is pressed, a single search is done and the window is closed. If
36350 ^C is typed the search is cancelled.
36351
36352 The searching facility is implemented using the facilities of the Athena text
36353 widget. By default this pops up a window containing both &"search"& and
36354 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36355 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36356 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36357 provided version of &%TextPop%& when the remaining parts of the text widget
36358 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36359 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36360 on these systems, at the expense of having unwanted items in the search popup
36361 window.
36362
36363
36364
36365 .section "The queue display" "SECID268"
36366 .cindex "queue" "display in monitor"
36367 The bottom section of the monitor window contains a list of all messages that
36368 are on the queue, which includes those currently being received or delivered,
36369 as well as those awaiting delivery. The size of this subwindow is controlled by
36370 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36371 at which it is updated is controlled by another parameter in the same file &--
36372 the default is 5 minutes, since queue scans can be quite expensive. However,
36373 there is an &"Update"& action button just above the display which can be used
36374 to force an update of the queue display at any time.
36375
36376 When a host is down for some time, a lot of pending mail can build up for it,
36377 and this can make it hard to deal with other messages on the queue. To help
36378 with this situation there is a button next to &"Update"& called &"Hide"&. If
36379 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36380 type anything in here and press &"Return"&, the text is added to a chain of
36381 such texts, and if every undelivered address in a message matches at least one
36382 of the texts, the message is not displayed.
36383
36384 If there is an address that does not match any of the texts, all the addresses
36385 are displayed as normal. The matching happens on the ends of addresses so, for
36386 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36387 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36388 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36389 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36390 a hide request is automatically cancelled after one hour.
36391
36392 While the dialogue box is displayed, you can't press any buttons or do anything
36393 else to the monitor window. For this reason, if you want to cut text from the
36394 queue display to use in the dialogue box, you have to do the cutting before
36395 pressing the &"Hide"& button.
36396
36397 The queue display contains, for each unhidden queued message, the length of
36398 time it has been on the queue, the size of the message, the message id, the
36399 message sender, and the first undelivered recipient, all on one line. If it is
36400 a bounce message, the sender is shown as &"<>"&. If there is more than one
36401 recipient to which the message has not yet been delivered, subsequent ones are
36402 listed on additional lines, up to a maximum configured number, following which
36403 an ellipsis is displayed. Recipients that have already received the message are
36404 not shown.
36405
36406 .cindex "frozen messages" "display"
36407 If a message is frozen, an asterisk is displayed at the left-hand side.
36408
36409 The queue display has a vertical scroll bar, and can also be scrolled by means
36410 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36411 The text searching facilities, as described above for the log window, are also
36412 available, but the caret is always moved to the end of the text when the queue
36413 display is updated.
36414
36415
36416
36417 .section "The queue menu" "SECID269"
36418 .cindex "queue" "menu in monitor"
36419 If the &%shift%& key is held down and the left button is clicked when the mouse
36420 pointer is over the text for any message, an action menu pops up, and the first
36421 line of the queue display for the message is highlighted. This does not affect
36422 any selected text.
36423
36424 If you want to use some other event for popping up the menu, you can set the
36425 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36426 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36427 value set in this parameter is a standard X event description. For example, to
36428 run eximon using &%ctrl%& rather than &%shift%& you could use
36429 .code
36430 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36431 .endd
36432 The title of the menu is the message id, and it contains entries which act as
36433 follows:
36434
36435 .ilist
36436 &'message log'&: The contents of the message log for the message are displayed
36437 in a new text window.
36438 .next
36439 &'headers'&: Information from the spool file that contains the envelope
36440 information and headers is displayed in a new text window. See chapter
36441 &<<CHAPspool>>& for a description of the format of spool files.
36442 .next
36443 &'body'&: The contents of the spool file containing the body of the message are
36444 displayed in a new text window. There is a default limit of 20,000 bytes to the
36445 amount of data displayed. This can be changed by setting the BODY_MAX
36446 option at compile time, or the EXIMON_BODY_MAX option at run time.
36447 .next
36448 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36449 delivery of the message. This causes an automatic thaw if the message is
36450 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36451 a new text window. The delivery is run in a separate process, to avoid holding
36452 up the monitor while the delivery proceeds.
36453 .next
36454 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36455 that the message be frozen.
36456 .next
36457 .cindex "thawing messages"
36458 .cindex "unfreezing messages"
36459 .cindex "frozen messages" "thawing"
36460 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36461 that the message be thawed.
36462 .next
36463 .cindex "delivery" "forcing failure"
36464 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36465 that Exim gives up trying to deliver the message. A bounce message is generated
36466 for any remaining undelivered addresses.
36467 .next
36468 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36469 that the message be deleted from the system without generating a bounce
36470 message.
36471 .next
36472 &'add recipient'&: A dialog box is displayed into which a recipient address can
36473 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36474 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36475 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36476 causes a call to Exim to be made using the &%-Mar%& option to request that an
36477 additional recipient be added to the message, unless the entry box is empty, in
36478 which case no action is taken.
36479 .next
36480 &'mark delivered'&: A dialog box is displayed into which a recipient address
36481 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36482 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36483 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36484 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36485 recipient address as already delivered, unless the entry box is empty, in which
36486 case no action is taken.
36487 .next
36488 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36489 mark all recipient addresses as already delivered.
36490 .next
36491 &'edit sender'&: A dialog box is displayed initialized with the current
36492 sender's address. Pressing RETURN causes a call to Exim to be made using the
36493 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36494 in which case no action is taken. If you want to set an empty sender (as in
36495 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36496 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36497 the address is qualified with that domain.
36498 .endlist
36499
36500 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36501 other cases when a call to Exim is made, if there is any output from Exim (in
36502 particular, if the command fails) a window containing the command and the
36503 output is displayed. Otherwise, the results of the action are normally apparent
36504 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36505 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36506 if no output is generated.
36507
36508 The queue display is automatically updated for actions such as freezing and
36509 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36510 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36511 force an update of the display after one of these actions.
36512
36513 In any text window that is displayed as result of a menu action, the normal
36514 cut-and-paste facility is available, and searching can be carried out using ^R
36515 and ^S, as described above for the log tail window.
36516 .ecindex IIDeximon
36517
36518
36519
36520
36521
36522 . ////////////////////////////////////////////////////////////////////////////
36523 . ////////////////////////////////////////////////////////////////////////////
36524
36525 .chapter "Security considerations" "CHAPsecurity"
36526 .scindex IIDsecurcon "security" "discussion of"
36527 This chapter discusses a number of issues concerned with security, some of
36528 which are also covered in other parts of this manual.
36529
36530 For reasons that this author does not understand, some people have promoted
36531 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36532 existence of this chapter in the documentation. However, the intent of the
36533 chapter is simply to describe the way Exim works in relation to certain
36534 security concerns, not to make any specific claims about the effectiveness of
36535 its security as compared with other MTAs.
36536
36537 What follows is a description of the way Exim is supposed to be. Best efforts
36538 have been made to try to ensure that the code agrees with the theory, but an
36539 absence of bugs can never be guaranteed. Any that are reported will get fixed
36540 as soon as possible.
36541
36542
36543 .section "Building a more &""hardened""& Exim" "SECID286"
36544 .cindex "security" "build-time features"
36545 There are a number of build-time options that can be set in &_Local/Makefile_&
36546 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36547 Exim administrator who does not have the root password, or by someone who has
36548 penetrated the Exim (but not the root) account. These options are as follows:
36549
36550 .ilist
36551 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36552 start of any file names used with the &%-C%& option. When it is set, these file
36553 names are also not allowed to contain the sequence &"/../"&. (However, if the
36554 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36555 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36556 default setting for &%ALT_CONFIG_PREFIX%&.
36557
36558 If the permitted configuration files are confined to a directory to
36559 which only root has access, this guards against someone who has broken
36560 into the Exim account from running a privileged Exim with an arbitrary
36561 configuration file, and using it to break into other accounts.
36562 .next
36563
36564 If a non-trusted configuration file (i.e. not the default configuration file
36565 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36566 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36567 the next item), then root privilege is retained only if the caller of Exim is
36568 root. This locks out the possibility of testing a configuration using &%-C%&
36569 right through message reception and delivery, even if the caller is root. The
36570 reception works, but by that time, Exim is running as the Exim user, so when
36571 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36572 privilege to be lost. However, root can test reception and delivery using two
36573 separate commands.
36574
36575 .next
36576 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36577 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36578 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36579 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36580 the restrictive side.  Requiring build-time selection of safe macros is onerous
36581 but this option is intended solely as a transition mechanism to permit
36582 previously-working configurations to continue to work after release 4.73.
36583 .next
36584 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36585 is disabled.
36586 .next
36587 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36588 never to be used for any deliveries. This is like the &%never_users%& runtime
36589 option, but it cannot be overridden; the runtime option adds additional users
36590 to the list. The default setting is &"root"&; this prevents a non-root user who
36591 is permitted to modify the runtime file from using Exim as a way to get root.
36592 .endlist
36593
36594
36595
36596 .section "Root privilege" "SECID270"
36597 .cindex "setuid"
36598 .cindex "root privilege"
36599 The Exim binary is normally setuid to root, which means that it gains root
36600 privilege (runs as root) when it starts execution. In some special cases (for
36601 example, when the daemon is not in use and there are no local deliveries), it
36602 may be possible to run Exim setuid to some user other than root. This is
36603 discussed in the next section. However, in most installations, root privilege
36604 is required for two things:
36605
36606 .ilist
36607 To set up a socket connected to the standard SMTP port (25) when initialising
36608 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36609 not required.
36610 .next
36611 To be able to change uid and gid in order to read users' &_.forward_& files and
36612 perform local deliveries as the receiving user or as specified in the
36613 configuration.
36614 .endlist
36615
36616 It is not necessary to be root to do any of the other things Exim does, such as
36617 receiving messages and delivering them externally over SMTP, and it is
36618 obviously more secure if Exim does not run as root except when necessary.
36619 For this reason, a user and group for Exim to use must be defined in
36620 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36621 group"&. Their values can be changed by the run time configuration, though this
36622 is not recommended. Often a user called &'exim'& is used, but some sites use
36623 &'mail'& or another user name altogether.
36624
36625 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36626 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36627 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36628
36629 After a new Exim process has interpreted its command line options, it changes
36630 uid and gid in the following cases:
36631
36632 .ilist
36633 .oindex "&%-C%&"
36634 .oindex "&%-D%&"
36635 If the &%-C%& option is used to specify an alternate configuration file, or if
36636 the &%-D%& option is used to define macro values for the configuration, and the
36637 calling process is not running as root, the uid and gid are changed to those of
36638 the calling process.
36639 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36640 option may not be used at all.
36641 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36642 can be supplied if the calling process is running as root, the Exim run-time
36643 user or CONFIGURE_OWNER, if defined.
36644 .next
36645 .oindex "&%-be%&"
36646 .oindex "&%-bf%&"
36647 .oindex "&%-bF%&"
36648 If the expansion test option (&%-be%&) or one of the filter testing options
36649 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36650 calling process.
36651 .next
36652 If the process is not a daemon process or a queue runner process or a delivery
36653 process or a process for testing address routing (started with &%-bt%&), the
36654 uid and gid are changed to the Exim user and group. This means that Exim always
36655 runs under its own uid and gid when receiving messages. This also applies when
36656 testing address verification
36657 .oindex "&%-bv%&"
36658 .oindex "&%-bh%&"
36659 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36660 option).
36661 .next
36662 For a daemon, queue runner, delivery, or address testing process, the uid
36663 remains as root at this stage, but the gid is changed to the Exim group.
36664 .endlist
36665
36666 The processes that initially retain root privilege behave as follows:
36667
36668 .ilist
36669 A daemon process changes the gid to the Exim group and the uid to the Exim
36670 user after setting up one or more listening sockets. The &[initgroups()]&
36671 function is called, so that if the Exim user is in any additional groups, they
36672 will be used during message reception.
36673 .next
36674 A queue runner process retains root privilege throughout its execution. Its
36675 job is to fork a controlled sequence of delivery processes.
36676 .next
36677 A delivery process retains root privilege throughout most of its execution,
36678 but any actual deliveries (that is, the transports themselves) are run in
36679 subprocesses which always change to a non-root uid and gid. For local
36680 deliveries this is typically the uid and gid of the owner of the mailbox; for
36681 remote deliveries, the Exim uid and gid are used. Once all the delivery
36682 subprocesses have been run, a delivery process changes to the Exim uid and gid
36683 while doing post-delivery tidying up such as updating the retry database and
36684 generating bounce and warning messages.
36685
36686 While the recipient addresses in a message are being routed, the delivery
36687 process runs as root. However, if a user's filter file has to be processed,
36688 this is done in a subprocess that runs under the individual user's uid and
36689 gid. A system filter is run as root unless &%system_filter_user%& is set.
36690 .next
36691 A process that is testing addresses (the &%-bt%& option) runs as root so that
36692 the routing is done in the same environment as a message delivery.
36693 .endlist
36694
36695
36696
36697
36698 .section "Running Exim without privilege" "SECTrunexiwitpri"
36699 .cindex "privilege, running without"
36700 .cindex "unprivileged running"
36701 .cindex "root privilege" "running without"
36702 Some installations like to run Exim in an unprivileged state for more of its
36703 operation, for added security. Support for this mode of operation is provided
36704 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36705 gid are changed to the Exim user and group at the start of a delivery process
36706 (and also queue runner and address testing processes). This means that address
36707 routing is no longer run as root, and the deliveries themselves cannot change
36708 to any other uid.
36709
36710 .cindex SIGHUP
36711 .cindex "daemon" "restarting"
36712 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36713 that the daemon can still be started in the usual way, and it can respond
36714 correctly to SIGHUP because the re-invocation regains root privilege.
36715
36716 An alternative approach is to make Exim setuid to the Exim user and also setgid
36717 to the Exim group. If you do this, the daemon must be started from a root
36718 process. (Calling Exim from a root process makes it behave in the way it does
36719 when it is setuid root.) However, the daemon cannot restart itself after a
36720 SIGHUP signal because it cannot regain privilege.
36721
36722 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36723 stops Exim from trying to re-invoke itself to do a delivery after a message has
36724 been received. Such a re-invocation is a waste of resources because it has no
36725 effect.
36726
36727 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36728 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36729 to the Exim user seems a clean approach, but there is one complication:
36730
36731 In this style of operation, Exim is running with the real uid and gid set to
36732 those of the calling process, and the effective uid/gid set to Exim's values.
36733 Ideally, any association with the calling process' uid/gid should be dropped,
36734 that is, the real uid/gid should be reset to the effective values so as to
36735 discard any privileges that the caller may have. While some operating systems
36736 have a function that permits this action for a non-root effective uid, quite a
36737 number of them do not. Because of this lack of standardization, Exim does not
36738 address this problem at this time.
36739
36740 For this reason, the recommended approach for &"mostly unprivileged"& running
36741 is to keep the Exim binary setuid to root, and to set
36742 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36743 be used in the most straightforward way.
36744
36745 If you configure Exim not to run delivery processes as root, there are a
36746 number of restrictions on what you can do:
36747
36748 .ilist
36749 You can deliver only as the Exim user/group. You should  explicitly use the
36750 &%user%& and &%group%& options to override routers or local transports that
36751 normally deliver as the recipient. This makes sure that configurations that
36752 work in this mode function the same way in normal mode. Any implicit or
36753 explicit specification of another user causes an error.
36754 .next
36755 Use of &_.forward_& files is severely restricted, such that it is usually
36756 not worthwhile to include them in the configuration.
36757 .next
36758 Users who wish to use &_.forward_& would have to make their home directory and
36759 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36760 and their equivalents in Exim filters, cannot be used. While they could be
36761 enabled in the Exim user's name, that would be insecure and not very useful.
36762 .next
36763 Unless the local user mailboxes are all owned by the Exim user (possible in
36764 some POP3 or IMAP-only environments):
36765
36766 .olist
36767 They must be owned by the Exim group and be writeable by that group. This
36768 implies you must set &%mode%& in the appendfile configuration, as well as the
36769 mode of the mailbox files themselves.
36770 .next
36771 You must set &%no_check_owner%&, since most or all of the files will not be
36772 owned by the Exim user.
36773 .next
36774 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36775 on a newly created mailbox when unprivileged. This also implies that new
36776 mailboxes need to be created manually.
36777 .endlist olist
36778 .endlist ilist
36779
36780
36781 These restrictions severely restrict what can be done in local deliveries.
36782 However, there are no restrictions on remote deliveries. If you are running a
36783 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36784 gives more security at essentially no cost.
36785
36786 If you are using the &%mua_wrapper%& facility (see chapter
36787 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36788
36789
36790
36791
36792 .section "Delivering to local files" "SECID271"
36793 Full details of the checks applied by &(appendfile)& before it writes to a file
36794 are given in chapter &<<CHAPappendfile>>&.
36795
36796
36797
36798 .section "Running local commands" "SECTsecconslocalcmds"
36799 .cindex "security" "local commands"
36800 .cindex "security" "command injection attacks"
36801 There are a number of ways in which an administrator can configure Exim to run
36802 commands based upon received, untrustworthy, data. Further, in some
36803 configurations a user who can control a &_.forward_& file can also arrange to
36804 run commands. Configuration to check includes, but is not limited to:
36805
36806 .ilist
36807 Use of &%use_shell%& in the pipe transport: various forms of shell command
36808 injection may be possible with this option present. It is dangerous and should
36809 be used only with considerable caution. Consider constraints which whitelist
36810 allowed characters in a variable which is to be used in a pipe transport that
36811 has &%use_shell%& enabled.
36812 .next
36813 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36814 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36815 &_.forward_& files in a redirect router. If Exim is running on a central mail
36816 hub to which ordinary users do not have shell access, but home directories are
36817 NFS mounted (for instance) then administrators should review the list of these
36818 forbid options available, and should bear in mind that the options that may
36819 need forbidding can change as new features are added between releases.
36820 .next
36821 The &%${run...}%& expansion item does not use a shell by default, but
36822 administrators can configure use of &_/bin/sh_& as part of the command.
36823 Such invocations should be viewed with prejudicial suspicion.
36824 .next
36825 Administrators who use embedded Perl are advised to explore how Perl's
36826 taint checking might apply to their usage.
36827 .next
36828 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36829 administrators are well advised to view its use with suspicion, in case (for
36830 instance) it allows a local-part to contain embedded Exim directives.
36831 .next
36832 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36833 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36834 each can reference arbitrary lists and files, rather than just being a list
36835 of opaque strings.
36836 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36837 real-world security vulnerabilities caused by its use with untrustworthy data
36838 injected in, for SQL injection attacks.
36839 Consider the use of the &%inlisti%& expansion condition instead.
36840 .endlist
36841
36842
36843
36844
36845 .section "Trust in configuration data" "SECTsecconfdata"
36846 .cindex "security" "data sources"
36847 .cindex "security" "regular expressions"
36848 .cindex "regular expressions" "security"
36849 .cindex "PCRE" "security"
36850 If configuration data for Exim can come from untrustworthy sources, there
36851 are some issues to be aware of:
36852
36853 .ilist
36854 Use of &%${expand...}%& may provide a path for shell injection attacks.
36855 .next
36856 Letting untrusted data provide a regular expression is unwise.
36857 .next
36858 Using &%${match...}%& to apply a fixed regular expression against untrusted
36859 data may result in pathological behaviour within PCRE.  Be aware of what
36860 "backtracking" means and consider options for being more strict with a regular
36861 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36862 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36863 possessive quantifiers or just not using regular expressions against untrusted
36864 data.
36865 .next
36866 It can be important to correctly use &%${quote:...}%&,
36867 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36868 items to ensure that data is correctly constructed.
36869 .next
36870 Some lookups might return multiple results, even though normal usage is only
36871 expected to yield one result.
36872 .endlist
36873
36874
36875
36876
36877 .section "IPv4 source routing" "SECID272"
36878 .cindex "source routing" "in IP packets"
36879 .cindex "IP source routing"
36880 Many operating systems suppress IP source-routed packets in the kernel, but
36881 some cannot be made to do this, so Exim does its own check. It logs incoming
36882 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36883 IPv6. No special checking is currently done.
36884
36885
36886
36887 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36888 Support for these SMTP commands is disabled by default. If required, they can
36889 be enabled by defining suitable ACLs.
36890
36891
36892
36893
36894 .section "Privileged users" "SECID274"
36895 .cindex "trusted users"
36896 .cindex "admin user"
36897 .cindex "privileged user"
36898 .cindex "user" "trusted"
36899 .cindex "user" "admin"
36900 Exim recognizes two sets of users with special privileges. Trusted users are
36901 able to submit new messages to Exim locally, but supply their own sender
36902 addresses and information about a sending host. For other users submitting
36903 local messages, Exim sets up the sender address from the uid, and doesn't
36904 permit a remote host to be specified.
36905
36906 .oindex "&%-f%&"
36907 However, an untrusted user is permitted to use the &%-f%& command line option
36908 in the special form &%-f <>%& to indicate that a delivery failure for the
36909 message should not cause an error report. This affects the message's envelope,
36910 but it does not affect the &'Sender:'& header. Untrusted users may also be
36911 permitted to use specific forms of address with the &%-f%& option by setting
36912 the &%untrusted_set_sender%& option.
36913
36914 Trusted users are used to run processes that receive mail messages from some
36915 other mail domain and pass them on to Exim for delivery either locally, or over
36916 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36917 as any user listed in the &%trusted_users%& configuration option, or under any
36918 group listed in the &%trusted_groups%& option.
36919
36920 Admin users are permitted to do things to the messages on Exim's queue. They
36921 can freeze or thaw messages, cause them to be returned to their senders, remove
36922 them entirely, or modify them in various ways. In addition, admin users can run
36923 the Exim monitor and see all the information it is capable of providing, which
36924 includes the contents of files on the spool.
36925
36926 .oindex "&%-M%&"
36927 .oindex "&%-q%&"
36928 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36929 delivery of messages on its queue is restricted to admin users. This
36930 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36931 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36932 queue is also restricted to admin users. This restriction can be relaxed by
36933 setting &%no_queue_list_requires_admin%&.
36934
36935 Exim recognizes an admin user if the calling process is running as root or as
36936 the Exim user or if any of the groups associated with the calling process is
36937 the Exim group. It is not necessary actually to be running under the Exim
36938 group. However, if admin users who are not root or the Exim user are to access
36939 the contents of files on the spool via the Exim monitor (which runs
36940 unprivileged), Exim must be built to allow group read access to its spool
36941 files.
36942
36943
36944
36945 .section "Spool files" "SECID275"
36946 .cindex "spool directory" "files"
36947 Exim's spool directory and everything it contains is owned by the Exim user and
36948 set to the Exim group. The mode for spool files is defined in the
36949 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36950 any user who is a member of the Exim group can access these files.
36951
36952
36953
36954 .section "Use of argv[0]" "SECID276"
36955 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36956 of specific strings, Exim assumes certain options. For example, calling Exim
36957 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36958 to calling it with the option &%-bS%&. There are no security implications in
36959 this.
36960
36961
36962
36963 .section "Use of %f formatting" "SECID277"
36964 The only use made of &"%f"& by Exim is in formatting load average values. These
36965 are actually stored in integer variables as 1000 times the load average.
36966 Consequently, their range is limited and so therefore is the length of the
36967 converted output.
36968
36969
36970
36971 .section "Embedded Exim path" "SECID278"
36972 Exim uses its own path name, which is embedded in the code, only when it needs
36973 to re-exec in order to regain root privilege. Therefore, it is not root when it
36974 does so. If some bug allowed the path to get overwritten, it would lead to an
36975 arbitrary program's being run as exim, not as root.
36976
36977
36978
36979 .section "Dynamic module directory" "SECTdynmoddir"
36980 Any dynamically loadable modules must be installed into the directory
36981 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36982 loading it.
36983
36984
36985 .section "Use of sprintf()" "SECID279"
36986 .cindex "&[sprintf()]&"
36987 A large number of occurrences of &"sprintf"& in the code are actually calls to
36988 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36989 The intermediate formatting is done into a large fixed buffer by a function
36990 that runs through the format string itself, and checks the length of each
36991 conversion before performing it, thus preventing buffer overruns.
36992
36993 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36994 the output buffer is known to be sufficiently long to contain the converted
36995 string.
36996
36997
36998
36999 .section "Use of debug_printf() and log_write()" "SECID280"
37000 Arbitrary strings are passed to both these functions, but they do their
37001 formatting by calling the function &'string_vformat()'&, which runs through
37002 the format string itself, and checks the length of each conversion.
37003
37004
37005
37006 .section "Use of strcat() and strcpy()" "SECID281"
37007 These are used only in cases where the output buffer is known to be large
37008 enough to hold the result.
37009 .ecindex IIDsecurcon
37010
37011
37012
37013
37014 . ////////////////////////////////////////////////////////////////////////////
37015 . ////////////////////////////////////////////////////////////////////////////
37016
37017 .chapter "Format of spool files" "CHAPspool"
37018 .scindex IIDforspo1 "format" "spool files"
37019 .scindex IIDforspo2 "spool directory" "format of files"
37020 .scindex IIDforspo3 "spool files" "format of"
37021 .cindex "spool files" "editing"
37022 A message on Exim's queue consists of two files, whose names are the message id
37023 followed by -D and -H, respectively. The data portion of the message is kept in
37024 the -D file on its own. The message's envelope, status, and headers are all
37025 kept in the -H file, whose format is described in this chapter. Each of these
37026 two files contains the final component of its own name as its first line. This
37027 is insurance against disk crashes where the directory is lost but the files
37028 themselves are recoverable.
37029
37030 Some people are tempted into editing -D files in order to modify messages. You
37031 need to be extremely careful if you do this; it is not recommended and you are
37032 on your own if you do it. Here are some of the pitfalls:
37033
37034 .ilist
37035 You must ensure that Exim does not try to deliver the message while you are
37036 fiddling with it. The safest way is to take out a write lock on the -D file,
37037 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37038 place, the lock will be retained. If you write a new file and rename it, the
37039 lock will be lost at the instant of rename.
37040 .next
37041 .vindex "&$body_linecount$&"
37042 If you change the number of lines in the file, the value of
37043 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37044 present, this value is not used by Exim, but there is no guarantee that this
37045 will always be the case.
37046 .next
37047 If the message is in MIME format, you must take care not to break it.
37048 .next
37049 If the message is cryptographically signed, any change will invalidate the
37050 signature.
37051 .endlist
37052 All in all, modifying -D files is fraught with danger.
37053
37054 Files whose names end with -J may also be seen in the &_input_& directory (or
37055 its subdirectories when &%split_spool_directory%& is set). These are journal
37056 files, used to record addresses to which the message has been delivered during
37057 the course of a delivery attempt. If there are still undelivered recipients at
37058 the end, the -H file is updated, and the -J file is deleted. If, however, there
37059 is some kind of crash (for example, a power outage) before this happens, the -J
37060 file remains in existence. When Exim next processes the message, it notices the
37061 -J file and uses it to update the -H file before starting the next delivery
37062 attempt.
37063
37064 .section "Format of the -H file" "SECID282"
37065 .cindex "uid (user id)" "in spool file"
37066 .cindex "gid (group id)" "in spool file"
37067 The second line of the -H file contains the login name for the uid of the
37068 process that called Exim to read the message, followed by the numerical uid and
37069 gid. For a locally generated message, this is normally the user who sent the
37070 message. For a message received over TCP/IP via the daemon, it is
37071 normally the Exim user.
37072
37073 The third line of the file contains the address of the message's sender as
37074 transmitted in the envelope, contained in angle brackets. The sender address is
37075 empty for bounce messages. For incoming SMTP mail, the sender address is given
37076 in the MAIL command. For locally generated mail, the sender address is
37077 created by Exim from the login name of the current user and the configured
37078 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37079 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37080 &"<>"& or an address that matches &%untrusted_set_senders%&.
37081
37082 The fourth line contains two numbers. The first is the time that the message
37083 was received, in the conventional Unix form &-- the number of seconds since the
37084 start of the epoch. The second number is a count of the number of messages
37085 warning of delayed delivery that have been sent to the sender.
37086
37087 There follow a number of lines starting with a hyphen. These can appear in any
37088 order, and are omitted when not relevant:
37089
37090 .vlist
37091 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37092 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37093 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37094 recognized, to provide backward compatibility. In the old format, a line of
37095 this form is present for every ACL variable that is not empty. The number
37096 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37097 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37098 the data string for the variable. The string itself starts at the beginning of
37099 the next line, and is followed by a newline character. It may contain internal
37100 newlines.
37101
37102 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37103 A line of this form is present for every ACL connection variable that is
37104 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37105 The length is the length of the data string for the variable. The string itself
37106 starts at the beginning of the next line, and is followed by a newline
37107 character. It may contain internal newlines.
37108
37109 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37110 A line of this form is present for every ACL message variable that is defined.
37111 Note that there is a space between &%-aclm%& and the rest of the name. The
37112 length is the length of the data string for the variable. The string itself
37113 starts at the beginning of the next line, and is followed by a newline
37114 character. It may contain internal newlines.
37115
37116 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37117 This is present if, when the message was received over SMTP, the value of
37118 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37119
37120 .vitem &%-allow_unqualified_recipient%&
37121 This is present if unqualified recipient addresses are permitted in header
37122 lines (to stop such addresses from being qualified if rewriting occurs at
37123 transport time). Local messages that were input using &%-bnq%& and remote
37124 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37125
37126 .vitem &%-allow_unqualified_sender%&
37127 This is present if unqualified sender addresses are permitted in header lines
37128 (to stop such addresses from being qualified if rewriting occurs at transport
37129 time). Local messages that were input using &%-bnq%& and remote messages from
37130 hosts that match &%sender_unqualified_hosts%& set this flag.
37131
37132 .vitem "&%-auth_id%&&~<&'text'&>"
37133 The id information for a message received on an authenticated SMTP connection
37134 &-- the value of the &$authenticated_id$& variable.
37135
37136 .vitem "&%-auth_sender%&&~<&'address'&>"
37137 The address of an authenticated sender &-- the value of the
37138 &$authenticated_sender$& variable.
37139
37140 .vitem "&%-body_linecount%&&~<&'number'&>"
37141 This records the number of lines in the body of the message, and is always
37142 present.
37143
37144 .vitem "&%-body_zerocount%&&~<&'number'&>"
37145 This records the number of binary zero bytes in the body of the message, and is
37146 present if the number is greater than zero.
37147
37148 .vitem &%-deliver_firsttime%&
37149 This is written when a new message is first added to the spool. When the spool
37150 file is updated after a deferral, it is omitted.
37151
37152 .vitem "&%-frozen%&&~<&'time'&>"
37153 .cindex "frozen messages" "spool data"
37154 The message is frozen, and the freezing happened at <&'time'&>.
37155
37156 .vitem "&%-helo_name%&&~<&'text'&>"
37157 This records the host name as specified by a remote host in a HELO or EHLO
37158 command.
37159
37160 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37161 This records the IP address of the host from which the message was received and
37162 the remote port number that was used. It is omitted for locally generated
37163 messages.
37164
37165 .vitem "&%-host_auth%&&~<&'text'&>"
37166 If the message was received on an authenticated SMTP connection, this records
37167 the name of the authenticator &-- the value of the
37168 &$sender_host_authenticated$& variable.
37169
37170 .vitem &%-host_lookup_failed%&
37171 This is present if an attempt to look up the sending host's name from its IP
37172 address failed. It corresponds to the &$host_lookup_failed$& variable.
37173
37174 .vitem "&%-host_name%&&~<&'text'&>"
37175 .cindex "reverse DNS lookup"
37176 .cindex "DNS" "reverse lookup"
37177 This records the name of the remote host from which the message was received,
37178 if the host name was looked up from the IP address when the message was being
37179 received. It is not present if no reverse lookup was done.
37180
37181 .vitem "&%-ident%&&~<&'text'&>"
37182 For locally submitted messages, this records the login of the originating user,
37183 unless it was a trusted user and the &%-oMt%& option was used to specify an
37184 ident value. For messages received over TCP/IP, this records the ident string
37185 supplied by the remote host, if any.
37186
37187 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37188 This records the IP address of the local interface and the port number through
37189 which a message was received from a remote host. It is omitted for locally
37190 generated messages.
37191
37192 .vitem &%-local%&
37193 The message is from a local sender.
37194
37195 .vitem &%-localerror%&
37196 The message is a locally-generated bounce message.
37197
37198 .vitem "&%-local_scan%&&~<&'string'&>"
37199 This records the data string that was returned by the &[local_scan()]& function
37200 when the message was received &-- the value of the &$local_scan_data$&
37201 variable. It is omitted if no data was returned.
37202
37203 .vitem &%-manual_thaw%&
37204 The message was frozen but has been thawed manually, that is, by an explicit
37205 Exim command rather than via the auto-thaw process.
37206
37207 .vitem &%-N%&
37208 A testing delivery process was started using the &%-N%& option to suppress any
37209 actual deliveries, but delivery was deferred. At any further delivery attempts,
37210 &%-N%& is assumed.
37211
37212 .vitem &%-received_protocol%&
37213 This records the value of the &$received_protocol$& variable, which contains
37214 the name of the protocol by which the message was received.
37215
37216 .vitem &%-sender_set_untrusted%&
37217 The envelope sender of this message was set by an untrusted local caller (used
37218 to ensure that the caller is displayed in queue listings).
37219
37220 .vitem "&%-spam_score_int%&&~<&'number'&>"
37221 If a message was scanned by SpamAssassin, this is present. It records the value
37222 of &$spam_score_int$&.
37223
37224 .vitem &%-tls_certificate_verified%&
37225 A TLS certificate was received from the client that sent this message, and the
37226 certificate was verified by the server.
37227
37228 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37229 When the message was received over an encrypted connection, this records the
37230 name of the cipher suite that was used.
37231
37232 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37233 When the message was received over an encrypted connection, and a certificate
37234 was received from the client, this records the Distinguished Name from that
37235 certificate.
37236 .endlist
37237
37238 Following the options there is a list of those addresses to which the message
37239 is not to be delivered. This set of addresses is initialized from the command
37240 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37241 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37242 the address is added to this set. The addresses are kept internally as a
37243 balanced binary tree, and it is a representation of that tree which is written
37244 to the spool file. If an address is expanded via an alias or forward file, the
37245 original address is added to the tree when deliveries to all its child
37246 addresses are complete.
37247
37248 If the tree is empty, there is a single line in the spool file containing just
37249 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37250 Y or N, followed by an address. The address is the value for the node of the
37251 tree, and the letters indicate whether the node has a left branch and/or a
37252 right branch attached to it, respectively. If branches exist, they immediately
37253 follow. Here is an example of a three-node tree:
37254 .code
37255 YY darcy@austen.fict.example
37256 NN alice@wonderland.fict.example
37257 NN editor@thesaurus.ref.example
37258 .endd
37259 After the non-recipients tree, there is a list of the message's recipients.
37260 This is a simple list, preceded by a count. It includes all the original
37261 recipients of the message, including those to whom the message has already been
37262 delivered. In the simplest case, the list contains one address per line. For
37263 example:
37264 .code
37265 4
37266 editor@thesaurus.ref.example
37267 darcy@austen.fict.example
37268 rdo@foundation
37269 alice@wonderland.fict.example
37270 .endd
37271 However, when a child address has been added to the top-level addresses as a
37272 result of the use of the &%one_time%& option on a &(redirect)& router, each
37273 line is of the following form:
37274 .display
37275 <&'top-level address'&> <&'errors_to address'&> &&&
37276   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37277 .endd
37278 The 01 flag bit indicates the presence of the three other fields that follow
37279 the top-level address. Other bits may be used in future to support additional
37280 fields. The <&'parent number'&> is the offset in the recipients list of the
37281 original parent of the &"one time"& address. The first two fields are the
37282 envelope sender that is associated with this address and its length. If the
37283 length is zero, there is no special envelope sender (there are then two space
37284 characters in the line). A non-empty field can arise from a &(redirect)& router
37285 that has an &%errors_to%& setting.
37286
37287
37288 A blank line separates the envelope and status information from the headers
37289 which follow. A header may occupy several lines of the file, and to save effort
37290 when reading it in, each header is preceded by a number and an identifying
37291 character. The number is the number of characters in the header, including any
37292 embedded newlines and the terminating newline. The character is one of the
37293 following:
37294
37295 .table2 50pt
37296 .row <&'blank'&>         "header in which Exim has no special interest"
37297 .row &`B`&               "&'Bcc:'& header"
37298 .row &`C`&               "&'Cc:'& header"
37299 .row &`F`&               "&'From:'& header"
37300 .row &`I`&               "&'Message-id:'& header"
37301 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37302 .row &`R`&               "&'Reply-To:'& header"
37303 .row &`S`&               "&'Sender:'& header"
37304 .row &`T`&               "&'To:'& header"
37305 .row &`*`&               "replaced or deleted header"
37306 .endtable
37307
37308 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37309 purposes. They are not transmitted when the message is delivered. Here is a
37310 typical set of headers:
37311 .code
37312 111P Received: by hobbit.fict.example with local (Exim 4.00)
37313 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37314 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37315 038* X-rewrote-sender: bb@hobbit.fict.example
37316 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37317 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37318 099* To: alice@wonderland.fict.example, rdo@foundation,
37319 darcy@austen.fict.example, editor@thesaurus.ref.example
37320 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37321 darcy@austen.fict.example, editor@thesaurus.ref.example
37322 038  Date: Fri, 11 May 2001 10:28:59 +0100
37323 .endd
37324 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37325 &'To:'& header have been rewritten, the last one because routing expanded the
37326 unqualified domain &'foundation'&.
37327 .ecindex IIDforspo1
37328 .ecindex IIDforspo2
37329 .ecindex IIDforspo3
37330
37331 . ////////////////////////////////////////////////////////////////////////////
37332 . ////////////////////////////////////////////////////////////////////////////
37333
37334 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37335          "DKIM Support"
37336 .cindex "DKIM"
37337
37338 DKIM is a mechanism by which messages sent by some entity can be provably
37339 linked to a domain which that entity controls.  It permits reputation to
37340 be tracked on a per-domain basis, rather than merely upon source IP address.
37341 DKIM is documented in RFC 4871.
37342
37343 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37344 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37345
37346 Exim's DKIM implementation allows to
37347 .olist
37348 Sign outgoing messages: This function is implemented in the SMTP transport.
37349 It can co-exist with all other Exim features
37350 (including transport filters)
37351 except cutthrough delivery.
37352 .next
37353 Verify signatures in incoming messages: This is implemented by an additional
37354 ACL (acl_smtp_dkim), which can be called several times per message, with
37355 different signature contexts.
37356 .endlist
37357
37358 In typical Exim style, the verification implementation does not include any
37359 default "policy". Instead it enables you to build your own policy using
37360 Exim's standard controls.
37361
37362 Please note that verification of DKIM signatures in incoming mail is turned
37363 on by default for logging purposes. For each signature in incoming email,
37364 exim will log a line displaying the most important signature details, and the
37365 signature status. Here is an example (with line-breaks added for clarity):
37366 .code
37367 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37368     d=facebookmail.com s=q1-2009b
37369     c=relaxed/relaxed a=rsa-sha1
37370     i=@facebookmail.com t=1252484542 [verification succeeded]
37371 .endd
37372 You might want to turn off DKIM verification processing entirely for internal
37373 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37374 control modifier. This should typically be done in the RCPT ACL, at points
37375 where you accept mail from relay sources (internal hosts or authenticated
37376 senders).
37377
37378
37379 .section "Signing outgoing messages" "SECID513"
37380 .cindex "DKIM" "signing"
37381
37382 Signing is implemented by setting private options on the SMTP transport.
37383 These options take (expandable) strings as arguments.
37384
37385 .option dkim_domain smtp string&!! unset
37386 MANDATORY:
37387 The domain you want to sign with. The result of this expanded
37388 option is put into the &%$dkim_domain%& expansion variable.
37389
37390 .option dkim_selector smtp string&!! unset
37391 MANDATORY:
37392 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37393 variable to look up a matching selector. The result is put in the expansion
37394 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37395 option along with &%$dkim_domain%&.
37396
37397 .option dkim_private_key smtp string&!! unset
37398 MANDATORY:
37399 This sets the private key to use. You can use the &%$dkim_domain%& and
37400 &%$dkim_selector%& expansion variables to determine the private key to use.
37401 The result can either
37402 .ilist
37403 be a valid RSA private key in ASCII armor, including line breaks.
37404 .next
37405 start with a slash, in which case it is treated as a file that contains
37406 the private key.
37407 .next
37408 be "0", "false" or the empty string, in which case the message will not
37409 be signed. This case will not result in an error, even if &%dkim_strict%&
37410 is set.
37411 .endlist
37412
37413 .option dkim_canon smtp string&!! unset
37414 OPTIONAL:
37415 This option sets the canonicalization method used when signing a message.
37416 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37417 The option defaults to "relaxed" when unset. Note: the current implementation
37418 only supports using the same canonicalization method for both headers and body.
37419
37420 .option dkim_strict smtp string&!! unset
37421 OPTIONAL:
37422 This  option  defines  how  Exim  behaves  when  signing a message that
37423 should be signed fails for some reason.  When the expansion evaluates to
37424 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37425 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37426 variables here.
37427
37428 .option dkim_sign_headers smtp string&!! unset
37429 OPTIONAL:
37430 When set, this option must expand to (or be specified as) a colon-separated
37431 list of header names. Headers with these names will be included in the message
37432 signature. When unspecified, the header names recommended in RFC4871 will be
37433 used.
37434
37435
37436 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37437 .cindex "DKIM" "verification"
37438
37439 Verification of DKIM signatures in incoming email is implemented via the
37440 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37441 syntactically(!) correct signature in the incoming message.
37442 A missing ACL definition defaults to accept.
37443 If any ACL call does not acccept, the message is not accepted.
37444 If a cutthrough delivery was in progress for the message it is
37445 summarily dropped (having wasted the transmission effort).
37446
37447 To evaluate the signature in the ACL a large number of expansion variables
37448 containing the signature status and its details are set up during the
37449 runtime of the ACL.
37450
37451 Calling the ACL only for existing signatures is not sufficient to build
37452 more advanced policies. For that reason, the global option
37453 &%dkim_verify_signers%&, and a global expansion variable
37454 &%$dkim_signers%& exist.
37455
37456 The global option &%dkim_verify_signers%& can be set to a colon-separated
37457 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37458 called. It is expanded when the message has been received. At this point,
37459 the expansion variable &%$dkim_signers%& already contains a colon-separated
37460 list of signer domains and identities for the message. When
37461 &%dkim_verify_signers%& is not specified in the main configuration,
37462 it defaults as:
37463 .code
37464 dkim_verify_signers = $dkim_signers
37465 .endd
37466 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37467 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37468 call the ACL for known domains or identities. This would be achieved as follows:
37469 .code
37470 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37471 .endd
37472 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37473 and "ebay.com", plus all domains and identities that have signatures in the message.
37474 You can also be more creative in constructing your policy. For example:
37475 .code
37476 dkim_verify_signers = $sender_address_domain:$dkim_signers
37477 .endd
37478
37479 If a domain or identity is listed several times in the (expanded) value of
37480 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37481
37482
37483 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37484 available (from most to least important):
37485
37486
37487 .vlist
37488 .vitem &%$dkim_cur_signer%&
37489 The signer that is being evaluated in this ACL run. This can be a domain or
37490 an identity. This is one of the list items from the expanded main option
37491 &%dkim_verify_signers%& (see above).
37492 .vitem &%$dkim_verify_status%&
37493 A string describing the general status of the signature. One of
37494 .ilist
37495 &%none%&: There is no signature in the message for the current domain or
37496 identity (as reflected by &%$dkim_cur_signer%&).
37497 .next
37498 &%invalid%&: The signature could not be verified due to a processing error.
37499 More detail is available in &%$dkim_verify_reason%&.
37500 .next
37501 &%fail%&: Verification of the signature failed.  More detail is
37502 available in &%$dkim_verify_reason%&.
37503 .next
37504 &%pass%&: The signature passed verification. It is valid.
37505 .endlist
37506 .vitem &%$dkim_verify_reason%&
37507 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37508 "fail" or "invalid". One of
37509 .ilist
37510 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37511 key for the domain could not be retrieved. This may be a temporary problem.
37512 .next
37513 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37514 record for the domain is syntactically invalid.
37515 .next
37516 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37517 body hash does not match the one specified in the signature header. This
37518 means that the message body was modified in transit.
37519 .next
37520 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37521 could not be verified. This may mean that headers were modified,
37522 re-written or otherwise changed in a way which is incompatible with
37523 DKIM verification. It may of course also mean that the signature is forged.
37524 .endlist
37525 .vitem &%$dkim_domain%&
37526 The signing domain. IMPORTANT: This variable is only populated if there is
37527 an actual signature in the message for the current domain or identity (as
37528 reflected by &%$dkim_cur_signer%&).
37529 .vitem &%$dkim_identity%&
37530 The signing identity, if present. IMPORTANT: This variable is only populated
37531 if there is an actual signature in the message for the current domain or
37532 identity (as reflected by &%$dkim_cur_signer%&).
37533 .vitem &%$dkim_selector%&
37534 The key record selector string.
37535 .vitem &%$dkim_algo%&
37536 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37537 .vitem &%$dkim_canon_body%&
37538 The body canonicalization method. One of 'relaxed' or 'simple'.
37539 .vitem &%dkim_canon_headers%&
37540 The header canonicalization method. One of 'relaxed' or 'simple'.
37541 .vitem &%$dkim_copiedheaders%&
37542 A transcript of headers and their values which are included in the signature
37543 (copied from the 'z=' tag of the signature).
37544 .vitem &%$dkim_bodylength%&
37545 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37546 limit was set by the signer, "9999999999999" is returned. This makes sure
37547 that this variable always expands to an integer value.
37548 .vitem &%$dkim_created%&
37549 UNIX timestamp reflecting the date and time when the signature was created.
37550 When this was not specified by the signer, "0" is returned.
37551 .vitem &%$dkim_expires%&
37552 UNIX timestamp reflecting the date and time when the signer wants the
37553 signature to be treated as "expired". When this was not specified by the
37554 signer, "9999999999999" is returned. This makes it possible to do useful
37555 integer size comparisons against this value.
37556 .vitem &%$dkim_headernames%&
37557 A colon-separated list of names of headers included in the signature.
37558 .vitem &%$dkim_key_testing%&
37559 "1" if the key record has the "testing" flag set, "0" if not.
37560 .vitem &%$dkim_key_nosubdomains%&
37561 "1" if the key record forbids subdomaining, "0" otherwise.
37562 .vitem &%$dkim_key_srvtype%&
37563 Service type (tag s=) from the key record. Defaults to "*" if not specified
37564 in the key record.
37565 .vitem &%$dkim_key_granularity%&
37566 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37567 in the key record.
37568 .vitem &%$dkim_key_notes%&
37569 Notes from the key record (tag n=).
37570 .endlist
37571
37572 In addition, two ACL conditions are provided:
37573
37574 .vlist
37575 .vitem &%dkim_signers%&
37576 ACL condition that checks a colon-separated list of domains or identities
37577 for a match against the domain or identity that the ACL is currently verifying
37578 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37579 verb to a group of domains or identities. For example:
37580
37581 .code
37582 # Warn when Mail purportedly from GMail has no signature at all
37583 warn log_message = GMail sender without DKIM signature
37584      sender_domains = gmail.com
37585      dkim_signers = gmail.com
37586      dkim_status = none
37587 .endd
37588
37589 .vitem &%dkim_status%&
37590 ACL condition that checks a colon-separated list of possible DKIM verification
37591 results against the actual result of verification. This is typically used
37592 to restrict an ACL verb to a list of verification outcomes, for example:
37593
37594 .code
37595 deny message = Mail from Paypal with invalid/missing signature
37596      sender_domains = paypal.com:paypal.de
37597      dkim_signers = paypal.com:paypal.de
37598      dkim_status = none:invalid:fail
37599 .endd
37600
37601 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37602 see the documentation of the &%$dkim_verify_status%& expansion variable above
37603 for more information of what they mean.
37604 .endlist
37605
37606 . ////////////////////////////////////////////////////////////////////////////
37607 . ////////////////////////////////////////////////////////////////////////////
37608
37609 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37610          "Adding drivers or lookups"
37611 .cindex "adding drivers"
37612 .cindex "new drivers, adding"
37613 .cindex "drivers" "adding new"
37614 The following actions have to be taken in order to add a new router, transport,
37615 authenticator, or lookup type to Exim:
37616
37617 .olist
37618 Choose a name for the driver or lookup type that does not conflict with any
37619 existing name; I will use &"newdriver"& in what follows.
37620 .next
37621 Add to &_src/EDITME_& the line:
37622 .display
37623 <&'type'&>&`_NEWDRIVER=yes`&
37624 .endd
37625 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37626 code is not to be included in the binary by default, comment this line out. You
37627 should also add any relevant comments about the driver or lookup type.
37628 .next
37629 Add to &_src/config.h.defaults_& the line:
37630 .code
37631 #define <type>_NEWDRIVER
37632 .endd
37633 .next
37634 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37635 and create a table entry as is done for all the other drivers and lookup types.
37636 .next
37637 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37638 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37639 Add your &`NEWDRIVER`& to that list.
37640 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37641 simple form that most lookups have.
37642 .next
37643 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37644 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37645 driver or lookup type and add it to the definition of OBJ.
37646 .next
37647 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37648 &_src_&.
37649 .next
37650 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37651 as for other drivers and lookups.
37652 .endlist
37653
37654 Then all you need to do is write the code! A good way to start is to make a
37655 proforma by copying an existing module of the same type, globally changing all
37656 occurrences of the name, and cutting out most of the code. Note that any
37657 options you create must be listed in alphabetical order, because the tables are
37658 searched using a binary chop procedure.
37659
37660 There is a &_README_& file in each of the sub-directories of &_src_& describing
37661 the interface that is expected.
37662
37663
37664
37665
37666 . ////////////////////////////////////////////////////////////////////////////
37667 . ////////////////////////////////////////////////////////////////////////////
37668
37669 . /////////////////////////////////////////////////////////////////////////////
37670 . These lines are processing instructions for the Simple DocBook Processor that
37671 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37672 . PDFs than using xmlto and fop. They will be ignored by all other XML
37673 . processors.
37674 . /////////////////////////////////////////////////////////////////////////////
37675
37676 .literal xml
37677 <?sdop
37678   format="newpage"
37679   foot_right_recto="&chaptertitle;"
37680   foot_right_verso="&chaptertitle;"
37681 ?>
37682 .literal off
37683
37684 .makeindex "Options index"   "option"
37685 .makeindex "Variables index" "variable"
37686 .makeindex "Concept index"   "concept"
37687
37688
37689 . /////////////////////////////////////////////////////////////////////////////
37690 . /////////////////////////////////////////////////////////////////////////////